Search Ads API v16 Release Note

Version released

v16

Date

February 17, 2025

Key points of this release

*Learn more about objects, etc. in the reference document.
Reference Document

1. Favicon assets

"Favicon assets" that will allow advertisers to show a logo (company logos, brand logos) in Search Ads to indicate the content of the company's website is available. You can use the feature only after the release. See the following announcement for details.
Favicon assets will be available

Services

  • AssetService
  • CampaignAssetService
  • CampaignExportService

Changes

  • Add Enum value "FAVICON" to assetData.type of AssetService and type of CampaignAssetService.
    *In versions prior to v15, when retrieving the entire case with get, the favicon asset entity will be returned as "UNKNOWN."
  • Add the field "faviconAsset" to the assetData of the AssetService.
  • Add the Enum value "FAVICON_ASSET" to the entityType of the CampaignExportService.
    *In versions prior to v15, if entityType is ALL or null, the favicon asset entity will also be returned.

2. Shopping Search Ads reports

Shopping Search Ads reports available from Yahoo! JAPAN Ads Search Ads API.

Services

  • BaseAccountService/get
  • SsaAccountService/get
  • SsaReportDefinitionService/get, add, remove, getReportFields, download

Changes

  • Followings changed in BaseAccountService/get.
    • Search Ads (Shopping) account are available.
    • Add includeSsaAccount to request. The default value for this field is EXCLUDE_SSA (Exclude Search Ads (Shopping) accounts).
  • Add new SsaAccountService/get. This web service allows you to get information about your Search Ads (Shopping) account.
  • Add new SsaReportDefinitionService /get, add, remove, getReportFields, download. This web service allows users to get reports for Search Ads (Shopping) accounts. Available reports are as follows:
    • Account report
    • Campaign report
    • Ad group report
    • Product group report
    • Product report
    • Search query report
      *Reports other than those listed are not provided by the Search Ads API.

Notes

  • The following report items, which are available from the Campaign Management Tool, are not available from the Search Ads API.
    • Search absolute top lost impression share (budget)
    • Search absolute top lost impression share (rank)
  • Although SaReportDefinitionService is classified as a reporting API, even if the maximum number of reporting APIs is changed by changing the QPS, SaReportDefinitionService remains unchanged at "up to 5 reports/sec." Learn more about "Request Restrictions (QPS)."
    Learn more

3. Maintenance

Remove maxItems (maximum number) in some fields that specify Enum values. The fields we removed maxItems are as follows:

Services Fields that removed maxItems
AccountCustomizerService types
AccountLinkService accountStatuses
AccountManagementService
  • accountTypes
  • accountStatuses
AdGroupService userStatuses
AdGroupAdService
  • adTypes
  • approvalStatuses
  • userStatuses
AdGroupAssetService
  • types
  • userStatuses
AdGroupBidMultiplierService platformTypes
AdGroupCriterionService
  • approvalStatuses
  • userStatuses
AdGroupCriterionCustomizerService types
AdGroupCustomizerService types
AssetService
  • types
  • approvalStatuses
AuditLogService jobStatuses
BaseAccountService accountStatuses
BiddingSeasonalityAdjustmentService
  • devices
  • campaignIds
BiddingStrategyService biddingStrategyTypes
CampaignService userStatuses
CampaignAssetService
  • types
  • userStatuses
CampaignCustomizerService types
CampaignExportService
  • adGroupAdApprovalStatuses
  • adGroupAdUserStatuses
  • adGroupCriterionApprovalStatuses
  • adGroupCriterionUserStatuses
  • adGroupUserStatuses
  • campaignUserStatuses
  • entityTypes
  • jobStatuses
CampaignTargetService
  • platformTypes
  • targetTypes
ConversionTrackerService
  • categories
  • conversionCountingTypes
  • conversionTrackerTypes
  • excludeFromBiddings
  • statuses
  • trackingCodeTypes
CustomizerAttributeService types
LearningDataExclusionService devices
PageFeedAssetService approvalStatuses
RetargetingListService targetListTypes

Comments

We will hold an online seminar to give an overview of API v16 along with the release. See the following announcement for details.
Yahoo! JAPAN Ads API Webinar March 2025

End of Search Ads API v14

Search Ads API v14 will end with the following schedule:

  • Support end date: March 10, 2025
  • End of life date: End of July, 2025 (scheduled)
    *Wait for further announcements with detailed schedules.

Search Ads API v13 will end with the following schedule:

  • End of life date: March 10, 2025
    *Support for this version has already ended.