Yahoo! JAPAN Ads API | Developer Center

日本語

Display Ads API v11 Release Note

Release version

v11

Release date

June 12, 2023 (Mon)

Main contents of this release

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

1. Interface changes to improve recommendations

The interface has changed to improve the features of recommendations. The versions before v10 are also changed. See the following announcement for details of the improvements.
Display Ads (Auction) Change the frequency of updating your images and video ads in the recommendations

Services

RecommendationService

Description

  • Removed viewableCtrTwoMonthsAgo from the response.

  • Added previousViewableCtr to the response.

*Before v10, all viewableCtrTwoMonthsAgo is returned null.

2. ConversionTrackerService analytics acquisition specification changes

In the ConversionTrackerService, the following analytics were returned by get, add, and set, but we have changed the specification to return only get.

Services

ConversionTrackerService

Description

Returns the following fields to get only

ConversionTrackerServicePage object

・totalAllConversionValue
・totalAllConversions
・totalConversionValue
・totalConversionValueViaAdClick
・totalConversions
・totalConversionsViaAdClick
・totalCrossDeviceConversions
ConversionTracker object

・allConversionValue
・allConversions
・conversionValue
・conversionValueViaAdClick
・conversions
・conversionsViaAdClick
・crossDeviceConversions
・statsPeriodCustomDate

3. Extend the reporting period of the performance data

The reporting period will expand to the last 37 months from the last 25 months for performance data. It will be available on June 21, 2023 (Wed). See the following announcement for details.
Display Ads Longer reporting period for performance data

Services

StatsService
ConversionTrackerService

Description

statsPeriod: Added REALTIME_LAST37MONTH.

4. Reports of the content keyword targeting

Creating reports for content keyword targeting is available.

Services

ReportDefinitionService

Description

Added CONTENT_KEYWORD_LIST to reportType.
*CONTENT_KEYWORD_LIST can only be specified in getReportFields.

5. Add the enhanced CPC of the bid strategy

Supported "Enhanced CPC (eCPC)" of a beta version in the bid strategy.

Services

CampaignService
AdGroupService

Description

Added enhancedCpcEnabled to biddingStrategyConfiguration.biddingScheme.cpcBiddingScheme object. When specifying TRUE for enhancedCpcEnabled, the enhanced CPC (eCPC) will be active. Specifying FALSE will result in a maximum bid price specification (CPC).

Precaution

  • The enhancedCpcEnabled is required to be set after v11. You must specify enhancedCpcEnabled as FALSE, even when updating the max bid price (CPC) value in an existing campaign or ad group.

  • When getting information for campaigns and ad groups that use "Enhanced CPC (eCPC)" in versions before v10, the bid strategy appears as "UNKNOWN."

6. Remove the destination URL field

Removed the destination URL field because ads with the destination URLs are no longer available after November 2022.

Services

AdGroupAdService
ReportDefinitionService

Description

  • Removed url from AdGroupAdService.

  • Removed "URL_ID (destination URLID)" and "URL_NAME (destination URL)" from the ReportDefinitionService report fields.

7. Change on reporting item name

We have changed the field names to unify the names of report items in Yahoo! JAPAN Ads Search Ads API and Yahoo! JAPAN Ads Display Ads API. The existing fields are still available but will be discontinued. Use the new fields.

Services

ReportDefinitionService

Description

Added the following fields. The available values for each field are the same as the existing fields on the right.

New added fieldsThe existing fields (to be discontinued)
BUDGET_LOST_IMPRESSION_SHARE IMPRESSION_SHARE_BUDGET_LOSS
CLICKS CLICK
VIEWABLE_CLICKS VIEWABLE_CLICK
CAMPAIGN_START_DATE START_DATE
CAMPAIGN_END_DATE END_DATE
CITY CITY_NAME
PREFECTURE PREF_NAME
PREFECTURE_ID PREF_ID
WARD WARD_NAME

8. Removed unavailable bid strategy

Removed unavailable bid strategy "AUTO" and "NONE."

Services

CampaignService
AdGroupService

Description

In the CampaignServiceBiddingStrategyType, the following was removed.

  • AUTO (autobidding)

  • NONE (no bid strategy specified)

9. Support for specifying character encoding for history files

When creating a history file, specifying the character encoding become available.

Services

AuditLogService（add）

Description

Added encoding to the request field. The character encoding you can specify is SJIS or UTF8.

10. Maintenance release

  • Support narrowing searches by AdType
    Added adTypes to AdGroupAdService(get) and GuaranteedAdGroupAdService(get) requests.

  • Removed ad type information from placement list URL suggestions
    Removed AdFormat from the PlacementUrlIdeaService request and response.

The release of a Client Library for Java users

We will release the v11 version of the Yahoo! JAPAN Ads API Client Library for Java users, supporting Spring Framework series 5 and 6. See the following announcement for details.
Yahoo! JAPAN Ads API v11 released

Display Ads API v9 Sunset

Display Ads API v9 is scheduled to sunset as follows.

  • Support end date: June 26, 2023 (Mon)

  • End of life date: October 23, 2023 (Mon)

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

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

Developer Center

Related sites: