Yahoo! JAPAN Ads API | Developer Center
日本語2022/04/19
Yahoo! JAPAN Ads API v8 release
Document Number: APIE-FY22-2204
Dear customers,
Thank you for using Yahoo! JAPAN Ads.
We will release a new version for Yahoo! JAPAN Ads API. Please see the
following details.
1. Product:
Yahoo! JAPAN Ads Search Ads API
Yahoo! JAPAN Ads Display Ads API
2. Version released:
v8
3. Schedule:
May 16, 2022 (Mon)
*This date is subject to change.
4. Changes on Search Ads API:
■Adding features on Responsive Ads for Search
We will add the Ad Customizer on Responsive Ads for Search. Also,
we will add the output actual performance values by each asset on
the performance report.
It will be available around the summer of 2022. See the following
release note for more detail.
[Search Ads] adding features on Responsive Ads for Search and end
of adding ads of Extended Text Ads
Along with this change, there will be the following updates.
・Added the following services
- CustomizerAttributeService
- AccountCustomizerService
- CampaignCustomizerService
- AdGroupCustomizerService
- AdGroupCriterionCustomizerService
・Output the operation history of Ad Customizer for Responsive Ads
for Search on AuditLogService.
・RAS_ASSET_REPORT will be added to reportType of
ReportDefinitionService.
■New conversion tracking purpose (v7, v8)
The new conversion tracking purpose will become compatible with
all conversions such as web pages.
It will be available on May 18th, 2022 (Wed). See the following
release note for more detail.
[Search Ads] New conversion tracking purpose and reports
Along with this change, you will be able to select a new conversion
tracking purpose when setting a new conversion tracking on v7 and
v8.
There will be the following updates on
ConversionTrackerServiceCategory of v8.
・QUALIFIED_LEAD and CONVERTED_LEAD will be added.
・IMPORTED_LEAD will be deleted.
*Although IMPORTED_LEAD will remain on v7, you will not be able
to use.
The Existing conversion tracking purposes will not be available on
v6 and lower versions.
■The new option will become available for the duration of report
creation
The new option "This Month (excluding today)" will become available
for the duration of report creation. Along with this change,
THIS_MONTH_EXCEPT_TODAY will be added to reportDateRangeType of
ReportDefinitionService.
■Search Ads Dynamic Ads for Search new page feed
We will start Dynamic Ads for Search page feed in a new format on
Search Ads. It will be available around July 2022. See the following
release note for more detail.
Search Ads Dynamic Ads for Search New page feed
・Added the following services
- PageFeedAssetSetService
- PageFeedAssetService
・PageFeedAssetSetIds will be added to dynamicAdsForSearchSetting
of CampaignService.
The FeedService and PageFeedItemService provided in v7 and earlier
versions will be discontinued on September, 2022.
5. Changes on Display Ads API:
■Geo targeting enhancement
Target radius will become 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
Along with this change, the new fields will be added to the
following services.
・AdGroupTargetService (get)
- areaSearchTypes
- sortField
- sortType
・AdGroupTargetService (add, set, replace)
・StatsService (get)
- areaSearchType
- latitudeInMicroDegrees
- longitudeInMicroDegrees
- radius
- description
■Provision of Display Ads (Guaranteed) to agencies prepaid
Along with the provision of Display Ads (Guaranteed) to agencies
prepaid, there will be the following updates.
Services
・BalanceService
The field to indicate estimated cash balance will be added.
・GuaranteedSimulationService and GuaranteedReservationService
price which indicates the amount of payment will be added to
lifetimeBudget.
・GuaranteedCampaignService
price which indicates the amount of payment to the estimated
results of a Display Ads (Guaranteed) campaign will be added.
■Change of age targeting features
The definition of adult age changed to "18 years old." Along with
this change, we will change 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
Along with this change, there will be the following updates.
Services
・AdGroupTargetService
・GuaranteedSimulationService
・GuaranteedInventoryService
・StatsService
We will change some of the age groups in age targeting as follows
・ENUM value "GT_RANGE_15_19" will be replaced with
"GT_RANGE_18_19."
・The previous age groups will change to ENUM values prefixed with
"OLD_."
■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 will be 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
Along with this change, there will be the following updates.
Services
ReportDefinitionService
・MODEL_COMPARISON which indicates Attribution model comparison
report will be added to reportType.
・modelComparisonReportCondition will be added to
reportTypeCondition.
・MODEL_COMPARISON will be added to the report type specified at
getReportFields.
■Changing the period of the performance data
The period for the performance data selected in the Campaign
Management Tool has been extended to 25 months in the past. Along
with this change, there will be the following updates.
Services
・ConversionTrackerService
・StatsService
- 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)" cannot be specified for statsPeriod.
■A new user list will be available for some Display Ads (Guaranteed)
products
A new user list will be available for audience list targeting for
some Display Ads (Guaranteed) products.
Along with this change, there will be the following updates.
Services
・AdGroupTargetService
・GuaranteedInventoryService
・GuaranteedReservationService
・GuaranteedAdGroupService
・GuaranteedSimulationService (Only getPackage method)
audienceListType which indicates audience list type will be added
to audienceListTarget for the above services.
■Changes on the period of Performance Report
We will add the new period to the performance report. Also, we will
change the behavior of an existing period.
Services
・ReportDefinitionService
- 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" will be
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".
■Maintenance release
・We will delete currently unused fields from StatsService.
・NOT_IN will be added to filterOperator of
ReportDefinitionService.
・We will add an error OVER_COUNT_ERROR to AuditLogServiceJobStatus
when the number of operations is too large to output the
operation history.
6. Changes on the client library for Java users:
"API Client Implementation" and "Service Layer Implementation" have
been added to the library including request and response entities of
Yahoo! JAPAN Ads API published for Java users.
This eliminates the need for users to manage tokens and API requests,
which previously had to be implemented on the user side, and enables
more efficient development of services using Yahoo! JAPAN Ads API.
Learn more details on the following pages.
https://github.com/yahoojp-marketing/ads-display-api-java-lib
https://github.com/yahoojp-marketing/ads-search-api-java-lib
There is also an example of actually using the sample program as
follows.
https://github.com/yahoojp-marketing/ads-display-api-java-samples
https://github.com/yahoojp-marketing/ads-search-api-java-samples
7. Remarks:
More details will be available on the release note and reference
document provided on the new version release.
8. Yahoo! JAPAN Ads API v6 Sunset:
Yahoo! JAPAN Ads API v6 sunset is scheduled as follows.
Deprecation date: June 8, 2022 (Wed)
End of life date: September 13, 2022 (Tue)
Yahoo! JAPAN Ads API v5 will also end on the following scheduled date
as previously announced in "Yahoo! JAPAN Ads API v7 released
(Document Number: APIE-FY21-2312)."
End of life date: June 8, 2022 (Wed)
*We have ended the user support for this version already.
If you have any questions, please contact us.
Sincerely,
Yahoo! JAPAN API support team