Yahoo! JAPAN Ads API | Developer Center

2023/09/14

Yahoo! JAPAN Ads API v12 release

Update

September 14, 2023: Updated the information due to the release of API v12.

The release details have been updated from the initial announcement. More details are described in the following release note.
Yahoo! JAPAN Ads Search Ads API v12 Release Note
Yahoo! JAPAN Ads API Display Ads API v12 Release Note

ーーーーーーーー

We will release a new version of Yahoo! JAPAN Ads API.

Products

Yahoo! JAPAN Ads Search Ads API
Yahoo! JAPAN Ads Display Ads API

Version released

v12

Date

September 13, 2023

Changes on Yahoo! JAPAN Ads API

We will make changes to requests for all services in the Search Ads API and Display Ads API to support the MCC account multiple-level structure. We will add new services and update the user interface for the Search Ads API and the Display Ads API.
*See the following announcement for details.
MCC account settings will be available for multiple-level structure

• Changes in making requests
  Specifying x-z-base-account-id is required in the request header for all services. You can get an x-z-base-account-id from BaseAccountService that will be available.
  *Specifying x-z-base-account-id is not required for the following services:
  ・DictionaryService
  ・PlacementUrlIdeaService (Display Ads only)
  ・ContentsKeywordIdeaService (Display Ads only)
  ・SearchKeywordIdeaService (Display Ads only)

• New services
  We will add the following new services to Search Ads API and Display Ads API.
  ＜New services＞
  BaseAccountService

• Interface changes in some services
  See the following changes for Search Ads API and Display Ads API:

• Notes
  ‐You can check the access given to the account at BaseAccountService (new).
  ‐You can create accounts only directly under the root MCC in the AccountManagementService (add). The request header x-z-base-account-id must specify the ID of the root MCC account.

Changes on Search Ads API:

■Seasonality bid adjustment
We will support the "Seasonality bid adjustment" that briefly adjusts conversion rates for autobidding. *See the following announcement for details.
Search Ads Seasonality bid adjustment

• Service
  BiddingSeasonalityAdjustmentService

• Changes
  Add BiddingSeasonalityAdjustmentService

■Ad strength
We will support "Ad strength," a metric that shows how much you can expect to be effective with your Responsive Ads for Search settings. *See the following announcement for details.
Ad strength is now available

• Service
  ReportDefinitionService

• Changes
  Add "Ad Strength " to the report field in the ad report.

Changes on Display Ads API:

■Reports by title and description for Responsive Ads for Display
Reports by title and description for Responsive Ads for Display will be available.
*This feature is already available in the Campaign Management Tool. See the following announcement for details.
Responsive Ads for Display reports available for title and description

• Service
  ReportDefinitionService

• Changes
  Performance results per title or description will be available on ad reports for Responsive Ads for Display.

■Import conversions
We will support importing conversions you receive offline.
*This feature is already available in the Campaign Management Tool. See the following announcement for details.
Release of import feature for conversions

• Service
  OfflineConversionService（get,upload,downloadErrorFile）
  ConversionTrackerService

• Changes
  -Add new OfflineConversionService
  -Add "IMPORT" to conversionTrackerType in ConversionTrackerService

■Changes on related to recommendations
We will add recommendation types. The recommended image sizes will be added to the existing "Ad groups that have recommended image sizes."

• Service
  RecommendationService

• Changes
  -Add the following to RecommendationServiceType

  ENHANCED_CPC	Campaigns recommend using enhanced CPC
  CREATE_CAMPAIGN	Create a campaign
  CREATE_AD_GROUP	Add an ad group and ad
  CREATE_AD	Create an ad
  CREATE_RESPONSIVE_DISPLAY_ADS	Ad groups recommended using Responsive Ads for Display
  TURN_YOUR_ACCOUNT_ON	Turn your account on
  TURN_YOUR_AD_ON	Turn your ad on
  INSUFFICIENT_ACCOUNT_BALANCE	No payments or low account balance

  
  -Add the aspect ratio "6:5" to mediaAdFormat in "ADGROUPS_FOR_ADDING_ADS" (Ad groups that have recommended image sizes).

■Changes due to partial end of audience list
Changes will be made to the end of the audience lists with "Custom" and "Rule" list types, as follows:

• Service
  AudienceListService

• Changes
  -Remove ruleAudienceList and customAudienceList
  -Remove "RULE" and "CUSTOM_AUDIENCE" from audienceListType 。

■Add error code to AccountService
For accounts that have created guaranteed campaigns, an error will return if a specific operation is performed.

• Service
  AccountService（set）

• Changes
  Add the following error code:

  Code	Message	Description
  210005	Cannot update due to the dependency with the delivery settings of guaranteed campaign.	Unable to update due to dependencies with the delivery settings of a guaranteed campaign.

  
  The error is returned if either of the following cases applies.
  -When delivery settings are turned off for accounts before the delivery starts or with the guaranteed campaign in progress
  ‐When the account end date is updated to a date before or during the delivery duration for the guaranteed campaign

■Report enhancements
You will be able to select whether to output the removed entities in your report.

• Service
  ReportDefinitionService

• Changes
  Add reportIncludeDeleted to add requests. When specifying false, reports won't include removed entities. When specifying true, reports will include removed entities as before.

Comments

• More details will be available in the release notes and reference documents provided in the upcoming release.

• We will hold an online seminar to give an overview of v12 along with the release. We will make an additional announcement with more details.

Yahoo! JAPAN Ads API v10 sunset

Yahoo! JAPAN Ads API v10 sunset is scheduled as follows.
　Support end date: October 23, 2023
　End of life date: February 14, 2024

Yahoo! JAPAN Ads API v9 sunset is scheduled as follows.
　End of life date: October 23, 2023
　*We already have end user support for this version.