Yahoo! JAPAN Ads API | Developer Center

日本語

Display Ads API v10 Release Note

Release version

v10

Release date

February 14, 2023 (Tue)

Main contents of this release

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

1. Yahoo! JAPAN Audience Discovery

A new list, "Audience list (Yahoo! JAPAN Audience Discovery)" became available.
*This new list has been already available on the Campaign Management Tool. See the following announcement for the details.
Display Ads Release of new audience list and end of current audience list (custom)

Services

AudienceListSevice
AdGroupTargetService
GuaranteedAdGroupService

Description

AudienceListSevice
-Add ENUM value "YAHOO_JAPAN_AUDIENCE_DISCOVERY" to audienceListType and sourceType
-Add yahooJapanAudienceDiscoveryAudienceList field to audienceListContent
AdGroupTargetService, GuaranteedAdGroupService
-Add ENUM value "YAHOO_JAPAN_AUDIENCE_DISCOVERY" to audienceListType

2. Optimization score

You are able to check the optimization score to evaluate how well the autobidding is optimized.
*This new list has been already available on the Campaign Management Tool.
See the following release note for details.
[Display Ads (Auction)] Optimization score released

Services

AccountService

Description

Add optimizationScore as a field for per-account optimization scores

3. Image enhancement feature

A feature to adjust the added images to high quality will be available.
This feature adjusts the added images to a high quality and avoids roughness.
*This new list has been already available on the Campaign Management Tool.
See the following release note for details.
[Display Ads] Improved image quality when adding images

Services

MediaService

Description

Add mediaRecord.imageMedia.upscaleImageEnabled
The default setting is "Upscale image (On)."
This feature is not available for the versions before v9.

4. Rename of ad types and add new items

Renamed and added new fields to change the ad type to a form that divides ad types into ad types and media formats.
*See the following announcement for details.
[Display Ads] Changes on ad type names and additional items

Services

AdGroupAdService
GuaranteedAdGroupAdService
ReportDefinitionService
PlacementUrlIdeaService

Description

Changes on each service are as follows.

Service name	Changes
AdGroupAdService	Change adType to the following: ・BANNER_AD ・CAROUSEL_AD ・DYNAMIC_DISPLAY_AD ・RESPONSIVE_AD ・TEXT_AD
	Add mainMediaFormat field in parallel position with adType as the main media format. Followings can be specified for ENUM values: ・NONE ・IMAGE ・VIDEO
	Merge the classes representing ad details and change them to the followings: ・Merge bannerImageAd and bannerVideoAd, and change to bannerAd ・Merge responsiveImageAd and responsiveVideoAd, and change to responsiveAd ・Rename dynamicAd to dynamicDisplayAd
	Remove adStyle
GuaranteedAdGroupAdService	Change adType to the following: ・BANNER_AD ・CAROUSEL_AD ・INSTREAM_AD ・BRANDPANEL_QUINTIE ・BRANDPANEL_PANORAMA ・BRANDPANEL_PANORAMA_PANEL_SWITCH ・TOP_IMPACT_SQUARE ・TOP_IMPACT_QUINTIE ・TOP_IMPACT_THEATER ・TOP_IMPACT_PRIME_DISPLAY_DOUBLE ・TOP_IMPACT_PANORAMA ・TOP_IMPACT_PANORAMA_SIDE_VISION ・TOP_IMPACT_PANORAMA_SIDE_SWITCH ・TOP_IMPACT_PANORAMA_PANEL_SWITCH
	Add mainMediaFormat field in parallel position with adType as the main media format. Followings can be specified for ENUM values: ・IMAGE ・VIDEO
	Merge the classes representing ad details and change them to the followings: ・bannerAd ・carouselAd ・instreamAd ・brandPanelQuintie ・brandPanelPanorama ・brandPanelPanoramaPanelSwitch ・topImpactSquare ・topImpactQuintie ・topImpactTheater ・topImpactPrimeDisplayDouble ・topImpactPanorama ・topImpactPanoramaSideVision ・topImpactPanoramaSideSwitch ・topImpactPanoramaPanelSwitch
	Remove adStyle
PlacementUrlIdeaService	Add mainMediaFormat field in parallel position with adType as the main media format. Followings can be specified for ENUM values: ・NONE ・IMAGE ・VIDEO
PlacementUrlIdeaService	Remove adStyle
ReportDefinitionService	New adType can be output as a report item

*The change history file that can be downloaded by AuditLogService is output with ad type in the old format.

5. Remove flag to the ad group bid and target CPA

Added a remove flag for the maximum bid (CPC, CPV, vCPM) and the target value (tCPA) to be set in the bid strategy for the ad group.

Services

AdGroupService

Description

Add the following fields.
cpcBiddingScheme.isRemoveCpc
cpvBiddingScheme.isRemoveCpv
vcpmBiddingScheme.isRemoveVcpm
maximizeConversionsBiddingScheme.isRemoveTargetCpa

When the maximum bid (CPC, CPV, vCPM) and target value (tCPA) are "0" (zero), the value is removed, but this value will not be removed or changed in API v10.
When you want to remove the value, turn on the remove flag.

5. Remove flag to the ad group bid and target CPA

Services

FeedDataService
ReportDefinitionService
StatsService
VideoService
AdGroupAdService
AdGroupService
CampaignService
AuditLogService

Description

・Rename fields

Service name	Before	After
FeedDataService	fileUploadSrc	fileUploadSource
ReportDefinitionService	displayFieldNameEN	displayFieldNameEn
ReportDefinitionService	displayFieldNameJA	displayFieldNameJa
ReportDefinitionService(getReportFields)	type	reportType
StatsService	vimps	viewableImps
	clickCnt	clicks
	averageRateVideoViewed	avgPercentVideoViewed
	averageDurationVideoViewed	avgDurationVideoViewed
	conversionRate	convRate
	conversionValue	convValue
	valuePerConversions	valuePerConv
	allConversions	allConv
	allConversionRate	allConvRate
	allConversionValue	allConvValue
	valuePerAllConversions	valuePerAllConv
	conversionValueViaAdClick	convValueViaAdClick
	budgetImpressionShareLostRate	impressionShareBudgetLoss
	rankImpressionShareLostRate	impressionShareRankLoss
	viewThroughConversions	convValueViaViewThrough
	valuePerConversionsViaAdClick	valuePerConvViaAdClick
	statsStartDate	startDate
	statsEndDate	endDate
VideoService	creationTime	createdDatetime
CampaignService	containsLabelIdFlg	containsLabel
CampaignService	deviceOsType	appOsType
AdGroupService	containsLabelIdFlg	containsLabel
AdGroupService	containsLabelIdFlg	containsLabel
AuditLogService	updateSource	sourceType

・Other changes

Service name	Changes
ReportDefinitionService	Change default for numberResults integer($int32) to 500
ReportDefinitionService	Change format of requestTime and completeTime to yyyy/MM/dd HH:mm:ss Example: "requestTime": "2022/08/05 12:30:33"
AdGroupService	Change the maximum of followings to 1000 ・adGroupIds[] ・campaignIds[]
AdGroupAdService	Change the maximum of followings to 1000 ・adGroupIds[] ・campaignIds[] ・adIds[]
AdGroupAdService	Remove the following items from under adType and add them under ad ・customParameters[] ・smartphoneFinalUrl ・isRemoveSmartphoneUrl ・finalUrl ・displayUrl ・displayUrlLevel ・trackingUrl ・isRemoveTrackingUrl Example: remove ad.bannerImageAd.finalUrl and add ad.finalUrl
AuditLogService	Add "YAHOO_JAPAN" to the ENUM value that can be specified in sourceType (field name before change is updateSource)

7. Maintenance release

Some returned values of report items have been changed.

Services

ReportDefinitionService

Description

Returns the report item "MEDIA_AD_FORMAT," indicating the pixel size of images and videos, with "1200 × 300" replacing the "1000 × 250" value
Change "Attribute･Life events" to "Attribute, life events" in the English return value for the audience category type

Display Ads API v8 Sunset

Display Ads API v8 is scheduled to sunset as follows.

End of support date : Feb 27, 2023 (Mon)
End of life date : June 23, 2023 (Fri)

Display Ads API v7 sunset that we previously announced is scheduled as follows.

End of life date : June 23, 2023 (Fri)
*We have ended the user support for this version already.

Developer Center

Related sites: