Yahoo! JAPAN Ads API | Developer Center

Display Ads API v6 Release Note

Release version

Release date

September 13, 2021 (Mon)

Main Contents of this release

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

1. 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

　Service
　・Added a new ConversionGroupService
　・ConversionTrackerService
　　Added the following fields:
　　- excludePreviousConversion that is a flag to exclude the current conversion information in GET request
　　- isPreviousConversion that is a flag to indicate whether the response contains the old conversion information including old tag
　　　*"The old conversion information" is a conversion setting that uses a conversion tag for which a conversion label has not been set.
　・CampaignService
　　・Added conversionTracker field
　・GuaranteedCampaignService
　　・Added conversionTracker field
　・GuaranteedReservationService
　　・Added conversionTracker field

2. New setting items for ads such as Final URL

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

　Service
　・Added AccountTrackingUrlService as new
　・AdGroupAdService
　　Added finalUrl, displayUrlLevel, smartphoneFinalUrl, trackingUrl, customParameters
　・CampaignService
　　Added trackingUrl, customParameters
　・AdGroupService
　　Added trackingUrl, customParameters

3. 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

　Service
　・RetargetingListService
　　Changed followings on uploadUserList
　　 - supported uploading any user identifier
　　 - added customEntityId
　　 - renamed to customUserId to customUidKey
　　 - renamed USERID to CUSTOM_UID_KEY on the Enum RetargetingListServiceUploadUserListUploadType of uploadType

4. Analytics of content keyword targeting

Getting analytic information of content keyword targeting became available.

　Service
　・StatsService
　　Added "Content keyword" to statsType.

5. Avg. CPM and Average vCPM

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

　Service
　・StatsService
　　Added values of "avgCpm" and "avgVcpm"

6. 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.

　Service
　・AdGroupService
　　MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIEW, MAXIMIZE_VIEABLEIMPRESSIONS were added on campaignBiddingStrategyType
　・CampaignService
　　MAXIMIZE_CONVERSIONS, MAXIMIZE_CLICKS, MAXIMIZE_VIEW, MAXIMIZE_VIEABLEIMPRESSIONS were added on campaignBiddingStrategyType
　・AccountAuthorityService
　　MAX_CV, MAX_CLICK, MAX_VIEW, MAX_VIMPS were added on accountAuthority

7. 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.

　Service
　AuditLogService

8. End of YDN support

Along with EOL, we made changes on Display Ads (YDN).

Service	Change	Fields to be changed
CampaignMigrationService	Deleted the service	-
CampaignService	Deleted fields	・adProductType ・biddingStrategy ・conversionOptimizer ・frequencyCap ・type
AdGroupService	Deleted fields	・bid ・conversionOptimizer ・dynamicImageExtensions ・smartDeviceCarriers
AdGroupAdService	Deleted fields	bid
AdGroupTargetService	Deleted fields	・INTEREST_CATEGORY and CARRIER_TARGET of targetType ・carrierTarget ・interestCategoryTarget
ReportDefinitionService	Deleted fields	・FREQUENCY and INTEREST_CATEGORY of reportType ・frequencyReportCondition
DictionaryService	Deleted action	GetInterestCategory
RecommendationService	Changed action	・Specifying MIGRATE_TO_YDA is unavailable by the "types" of request ・MIGRATE_TO_YDA does not return on the "recommendation.type" of response ・MIGRATE_TO_YDA does not return on the "recommendation.migrateToYda"

9. 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

　Service
　・CampaignService
　　Added budgetAmountRange
　・AdGroupService
　　Added biddingValueCpcRange

Display Ads API v4 Sunset

Display Ads API v4 is scheduled to sunset as follows.
・Deprecation date: October 20, 2021 (Wed)
・End of Life Date : February 24, 2022 (Thu)

Display Ads API v3 sunset is scheduled as follows.
・End of life date: October 20, 2021 (Wed)
　*We have ended the user support for this version already.

Developer Center

Related sites: