Yahoo! JAPAN Ads API | Developer Center

Display 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 update 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 became available.
  *Specifying x-z-base-account-id is not required for the following services:
  ・ DictionaryService
  ・ ReportDefinitionService（getReportFields）
  ・ BaseAccountService *new
  ・ PlacementUrlIdeaService
  ・ ContentsKeywordIdeaService
  ・ SearchKeywordIdeaService

• New service
  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 and isManagerAccount -iAdd isMccAccount
  AccountLinkService	Common to request and 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. Reports by title and description for Responsive Ads for Display

Reports by title and description for Responsive Ads for Display became 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

Description

Performance results per title or description became available on ad reports for Responsive Ads for Display.

3. Import conversions

We 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

Description

• Add new OfflineConversionService

• Add "IMPORT" to conversionTrackerType in ConversionTrackerService.

4. Changes on related to recommendations

We added recommendation types. The recommended image sizes were added to the existing "Ad groups that have recommended image sizes."

Service

RecommendationService

Description

• Add the following to RecommendationServiceType

  ENUM Name	Description
  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).

5. Ad type changes for Top Page Topic PR

We will support the ad type changes for Top Page Topic PR in Display Ads (Guaranteed).
*See the announcement for details. (Available only in Japanese)

Service

GuaranteedAdGroupAdService(get)

Description

Add "TOP_PAGE_TOPICS_PR" to GuaranteedAdGroupAdServiceAdType to represent Top Page Topics PR ads.
*Getting information on Top Page Topic PR ads will be available after October 3, 2023.

6. Changes due to partial end of audience list

Changes were made to the end of the audience lists with "Custom" and "Rule" list types, as follows:

Service

AudienceListService

Description

• Remove ruleAudienceList
  -> It has been postponed. The removal is scheduled for v13.
  

• Remove customAudienceList

• Remove "RULE" and "CUSTOM_AUDIENCE" from audienceListType

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

Description

Add the following error code:

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.

8. Report enhancements

You can select whether to output the removed entities in your report.

Service

ReportDefinitionService

Description

Add reportIncludeDeleted to add requests When specifying false, reports don't include removed entities. When specifying true, reports include removed entities as before.

9. Improve the download feature of change history

You can specify the file format of the change history.

Service

AuditLogService

Description

Add output to add requests and get and add responses.

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

Display Ads API v10 Sunset

Display Ads API v10 is scheduled to sunset as follows.

• Support end date: October 23, 2023

• End of life date: February 14, 2024

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

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