Yahoo! JAPAN Ads API | Developer Center

2021/08/17

Yahoo! JAPAN Ads API v6 release

Document Number: APIE-FY21-2208


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


1. Product:
　Yahoo! JAPAN Ads Search Ads API
　Yahoo! JAPAN Ads Display Ads API

2. Version released:
　V6

3. Schedule:
　September 13, 2021 (Mon)
　*This date is subject to change.

4. Changes on Search Ads API:
　■The new Auto Bidding Type
　The name and type will change on the auto bidding (standard bidding)
　that can be set for campaign type.
　We will abolish the setting of upper and lower bid prices.
　*These changes are provided on the Campaign Management Tool in advance.
　See the following announcement.
　　Search Ads New auto bidding type

　Along with these change, CampaignService will have following updates:
　・Add MAXIMIZE_CONVERSIONS_VALUE to biddingStrategyType
　・Add biddingScheme.maximizeConversionsBiddingScheme and
　　biddingScheme.maximizeConversionsValueBiddingScheme
　・bidCeiling and bidFloor will become unavailable

　■Output items on reports
　Some output items on reports will change.
　Check the change detail on the following document.
　　ReportDefinitionService v6 Migration Guide
　　
　Also note that reportIncludeZeroImpressions will become unavailable
　on v6 and later. Because items without impressions are also output
　together, the output data will become large and an error may occur.
　To output only the items with impressions on v6 or later version to
　the report, set the items such as imps to 1 or more in the filtering
　condition.

　■Operation history of automated rules　
　The operation history generated by using the automated rules (only
　available on the Campaign Management Tool) will become available
　available on operation history of Search Ads API.
　It will be available when specifying "ALL" on AuditLogService.
　All available API versions including v6 support this feature.

5. Changes on Display Ads API:
　■Select conversions used for ad delivery optimization by campaign
　You will be able to select conversion settings or conversion groups
　to use for optimization by each campaign.
　We will make another announcement for details of this change.
　Along with this change, there will be the following updates.
　・Add a new ConversionGroupService
　・Add the following fields to ConversionTrackerService:
　　- excludePreviousConversion that is a flag to exclude the current
　　　conversion information including old tag in GET request
　　- isPreviousConversion that is a flag to indicate whether the
　　　response contains the current conversion information including
　　　old tag
　・Add conversionTracker field to the following services:
　　- CampaignService
　　- GuaranteedCampaignService
　　- GuaranteedReservationService

　■Linked data type of custom list
　The data type that can link on custom list will become available.
　We will make another announcement for the detail of this change.

　■Analytics of content keyword targeting
　Getting analytic information of content keyword targeting will become
　available.
　Along with this change, "Content keyword" will be added as a statsType
　of StatsService

　■Avg. CPM and Average vCPM
　Getting Avg. CPM and Average vCPM will be available on analytics.
　Along with this change, "avgCpm" and "avgVcpm" will become available
　on StatsService.

　■Auto bidding type "Maximize conversions" and "Maximize clicks"
　* This function is being tested only for some accounts.
　Only target accounts can use this feature.
　You'll be able to set up a bid strategy that automatically adjusts
　your bid to maximize conversions or clicks within your budget.
　Along with this change, there will be the following updates.
　・Add MAX_CV, MAX_CLICK, MAX_VIEW, MAX_VIMPS to campaignBiddingStrategyType
　　- AdGroupService
　　- CampaignService
　・Add MAX_CV, MAX_CLICK, MAX_VIEW, MAX_VIMPS to accountAuthority of
　AccountAuthorityService

　■Operation history of automated rules
　The operation history generated by using the automated rules (only
　available on the Campaign Management Tool) will become available on
　operation history of Display Ads API.
　It will be available when specifying "ALL" on AuditLogService.
　*This feature is already available. All available API versions
　including v6 support this feature.

　■End of YDN support
　There will be the following changes on Display Ads (YDN).
　・CampaignMigrationService will become unavailable.
　・Following fields will become unavailable on CampaignService
　　- adProductType
　　- biddingStrategy
　　- conversionOptimizer
　　- frequencyCap
　　- type
　・Following fields will become unavailable on AdGroupService
　　- bid
　　- conversionOptimizer
　　- dynamicImageExtensions
　　- smartDeviceCarriers
　・"bid" field will become unavailable on AdGroupAdService
　・Following items will become unavailable on AdGroupTargetService
　　- INTEREST_CATEGORY and CARRIER_TARGET of targetType
　　- carrierTarget and interestCategoryTarget fields
　・actions of etInterestCategory on DictionaryService will become
　　unavailable
　・Behavior of RecommendationService will change as follows:
　　- Specifying MIGRATE_TO_YDA on types of request will become unavailable
　　- MIGRATE_TO_YDA will not return on recommendation.type of response
　　- MIGRATE_TO_YDA will not return on recommendation.migrateToYda of
　　response

　■Maintenance release
　Supports narrowing down campaigns and ad groups based on budget
　amount and bid price.
　- Narrowing down by campaign, budget amount
　- Narrowing down by a group bid amount
　Along with this change, there will be the following updates:
　- Add budgetAmountRange to CampaignService
　- Add biddingValueCpcRange to AdGroupService

6. Remarks:
　・More details will be available on the release note and reference
　　document provided on the new version release.
　・We will hold an online seminar to give an overview of v5 along with
　　the release. We will make another announcement for the detail of
　　this change.

7. Yahoo! JAPAN Ads API v4 Sunset:
　Yahoo! JAPAN Ads API v4 sunset is scheduled as follows.
　　Deprecation date: October 20, 2021 (Wed)
　　End of Life Date : February 24, 2022 (Thu)

　Yahoo! JAPAN Ads API v3 will also end on the following scheduled date
　as previously announced in "Yahoo! JAPAN Ads API v5 released (Document
　Number: APIE-FY21-2154)."
　　
　　End of life date: October 20, 2021 (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