Yahoo! JAPAN Ads API | Developer Center

2020/06/23

Yahoo! JAPAN Ads API v2 release

Document Number: APIE-FY20-2038

Dear customer,

Thank you for using Yahoo! JAPAN Ads.

We will release new version for Yahoo! JAPAN Ads API.
The reference document of Yahoo! JAPAN Ads API will be renewed.
Please see the following details.

Once again, thank you for using Yahoo! JAPAN Ads.


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

2. Version released:
　v2

3. Schedule:
　July 20, 2020 (Mon)
　*Schedule may change without prior notice.

4. Overview:
　More details will be available on the release note and reference
　document provided on the new version release.
　
　[Search Ads API]
　・Ad group's target value for autobidding
　　Following items will be added to "AdGroup" object of "AdGroupService"
　　　targetRoasOverride
　　　targetCpaOverride

　　With these changes, for the campaign methods "Auto bidding : Target CPA"
　　and "Auto bidding : Target ROAS", to set individual target values for
　　the ad groups under the campaign will become available.
　　* This was released in May 2020 on the Campaign Management Tool.
　　See the following announcement for the details.
　　　[Search Ads] Target value for Autobidding
　　
　・Change budget on monthly charge
　　"AccountServiceBudget" object of "AccountService" will support budget
　　change on monthly charge.
　　* This monthly charge is available only for limited advertisers.

　・Acquire authorized business ID
　　The new item "authorizationBusinessId" will be added on "AccountServicePage"　　
　　object of "AccountService".
　　With this change, acquiring Yahoo! JAPAN business ID authorized by
　　your tool will become available.

　・Change some ad-related item names
　　Following item names will change on "AdGroupAdServiceAd" object of
　　"AdGroupAdService".
　　[Before]　　　 [After]
　　headline　　　headline1
　　description　 description1

　・Sunset BidLandscapeService
　　"BidLandscapeService" will become out of support.

　・System update
　　System maintenance is planned on API.
　　- "keywordMatchType" will be deleted from the
　　　"TargetingIdeaServiceProposalKeyword" object on the GET response
　　　of "TargetingIdeaService".
　　- HTTP method will change from GET to POST on some services.

　[Display Ads API]
　・Change budget on monthly charge
　　"AccountServiceBudget" object of "AccountService" will support
　　budget change on monthly charge.
　　* This monthly charge is available only for limited advertisers.

　・Acquire authorized business ID
　　The new item "authorizationBusinessId" will be added on
　　"AccountServicePage" object of "AccountService".

　　With this change, acquiring Yahoo! JAPAN business ID authorized by
　　your tool will become available.

　・Add AccountAuthorityService
　　"AccountAuthorityService" that works for account roles on Display Ads
　　(Auction) will be newly added.

　　With this change, the item "accountAuthorities" on "Account" object
　　of "AccountService" will be deleted.

　・Change range of "Age" column for creating performance report
　　When specifying "Age" on creating performance report, former age
　　segments "under 6" and "6-12" will be totalized as "5-12".

　・System update
　　System maintenance is planned on API.
　　- Change some contents on AdGroupService
　　　The item "isRemoveFeedSetId" of "AdGroupServiceValue" will be deleted.
　　　Change the Enum name of "AdGroupType" to "AdGroupServiceBidType".

　　- Change some contents on ReportDefinitionService
　　　Unified some item names to the same notation as Search Ads API
　　　* Learn more about details on the release note.

　　　"Lifetime" will be added to the item "dateRangeType" of
　　　"ReportDefinition" object, for the coming feature enhancement.

　　- The new item "isRemoveDescription" will be added to the following
　　　services;
　　　　PlacementUrlListService
　　　　RetargetingListService
　　　　SearchKeywordListService

　・HTTP method will change from GET to POST on some services.

5. Some changes on the former API versions
　　Acquiring metrics related to Impression share by "ReportDefinitionService"
　　became available on the following API versions.
　　* This change was applied to Display Ads API v1 on April 1, 2020.

　　The following announcement describes the details.
　　　Display Ads additional metrics of Performance data and reports
　　
　・Schedule: June 23, 2020 (Tue)
　・Effected API: YDN API V201907, V201907　
　　　　　　　　Display Ads API v0

　・Metrics that became available:
　　　IMPRESSION_SHARE
　　　IMPRESSION_SHARE_BUDGET_LOSS
　　　IMPRESSION_SHARE_RANK_LOSS

6. Yahoo! JAPAN Ads API new reference document:
　The reference document of Yahoo! JAPAN Ads API was renewed and its URL
　changed.
　Please access the following URL for the new reference.
　*The reference will be available after the v2 effective date.
　・Search Ads API
　　https://ads-developers.yahoo.co.jp/reference/ads-search-api/
　・Display Ads API
　　https://ads-developers.yahoo.co.jp/reference/ads-display-api/

7. Yahoo! JAPAN Ads v0 Sunset:
　Yahoo! JAPAN Ads v0 sunset is scheduled as follows.
　　- Deprecation date: August 31, 2020 (Mon)
　　- End of life date: November 19, 2020 (Thu)


If you have any questions, please contact us.

Sincerely,
Yahoo! JAPAN API support team