Yahoo! JAPAN Ads API | Developer Center
日本語Search Ads API v13 Release Note
Version released
v13
Date
February 19, 2024
Changes on Yahoo! JAPAN Ads Search Ads API
More about objects and other details are described in the reference document.
1. Asset combinations report
We support the report to check the number of your ads shown for each asset combination delivered in Responsive Search Ads. The applied assets are as follows:
- Title
- Description
- Ad display options (*)
It will be available in March 2024. See the following announcement for details.
Asset combinations report will be available
*Ad display options will be renamed to "Ad display assets." See the announcement for details.
Services
ReportDefinitionService
Changes
Added ASSET_COMBINATIONS to reportType.
Notes
The fields (report output items) must specify all assets to be output (title, description, and ad display options).
Example of report output
No | Title1 | Title2 | Description 1 | Description 2 | impressions |
---|---|---|---|---|---|
1 | aaa | bbb | eeeee | fffff | 1000 |
2 | aaa | bbb | eeeee | ggggg | 1200 |
3 | aaa | ccc | eeeee | fffff | 1500 |
*When "Description 2" is not specified as an output item, it appears that the same combination of No.1 and No.2 is output on two separate lines, but the combinations are different.
2. Image assets
We support a new ad display option (*), "Image assets." Image assets can add images to Search Ads. It will be available in April 2024. See the following announcement for details.
Image assets will be available
*Ad display options will be renamed to "Ad display assets." Learn more
Services
AssetService (add, get)
CampaignAssetService (get, replace)
AdGroupAssetService (get, replace)
CampaignExportService (add)
AuditLogService
ReportDefinitionService
Changes
- IMAGE (image asset) was added to Type of AssetService (add, get), CampaignAssetService (get, replace), and AdGroupAssetService (get, replace).
- Added "downloadImage" to AssetService (get). You can download image files added to image assets.
- Added IMAGE_ASSET (image asset) to the entityType of CampaignExportService (add)
- AuditLogService can get the change history of image assets.
- ReportDefinitionService can output image asset results with the following reportType:
reportType | Report types |
---|---|
CAMPAIGN_ASSET | (New) Ad display option report (campaign) |
ADGROUP_ASSET | (New) Ad display option report (ad group) |
ASSET_COMBINATIONS | Asset combinations report *These reports will be available in the future. |
3. Seasonality bid adjustment
You can specify a campaign ID when getting seasonality bid adjustment information.
Services
BiddingSeasonalityAdjustmentService (get)
Changes
You can specify a campaign ID when making a get request.
4. End of data auto insertion list
We removed performance reports and services that receive data assignment lists due to the end of the data auto insertion list. This change applies to versions before v12. Find more details, including the end date, in this announcement.
End of extended text ads and data assignment list
ReportDefinitionService (add)
FeedItemService (get)
FeedService (get)
Changes
- Removed "FEED_ITEM" (Ad display option report) from reportType of ReportDefinitionService (add).
- Removed FeedItemService(get) and FeedService(get).
5. Maintenance
Changed ENUM value for RetargetingListService
Changed the ENUM value "REFFER_URL" in the RetargetingListServiceUrlRuleKey to "REFER_URL."
Improvement of field "startIndex"
In KeywordPlanIdeaService (get), the field name "startIndex" was changed to "pageIndex." *The field name "startIndex" remains the same for other services other than KeywordPlanIdeaService (get). The descriptions of startIndex, pageIndex, and numberResults after the changes are as follows:
Field name | Description |
---|---|
startIndex | The position in the result set to start fetching. Specify 1 or greater. |
pageIndex | Index at the top of the page. Specify 1 or greater. |
numberResults | The number of results to be retrieved from the start position. Specify 1 or greater. *The name numberResults remains the same, but descriptions of references, etc. will change. It became available for services that specify startIndex and pageIndex. |
*This improvement only changes the field name and doesn't change the behavior of the Search Ads API.
API Webinar information
We will hold an online seminar to give an overview of v13 along with the release. See the following announcement for details.
Yahoo! JAPAN Ads API Webinar
End of Search Ads API v11
Yahoo! JAPAN Ads Search Ads API v11 will end with the following schedule:
Support end date: March 13, 2024
End of life date: June 12, 2024
Yahoo! JAPAN Ads Search Ads API v10 will end with the following schedule:
End of life date: March 13, 2024
*Support for this version has already ended.