Yahoo! JAPAN Ads API | Developer Center

Display Ads API v3 Release Note

Release version

v3

Release Date

October 20, 2020 (Tue)

Main Contents of this Release

*More about objects and other details are described on the Reference document.

1. Importing customers data

Importing customer's data that you stored for using a custom list for ad delivery became available. See also the following announcement.
[Display Ads] Data importing feature enhancement

Service that covers this feature
RetargetingListService
・Added uploadUserList
・Added getUploadUserListStatus

2. Cross-campaign Reach report and Conversion Path report

New reports, "Cross-campaign Reach report" and "Conversion Path report", became available. See also the following announcement.
[Display Ads] New reports release

Service that covers this feature
ReportDefinitionService
・Added the followings on ReportDefinitionServiceType
　- CONVERSION_PATH
　- CROSS_CAMPAIGN_REACHES

・Added reportTypeCondition on ReportDefinition

3. New format of Site general tag

Getting site general tag in a new format provided on the Campaign Management Tool became available on API.

Service that covers this feature
・ConversionTrackerService
　Add advancedTag on the response when adding WEB_CONVERSION by add or getting WEB_CONVERSION by get.

・RetargetingListService
　Add advancedTag on the response of add, get, set and remove.

4. Maintenance Release

Following changes were made.
・AccountService
　Removed "budget" from request and response, stopped getting and updating account budget

・AdGroupAdService
　- Added the followings on dynamicAd and supported removing the values of brandColor, prefix, suffix.
　　isRemoveBrandColor
　　isRemovePrefix
　　isRemoveSuffix
　- Added the following items to support filtering by ad creation date
　　Added createdDateRange on AdGroupAdServiceSelector
　　Added createDate on AdGroupAd

・AdGroupService
　- Added the following items to support filtering by ad group creation date
　- Added createdDateRange on AdGroupServiceSelector
　- Added createDate on AdGroup

・BudgetOrderService
　This service can get and update account budget information

・CampaignService
　- Added the following items to support filtering by campaign creation date
　- Added createdDateRange on CampaignServiceSelector
　- Added createdDate on Campaign

・DictionaryService
　Added richFormat that describes whether the image is for ads of Display Ads (Guaranteed) on"get" response of DictionaryServiceMediaAdFormat

・MediaService
　- Added mediaRichFormatFlg that describes whether the image is for ads of Display Ads (Guaranteed) on "get" response of MediaServiceRecord
　- Added the following items to support filtering by image creation date
　　Added createdDateRange on MediaServiceSelector
　　Added createdDate on MediaServiceRecord

・ReportDefinitionService
　Ended frequencyRange, changed creation of Reach report and Frequency report by reportTypeCondition

・VideoService
　- Added the following items to support filtering by video creation date
　　Added createdDateRange on VideoServiceSelector
　　Added createdDate on Video

5. Maintenance Release (later date)

Additional maintenance and improvements will be carried out on each of the following dates.
・Schedule:
　November 25, 2020 (Wed)
　*Schedule may change without prior notice.

AdGroupAdService
・Increased disapprovalReasonCodes for all actions from 10 to 30 reasons. Up to 30 reject reasons for ad became available and those reasons are now referable on requesting re-review.
・Schedule:
　November 26, 2020 (Thu)
　*Schedule may change without prior notice.

DictionaryService
　We will add new formats and revise values on MediaAdFormat of Display Ads (Guaranteed)
　- Add new
　　YJ_1350_760
　　YJ_450_150
　- Video aspect ratio 16:9
　　YJ_170_1024: Changed aspectRatio from AR_170_1024 to AR_85_512
　　YJ_450_50: Changed aspectRatio from AR_450_50 to AR_9_1
　　* Display Ads (Guaranteed) is available for specific advertisers.
　　* No change on MediaAdFormat of Display Ads (Auction).

6. Recommendations

We have started the new feature "Recommendations" from December 17, 2020.
It is a function that proposes optimization such as changing the budget or changing to autobidding according to the account operating status.
Consider to use this new feature.
See the following announcement for the details.
Display Ads API Recommendations feature released

Sunset schedule of Yahoo! JAPAN Ads Display Ads API former versions

Older versions will sunset on the following dates.

　v1
　Deprecation Date : November 30, 2020 (Mon)
　End of Life Date : March 22, 2021 (Mon)
　v0
　End of Life Date : November 19, 2020 (Thu)
*We have ended the user support for this version already.