Yahoo! JAPAN Ads API v6 released

Document Number: APIE-FY21-2235


Dear customers,

Thank you for using Yahoo! JAPAN Ads.

Yahoo! JAPAN Ads API new version has been released, as previously
announced in "Yahoo! JAPAN Ads API v6 release (Document Number :
APIE-FY21-2208)."
Learn more details in the following section.


1. Product:
 Yahoo! JAPAN Ads Search Ads API
 Yahoo! JAPAN Ads Display Ads API

2. Version released:
 v6

3. Effective date:
 September 13, 2021 (Mon)

4. Changes on Search Ads API:

 ■The new Auto Bidding Type
  The name and type have changed on the auto bidding (standard bidding)
  that can be set for campaign type.
  We have abolished the setting of upper and lower bid prices.
  *This function will become available on September 27, 2021.

  See also the following document.
  [Search Ads] New auto bidding type 

  *Note
   On v6 and later versions, you cannot specify ARGET_CPA and
   TARGET_ROAS with "ADD" and "SET". Also, on v5 and earlier versions,
   you can specify TARGET_CPA and TARGET_ROAS with "ADD" and "SET",
   but they will be converted to a new format of automatic bidding.
   The values will be in the new format and shown on the Campaign
   Management Tool and reports.
   See the release note for more detail.

 ■Output items on reports
  Some output items on reports changed. Check the change detail on the
  following document.  
  ReportDefinitionService v6 Migration Guide

  Also note that reportIncludeZeroImpressions became unavailable on v6
  and later.
  Because items without impressions are also output together, the
  output data will become large and an error may occur.
  
  To output only the items with impressions on v6 or later version to
  the report, set the items such as imps to 1 or more in the filtering
  condition.
  
  In addition, the notation of "Purpose of conversion measurement"
  (ConversionTrackerServiceCategory) at the time of getting report
  changed.
  See also the following document.
  [Search Ads] changes on performance report 

 ■Item names (English only)
  Following item names changed on the Campaign Management Tool and Campaign Editor.
  -Landing Page URL→Final URL
  -Smartphone Landing Page URL→Smartphone final URL

  The CSV files available on CampaignExportService and AuditLogService in the API also changed.
  *Effected version: All versions (v6,v5,v4) changed.
  [CampaignExportService]
  -Landing Page URL→Final URL
  -Mobile Landing Page URL→Smartphone final URL
  [AuditLogService]
  -Landing Page URL→Final URL
  -Smartphone Landing Page URL→Smartphone final URL

 ■Operation history of automated rules
  The operation history generated by using the automated rules (only
  available on the Campaign Management Tool) became available on
  operation history of Search Ads API.  
  It is available when specifying "ALL" for "sourceType" of
  AuditLogService. All available API versions including v6 supported
  this feature.

 ■Maintenance release
  We have added Enum to the following services in order to add
  functions in the future. We will make another announcement once the
  detail has been decided.
  ・"reportType" of ReportDefinitionService/add
  ・"entityType" of AuditLogService/addJob
  ・"entityType" of CampaignExportService/addJob

5. Changes on Display Ads API:
 ■Select conversions used for ad delivery optimization by campaign
  You can select conversion settings or conversion groups to use for
  optimization by each campaign.
  *This feature is already available on the Campaign Management Tool.
  See the following release note for more detail.
  [Display Ads] Conversions for Autobidding changes 

 ■Final URL (former: Landing Page URL) and new setting items for ads
  This change includes new setting items such as the new "final URL"
  and added tracking parameters.
  Specifying SKAdNetwork measurement vendor on the existing vendorName
  field will become available on creating campaigns for "app promotion."
  *This function will become available on October 20, 2021.
  See the following release note for more detail.
  [Display Ads] New setting items for ads and some enhancements  

 ■Linked data type of custom list
  The data type that can link on custom list became available.
  *See the following announcement to learn about feature update.
  Display Ads (Auction) Custom list linked data type added  

 ■Analytics of content keyword targeting
  Getting analytic information of content keyword targeting became
  available.

 ■Avg. CPM and Average vCPM
  Getting Avg. CPM and Average vCPM became available on analytics.

 ■Auto bidding type "Maximize conversions" and "Maximize clicks"
  *This function is being tested only for some accounts. Only target
  accounts can use this feature.
  You can set up a bid strategy that automatically adjusts your bid to
  maximize conversions or clicks within your budget.

 ■Operation history of automated rules
  The operation history generated by using the automated rules (only
  available on the Campaign Management Tool) will become available on
  operation history of Display Ads API.
  It is available when specifying "ALL" for "updateSource" on
  AuditLogService.
  *This function has been provided for some time. All available API
  versions including v6 support this feature.

 ■End of Display Ads (YDN) support
  Along with EOL, we made changes on Display Ads (YDN).

 ■Maintenance release
  Supported narrowing down campaigns and ad groups based on budget
  amount and bid price.
  - Campaign : narrowing down by budget amount
  - Ad group : narrowing down by bid amount

6. Library for Java users:
 We have released the library including the request and response entity
 of Yahoo! JAPAN Ads API for Java users in Maven repository.
 https://mvnrepository.com/artifact/jp.co.yahoo.api-ads

 Users can use this just by writing it in pom.xml.
 Refer to the following document for further details.
  https://github.com/yahoojp-marketing/ads-display-api-java-lib
  https://github.com/yahoojp-marketing/ads-search-api-java-lib
 There is also an example of actually using the sample program as follows.
  https://github.com/yahoojp-marketing/ads-display-api-java-samples
  https://github.com/yahoojp-marketing/ads-search-api-java-samples

7. Remarks:
 ・More details will be available on the release note and reference
  document provided on the new version release.
  - Search Ads API  
  - Display Ads API  
  - Reference
 ・Note that there is no plan of v6 online seminar.

8. Yahoo! JAPAN Ads API v4 Sunset:
 Yahoo! JAPAN Ads API v4 sunset is scheduled as follows.
  Deprecation date: October 20, 2021 (Wed)
  End of Life Date : February 24, 2022 (Thu)

 Yahoo! JAPAN Ads API v3 will also end on the following scheduled date
 as previously announced in "Yahoo! JAPAN Ads API v5 released (Document
 Number: APIE-FY21-2154)."
  End of life date: October 20, 2021 (Wed)
  *We have ended the user support for this version already.


If you have any questions, please contact us.

Sincerely,
Yahoo! JAPAN API support team