Yahoo! JAPAN Ads API | Developer Center
日本語2021/12/15
Yahoo! JAPAN Ads API v7 release
Document Number: APIE-FY21-2299
Dear customers,
Thank you for using Yahoo! JAPAN Ads.
We will release a new version for Yahoo! JAPAN Ads API.
Learn more details in the following section.
1. Product:
Yahoo! JAPAN Ads Search Ads API
Yahoo! JAPAN Ads Display Ads API
2. Version released:
v7
3. Schedule:
January 17, 2022 (Mon)
*This date is subject to change.
4. Changes on Search Ads API:
■Bid strategy renaming
Names on bid strategy change.
・Services that will have change:
CampaignService
BiddingStrategyService
KeywordForecastMetricsService
KeywordEstimatorService
AdGroupWebpageService
AdGroupCriterionService
AdGroupService
These services will have following change on their names.
*Describing as "old name → new name"
・ENUM
MANUAL_CPC → CPC
TARGET_SPEND → MAXIMIZE_CLICKS
・Field
manualCpcBiddingScheme → maximizeClicksBiddingScheme
targetSpendBiddingScheme → maximizeClicksBiddingScheme
maxCpc → cpc
adGroupMaxCpc → adGroupCpc
keywordMaxCpc → keywordCpc
■Changes of final URL
There will be renaming and removing fields related to the final URL.
・Services that will have change:
AdGroupAdService
AdGroupCriterionService
Following fields will be removed from the services.
additionalAdvancedMobileUrls
additionalAdvancedUrls
Following names will change on the services.
*Describing as "old name → new name"
advancedUrl → finalUrl
advancedMobileUrl → smartphoneFinalUrl
reviewAdvancedUrl → reviewFinalUrl
reviewAdvancedMobileUrl →reviewSmartphoneFinalUrl
■Subdivision of conversion tracking purpose
ConversionTrackerServiceCategory will be added and renamed to
subdivide the conversion tracking purposes.
It will be available around the spring of 2022.
More details will be announced later.
■New ad display options
This new version supports the new ad display options.
It will be available around the spring of 2022.
See the following release note for more detail.
[Search Ads] New format of Ad Display Options
Along with this enhancement, the following services will be added.
・AssetService / add, get, set, setTrademarkStatus
・AdGroupAssetService / get, set, replace
・CampaignAssetService/ get, set, replace
The FeedItemService provided in v6 and earlier versions will be
discontinued in the future.
We will inform you of the end of service schedule later.
■Format of site retargeting tag
We will change the format of renewed site retargeting tag that can
be acquired by advancedSnippet of RetargetingListService/get to
the format including site retargeting tags that is common to the
Campaign Management Tool.
■Improving response (for all available versions)
If a duplicate of an existing ad item such as a campaign or keyword
is found when you add, the ID of the existing ad item that is
duplicated will be responded in addition to the error code.
This makes it easier to find existing items that are subject to
duplication. This change will be applied to all versions.
・ID that is responded to when it overlaps with the target service:
CampaignService campaignId
AdGroupService adGroupId
AdGroupAdService adId
AdGroupCriterionService criterionId
5. Changes on Display Ads API:
■Bid strategy renaming
Names on bid strategy change.
Along with this change, there will be the following updates.
・Services that will have change:
CampaignService
AdGroupService
GuaranteedCampaignService
GuaranteedInventoryService
GuaranteedReservationService
RecommendationService
These services will have following change on their names.
*Describing as "old name → new name"
・ENUM
MAX_CPC → CPC
MAX_CPV → CPV
MAX_VCPM → VCPM
MAXIMIZE_VIEW → MAXIMIZE_VIDEO_VIEWS
MAXIMIZE_VIEABLEIMPRESSIONS → MAXIMIZE_VIEWABLE_IMPRESSIONS
・Field
maxCpcBidValue → cpcBidValue
maxCpvBidValue → cpvBidValue
maxVcpmBidValue → vcpmBidValue
currentMaxCpcBidValue → currentCpcBidValue
■Campaign Delivery duration Time specification
Specifying the time becomes available when setting the campaign's
ad delivery duration (start/end).
*These changes are provided on the Campaign Management Tool in
advance.
See the following release note for more detail.
[Display Ads] Campaign Delivery duration time specification
Along with this change, there will be the following updates.
・Services that will have change:
CampaignService
GuaranteedCampaignService
GuaranteedSimulationService
GuaranteedInventoryService
Following fields will be added on the services.
campaign/startTime
campaign/endTime
guaranteedSimulation/startTime
guaranteedSimulation/endTime
guaranteedInventory/startTime
guaranteedInventory/endTime
■Additional campaign goal and campaign delivery type
(for all available versions)
We will add a new campaign goal and a campaign delivery type.
This change is for all available versions and it has already become
available on v5 and v6.
*These feature will be available for limited users.
See also the following information. (Japanese version)
Yahoo! JAPAN Sales Promotion
・Services that will have change:
CampaignServcie
ReportDefinitionService
AccountAuthorityService
・Campaign goal to be added:
PayPay gift (PAYPAY_GIFT)
・Campaign delivery type to be added:
Sales promotion (SALES_PROMOTION)
■Audience management feature
It supports the audience management feature to utilize the client
data and the audience data of Yahoo! JAPAN.
*These changes are provided on the Campaign Management Tool in
advance.
See the following release note for more detail.
[Yahoo! JAPAN Ads] Audience management feature release
Along with this change, there will be the following updates.
・RetargetingListService will be renamed to AudienceListService.
・Specifying the following audience list type will become available
by AudienceListService.
Website visitors (WEBSITE_VISITORS)
Customer data (CUSTOMER_DATA)
・Some field names in services will be renamed.
*Describing as "old name → new name"
-Services that will have change:
AccountLinkService
-Field name that will change:
retargetingListSharingEnabled → audienceListSharingEnabled
-Services that will change:
AdGroupTargetService
StatsService
GuaranteedInventoryService
GuaranteedSimulationService
-Field name that will change:
targetListDeliverType → deliverType
targetListName → audienceListName
siteRetargetingTarget → audienceListTarget
Change the following from Enum that can be specified by targetType.
SITE_RETARGETING → AUDIENCE_LIST_TARGET
-Services that will change:
ReportDefinitionService
-Field name that will change:
Change the following from Enum that can be specified by targetType.
SITE_RETARGETING → AUDIENCE_LIST_TARGET
■Full HD size and HD size
Full HD size and HD size operations will be supported for videos on
ads.
Along with this change, VideoService will have the following change.
・Following fields to distinguish whether full HD size and HD size
videos can be downloaded with VideoService/get will be added.
video/videoSetting/extraSpecs[]
video/videoSetting/extraSpecs[].qualityType
FULLHD
HD
・Specifying full HD size and HD size videos by qualityType field of
VideoService/download will become available.
■Targeting setting status
Referring on/off status of each targeting setting will become
available by Display Ads API.
*This feature is already available on the Campaign Management Tool.
Along with this change, the new field "targetSetting" that shows
the status will be added on AdGroupTargetService.
■Conversion path report, cross-campaign reaches report
Conversion path report will support showing paths by each ad group.
Some report items will be renamed and added.
*This feature will become available on the Campaign Management Tool
in advance.
See the following release note for more detail.
[Display Ads] Conversion path report and cross-campaign reach report change
Along with this change, there will be the following updates.
・Following items will be added to the reporting items returned by
ReportDefinitionService.
-Conversion path report
CLICK_AND_VIDEO_CONVERSIONS_FOR_CONVERSION_PATH
CLICK_CONVERSIONS_FOR_CONVERSION_PATH
VIEW_THROUGH_CONVERSIONS_FOR_CONVERSION_PATH
TOUCHPOINT_1_ADGROUP（~TOUCHPOINT_20_ADGROUP）
-Cross-campaign reach report
UNIQUE_USERS_WITH_VIEW_THROUGH_CONVERSIONS
UNIQUE_USERS_WITH_CLICK_CONVERSIONS
UNIQUE_USERS_WITH_CLICK_AND_VIDEO_CONVERSIONS
・Following ENUM will be added on conversionPathFilterType of
ReportDefinitionService.
ADGROUP_NAME
ADGROUP_ID
6. Remarks:
・More details will be available on the release note and reference
document provided on the new version release.
7. Yahoo! JAPAN Ads API v5 Sunset:
Yahoo! JAPAN Ads API v5 sunset is scheduled as follows.
Deprecation Date: February 24, 2022 (Thu)
End of life date: June 8, 2022 (Wed)
Yahoo! JAPAN Ads API v4 will also end on the following scheduled date
as previously announced in "Yahoo! JAPAN Ads API v6 released
(Document Number: APIE-FY21-2235)."
End of Life Date : February 24, 2022 (Thu)
*We have ended the user support for this version already.
If you have any questions, please contact us.
Sincerely,
Yahoo! JAPAN API support team