Yahoo! JAPAN Ads API | Developer Center

日本語

Search 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. Add a remove flag to target value for autobidding

Added a remove flag to the target values for autobidding "Maximize conversions" and "Maximize conversion value."

Services

CampaignService
AdGroupService

Description

Following fields were added to CampaignService.
maximizeConversionsBiddingScheme.isRemoveTargetCpa
maximizeConversionValueBiddingScheme.isRemoveTargetRoas
When the target value for autobidding is set to null, 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.
Following fields were added to AdGroupService. maximizeConversionsBiddingScheme.isRemoveTargetCpa
maximizeConversionValueBiddingScheme.isRemoveTargetRoas
targetCpaBiddingScheme.isRemoveTargetCpa
When the target value for autobidding is "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.

2. Interface unification

To unify the interface across multiple services of Yahoo! JAPAN Ads Search Ads API and Yahoo! JAPAN Ads Display Ads API, we made some changes to Search Ads API, such as renaming or removing fields.

Services

ConversionTrackerService
CampaignService
AdGroupService
AdGroupAdService
AccountService
BudgetOrderService
LabelService
ReportDefinitionService
AuditLogService
CampaignExportService
PageFeedItemService

Description

・Rename fields

Service name	Before	After
ConversionTrackerService	appPostbackUrlClearFlag	isRemoveUrl
CampaignService	containsLabelId	containsLabel (*)
CampaignService	appStore	appOsType
AdGroupService	containsLabelId	containsLabel (*)
AdGroupService	bid	biddingStrategyConfiguration.biddingScheme.cpcBiddingScheme
AdGroupAdService	containsLabelId	containsLabel (*)

(*) Changed from ENUM values to boolean values

・Removing fields

Service name	Fields to be removed
CampaignService	budget.budgetPeriod
AdGroupService	bid.bidSource
	targetRoasOverride
	targetCpaOverride

・Adding new fields

Service name	New field to be added
AdGroupService	biddingStrategyConfiguration
	biddingStrategyConfiguration.portfolioBiddingId
	biddingStrategyConfiguration.biddingScheme.biddingStrategyType
	biddingStrategyConfiguration.biddingScheme
	isRemoveTrackingUrl * trackingUrl can be removed.

・Other changes

Service name	Changes
AccountService	Change the maximum and default values of the followings to 500 ・accountIds[] ・numberResults
BudgetOrderService
LabelService	Change the default value of numberResults to 2000
AdGroupAdService	Remove ad.description1 and ad.headline1, and added the followings: ・AppAd.headline ・AppAd.description ・DynamicSearchLinkedAd.description ・ExtendedTextAd.headline ・ExtendedTextAd.description ・TextAd.headline ・TextAd.description
ReportDefinitionService	・Change canFilter to filterable ・Change canSelect to selectable
AuditLogService	Modify AuditLogService/addJob endpoint to AuditLogService/add
CampaignExportService	Modify CampaignExportService/addJob endpoint to CampaignExportService/add
PageFeedItemService	Modify PageFeedItemService/addDownloadJob endpoint to PageFeedItemService/add

3. Maintenance release

We have added some fields and Enum to the following services in order to add functions in the future.
We will make another announcement once the detail has been decided.

Services

AdGroupAdService

Description

Add the followings to ad

reviewCustomParameters
reviewFinalUrl
reviewSmartphoneFinalUrl
reviewTrackingUrl
isRemoveSmartphoneFinalUrl
isRemoveTrackingUrl
Make following changes on responsiveSearchAd

Add reviewHeadlines[], reviewDescriptions[], reviewPath1, reviewPath2, isRemovePath1, isRemovePath2
Add activeStatus to headlines[], descriptions[].
Add POST_DISAPPROVED and APPROVED_WITH_REVIEW to approvalStatus in headlines[], descriptions[].

Search Ads API v8 Sunset

Search Ads API v8 is scheduled to sunset as follows.

Support end date: Monday, February 27, 2023
End of life date : June 23, 2023 (Fri)

Yahoo! JAPAN Ads API v7 sunset that we previously announced is scheduled as follows.

End of life date: February 27, 2023 (Mon)
*We have ended the user support for this version already.

Developer Center

Related sites: