Yahoo! JAPAN Ads API | Developer Center

Search Ads API v12 Release Note

Release version

v12

Release date

September 13, 2023

Main contents of this release

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

1. MCC account multiple-level structure

We have changed all service requests to support the MCC account multiple-level structure. We added new services and updated the user interface.
*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 become available.
  *Specifying x-z-base-account-id is not required for the following services:
  ・DictionaryService
  ・ReportDefinitionService（getReportFields）
  ・BaseAccountService *new

• New services
  We added the following service:
  BaseAccountService

• Interface changes in some services
  Changes are as follows:

  Service	Changes
  AccountService	Request 　－Remove authType, includeManagerAccount 　－Add includeMccAccount Response 　－Remove authType, isManagerAccount 　－Add isMccAccount
  AccountLinkService	Common to request/response 　－Rename managerAccountId to mccAccountId 　－Remove audienceListSharingEnabled Response 　－Remove linkAccessPermission
  AccountManagementService	Common to request and response 　－Remove authType 　－Remove "CANCELED" from status

• Precaution
  ・You can check the access given to the account at BaseAccountService.
  ・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.

2. Change on reporting item name

We changed some item names, such as for performance report, due to the renewal of the Campaign Management Tool (*1).

・The change is only in the name, there are no changes in features, operations, or specifications.
・Download the following document for details on item changes.
　Download the document
・The items related to change history are subject to change only in v12. The items before v11 are displayed as old items.

*1 See the following announcement for the renewal of the Campaign Management Tool.
Renewal of the Campaign Management Tool for Search Ads (Phase 4)

3. Seasonality bid adjustment

We support the "Seasonality bid adjustment" that adjusts short-term conversion rates for autobidding. See the following announcement for details.
Search Ads Seasonality bid adjustment

Service

BiddingSeasonalityAdjustmentService

Description

Add BiddingSeasonalityAdjustmentService

4. Shared budget

We will support the "Shared budget" feature, which will be released in the future. This feature will be available after the release. See the following announcement for details.
Release of Shared budgets

Services

CampaignBudgetService
CampaignService
ReportDefinitionService
AuditLogService

Description

・Add CampaignBudgetService
・Change CampaignService to allow shared budgets to be set.
・Add "Shared budget report" to the ReportDefinitionService report types.
・Change to allow AuditLogService to retrieve change history related to shared budgets.

5. Change the format of the change history

The following changes were made: v11 and lower are displayed in the old format.

・Updated the format of the output file. Now, the display is aligned with the Yahoo! Ads Display Ads.
・Changed the data format.

Service

AuditLogService

Description

・Updated output file format.
・Changed the date format of dateRange.startDate and dateRange.endDate as follows:
From "yyyyMMMddHHmmss" to "yyyyMMMdd"

6. Add restrictions to RetargetingListService

We added the following restrictions.

Service

RetargetingListService（set）

Description

If isDateSpecificRule=True, the following four items can't be modified. Including the target item in the SET will result in an error.
・ruleBaseTargetList.isAllVisitorRule
・ruleBaseTargetList.rules[]
・reachStorageStatus
・reachStorageSpan

Precaution

The API v12 won't support "Ad strength" due to the postponed release. See the following announcement for details.
Ad strength is now available

Online seminars

We will hold an online seminar to give an overview of v12 along with the release. In this seminar, we will explain in detail the requirements of a base account ID for API authentication. Please join us. See the following announcement for details.

Yahoo! JAPAN Ads API Webinar information

Search Ads API v10 Sunset

Search Ads API v10 is scheduled to sunset as follows.

• Support end date: October 23, 2023
• End of life date: February 14, 2024

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

• End of life date: October 23, 2023
  *We already ended user support for this version.