Yahoo! JAPAN Ads API | Developer Center

Display Ads API v8 Release Note

Release version

v8

Release date

May 16, 2022 (Mon)

Main Contents of this release

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

1. Geo targeting enhancement

Target radius became available to specify the target location on geo targeting feature.
*These changes were provided on the Campaign Management Tool in advance.
See the following release note for more detail.
[Display Ads (Auction)] Geo Targeting enhancement

Service
AdGroupTargetService（get）
　・areaSearchTypes
　・sortField
　・sortType
AdGroupTargetService（add、set、replace）
StatsService（get）
　・areaSearchType
　・latitudeInMicroDegrees
　・longitudeInMicroDegrees
　・radius
　・description
AdGroupTargetService（get）
　・areaSearchTypes
　・sortField
　・sortType
AdGroupTargetService（add、set、replace）
StatsService（get）
　・areaSearchType
　・latitudeInMicroDegrees
　・longitudeInMicroDegrees
　・radius
　・description

2. Provision of Display Ads (Guaranteed) to agencies prepaid

Along with the provision of Display Ads (Guaranteed) to agencies prepaid, there are the following updates.

Services
BalanceService
GuaranteedSimulationService
GuaranteedReservationService
GuaranteedCampaignService

Description
・BalanceService
　The field to indicate estimated cash balance was added.
・GuaranteedSimulationService and GuaranteedReservationService
　price which indicates the amount of payment was added to lifetimeBudget.
・GuaranteedCampaignService
　price which indicates the amount of payment to the estimated results of a Display Ads (Guaranteed) campaign was added.

3. Change of age targeting features

The definition of adult age changed to "18 years old." Along with this change, we changed some of the age groups in age targeting.
*These changes were provided on the Campaign Management Tool in advance. See the following release note for more detail.
[Display Ads] Change of Age Targeting features

Service
AdGroupTargetService
GuaranteedSimulationService
GuaranteedInventoryService
StatsService

Remarks
We changed some of the age groups in age targeting as follows.
・ENUM value "GT_RANGE_15_19" was replaced with "GT_RANGE_18_19."
・The previous age groups changed to ENUM values prefixed with "OLD_."

4. Attribution model comparison report

The attribution model comparison report which provides visibility to the credits of campaigns and ad groups that have contacted users to conversions that occur under your account was added.
*These changes were provided on the Campaign Management Tool in advance. See the following release note for more detail.
Attribution model comparison report starts

Services
ReportDefinitionService

Description
・MODEL_COMPARISON which indicates Attribution model comparison report was added to reportType.
・modelComparisonReportCondition was added to reportTypeCondition.
・MODEL_COMPARISON was added to the report type specified at getReportFields.

5. A new user list will be available for some Display Ads (Guaranteed) products

A new user list is available for audience list targeting for some Display Ads (Guaranteed) products.

Services
AdGroupTargetService
GuaranteedInventoryService
GuaranteedReservationService
GuaranteedAdGroupService
GuaranteedSimulationService (Only getPackage method)

Description
audienceListType which indicates audience list type was added to audienceListTarget for the above services.

6. Reporting duration expand for performance data

We added the new duration to the performance report and changed the behavior of the existing duration.
・The duration that can be specified has been changed from the past 25 months to the past 37 months.

Services
ReportDefinitionService

Description
・The new ENUM value "THIS_MONTH_EXCEPT_TODAY (all days in the current month not including today)" to ReportDateRangeType.
・Starting with v8, the existing ENUM value "THIS_MONTH" was changed from "this month excluding today" to "this month including today."
・In v7 and the lower versions, "THIS_MONTH" remains the same as "current month excluding today".
・The duration that can be specified has been changed to the past 37 months.

Remarks
・The following reports can only be generated for the past 25 months as before.
　・Conversion path report
　・Cross-campaign reach report
　・Attribution model comparison report
・When specifying "Full year (GUARANTEED_CAMPAIGN_PERIOD)" for the reporting duration for the reach report, the data for the past 25 months is aggregated as before.

7. Changing the period of the performance data

A new user list is available for audience list targeting for some Display Ads (Guaranteed) products.

Services
ConversionTrackerService
StatsService

Description
・The ENUM value "REALTIME_LAST25MONTH (past 25 months, including today)" can be specified in statsPeriod.
・The ENUM value "DEFINITE_VALUE_LAST25MONTH (for the past 25 months)" can't be specified for statsPeriod.

8. Maintenance release

System updates have been made for the following services.

Services
・StatsService
　Fields that are not currently used have been removed.
・ReportDefinitionService
　NOT_IN was added to filterOperator.
・AuditLogServiceJobStatus
　An error OVER_COUNT_ERROR which occurs when the number of operations is too large to output the operation history was added.

Display Ads API v6 Sunset

Display Ads API v6 is scheduled to sunset as follows.
　　・Deprecation date: June 8, 2022 (Wed)
　　・End of life date: September 13, 2022 (Tue)

Display Ads API v5 is scheduled to sunset as follows.
　　・End of life date: June 8, 2022 (Wed)
　　*We have ended the user support for this version already.