Yahoo! JAPAN Ads API | Developer Center

2020/07/21

Yahoo! JAPAN Ads API v2 released

Document Number: APIE-FY20-2050

Dear customer,

Thank you for using Yahoo! JAPAN Ads.

Yahoo! JAPAN Ads API new version has been released, as previously announced
in "Yahoo! JAPAN Ads API v2 release (Document Number : APIE-FY20-2038)."
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. Effective date:
　July 20, 2020 (Mon)

4. Overview:
　
4-1. Search Ads API:
　[Ad group's target value for autobidding]
　Following items have been 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]
　Monthly budget can be changed only when accountType is "INVOICE."
　The budget amount needs to be specified in increments of 1,000.

　[Acquire authorized business ID]
　Added the new item "authorizationBusinessId" to "AccountServicePage"
　object of "AccountService."
　With this change, added support for obtaining the Yahoo! JAPAN business
　ID, which authorizes the application to access Yahoo! JAPAN Ads.

　[Change some ad-related item names]
　Changed the following item names on "AdGroupAdServiceAd" object of
　AdGroupAdService.
　　
　　(Before)　　　 (After)
　　headline　　　headline1
　　description　 description1

　[Sunset BidLandscapeService]
　"BidLandscapeService" became out of support.

　[System update]
　Feature enhancement and some system updates have been made for the
　following services.

　- Deleted "keywordMatchType" from the "TargetingIdeaServiceProposalKeyword"
　　object on the GET response of "TargetingIdeaService"
　- Added the following item to CampaignTargetServiceNetworkCoverageType
　　(Ad distribution) in CampaignTargetService
　　　SEARCH_NETWORK (All ad distribution types including Yahoo! JAPAN Search)
　- Changed HTTP method of getExportFields from GET to POST to unify HTTP
　　methods of services
　- Added new error code (2001) to AccountSercice


4-2.Display Ads API:
　[Change budget on monthly charge]
　Monthly budget can be changed only when accountType is "INVOICE."
　The budget amount needs to be specified in increments of 1,000.

　[Acquire authorized business ID]
　Added the new item "authorizationBusinessId" on AccountServicePage
　object of AccountService.
　With this change, added support for obtaining the Yahoo! JAPAN business
　ID, which authorizes the application to access Yahoo! JAPAN Ads.

　[Add AccountAuthorityService]
　Added AccountAuthorityService that works for account roles on Display Ads.
　With this change, the item "accountAuthorities" on "Account" object of
　"AccountService" has been 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"

　[Add View through conversions]
　Added the new tracking value "View through conversions
　(viewThroughConversions)".
　See the announcement for the details.
　Please note that the value will become available after the effective date.
　
　[System update]
　Feature enhancement and some system updates have been made for the
　following services.
　- 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
　　"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]
　More details are available on the release note and reference document
　provided.

4-3.Release Note:
　[Search Ads API]
　https://ads-developers.yahoo.co.jp/developercenter/en/developers-guide/ysa-v2.html
　[Display Ads API]
　https://ads-developers.yahoo.co.jp/developercenter/en/developers-guide/yda-v2.html

4-4.Reference:
　[Search Ads API]
　https://ads-developers.yahoo.co.jp/reference/ads-search-api/?lang=en
　[Display Ads API]
　https://ads-developers.yahoo.co.jp/reference/ads-display-api/?lang=en

5. Yahoo! JAPAN Ads API v0 Sunset
　Yahoo! JAPAN Ads v0 sunset is scheduled as follows.
　-Deprecation Date : September 2, 2019 (Mon)
　-End of Life Date : November 19, 2020 (Thu)


If you have any questions, please contact us.

Sincerely,
Yahoo! JAPAN API support team