Yahoo! JAPAN Ads API v11 release

We will release a new version of Yahoo! JAPAN Ads API. Please see the following details.

Product

Yahoo! JAPAN Ads Search Ads API
Yahoo! JAPAN Ads Display Ads API

Version released

v11

Schedule

June 12, 2023 (Mon)
*The date is subject to change.

Changes on Search Ads API

■Change on reporting item name
We will change the field names to unify the names of report items in Yahoo! Japan Ads Search Ads API and Yahoo! JAPAN Ads Display Ads API.

  • Service
    ReportDefinitionService(getReportFields)

  • Changes

BeforeAfter
displayFieldNameEN displayFieldNameEn
displayFieldNameJA displayFieldNameJa

■Change in specifications for getting analytics for ConversionTrackerService In the ConversionTrackerService, the following analytics are returned by get, add, and set, but we will change the specification to return only get.

  • Service
    ConversionTrackerService

  • Changes
    Returns the following fields to get only

ConversionTrackerServicePage object

・totalAllConversionValue
・totalAllConversions
・totalConversionValue
・totalConversions

ConversionTracker object

・allConversionValue
・allConversions
・conversionValue
・conversions

■Remove some character codes in the history file
Remove the following character codes from the encoding format of the history file.

  • Service
    AuditLogService

  • Changes
    Remove "UTF16LE" from the character encodings available in the field "encoding."

■Remove services that are no longer available.
Remove services that are no longer available from the interface.

  • Service
    FeedService(add, set, remove)
    CampaignFeedService(get, set)
    AdGroupFeedService(get,set)
    FeedItemService(add, set, remove, setTrademarkStatus)
    PageFeedItemService(get, download, downloadErrorFile, getReviewSummary, getJobStatus, add)

Changes on Display Ads API

■Interface changes to improve recommendations
The interface will be changed to improve the features of recommendations. The versions before v10 will also change. See the following announcement for details of the improvements.
[Display Ads (Auction)] Changing the frequency of "Update your images and videos ads" in the recommendations

  • Service
    RecommendationService

  • Changes
    ‐ Remove viewableCtrTwoMonthsAgo from the response
    ‐ Add previousViewableCtr to the response.
    Before v10, all viewableCtrTwoMonthsAgo is returned null.

■ConversionTrackerService analytics acquisition specification changes
In the ConversionTrackerService, the following analytics are returned by get, add, and set, but we will change the specification to return only get.

  • Service
    ConversionTrackerService

  • Changes
    Returns the following fields to get only

ConversionTrackerServicePage object

・totalAllConversionValue
・totalAllConversions
・totalConversionValue
・totalConversionValueViaAdClick
・totalConversions
・totalConversionsViaAdClick
・totalCrossDeviceConversions

ConversionTracker object

・allConversionValue
・allConversions
・conversionValue
・conversionValueViaAdClick
・conversions
・conversionsViaAdClick
・crossDeviceConversions
・statsPeriodCustomDate

■Remove the destination URL field
Remove the destination URL field because ads with the destination URLs have been stopped after November 2022 and are no longer available.

  • Service
    AdGroupAdService
    ReportDefinitionService

  • Changes
    ‐ Remove url from AdGroupAdService.
    ‐ Remove "URL_ID (destination URLID)" and "URL_NAME (destination URL)" from the ReportDefinitionService report fields.

■Remove unavailable bid strategy
Remove the currently unavailable bid strategy "AUTO."

  • Service
    CampaignService
    AdGroupService

  • Changes
    Remove AUTO (Autobidding) from the CampaignServiceBiddingStrategyType.

■Support for specifying character encoding for history files
When creating a history file, specifying the character encoding will be available.

  • Service
    AuditLogService(add)

  • Changes
    Add encoding to the request field. The character encoding you can specify is SJIS or UTF8.

■Maintenance release

  • Support narrowing searches by AdType
    Add adTypes to the AdGroupAdService (get) request.

  • Remove ad type information from placement list URL suggestions
    Remove AdFormat from the PlacementUrlIdeaService request and response

Remarks

  • More details will be available on the release note and reference document provided on the new version release.

  • We will hold an online seminar to give an overview of v11 along with the release. We will make another announcement for the details.

Yahoo! JAPAN Ads API v9 Sunset

Yahoo! JAPAN Ads API v9 sunset is scheduled as follows.
 Support end date: June 26, 2023 (Mon)
 End of life date: October 23, 2023 (Mon)

Yahoo! JAPAN Ads API v8 sunset is scheduled as follows.
 End of life date: June 26, 2023 (Mon)
 *We have extended the end-of-life date. *We have ended the user support for this version already.