Yahoo!広告 検索広告 API v16 リリースノート

リリースバージョン

v16

リリース日

2025年2月17日(月)

本リリースの主な内容

※オブジェクトなどの詳細は、リファレンスをご確認ください。

1. 「ファビコンアセット」に対応

検索広告に広告主様ご自身でサイトの内容を示すロゴ(企業ロゴ・ブランドロゴなど)を設定できる「ファビコンアセット」に対応しました。実際に利用可能になるのは機能のリリース後です。提供スケジュールや機能の詳細は、以下のお知らせを参照してください。
【検索広告】ファビコンアセットの提供開始について

対象ウェブサービス

  • AssetService
  • CampaignAssetService
  • CampaignExportService

変更内容

  • AssetServiceのassetData.typeとCampaignAssetServiceのtypeにEnum値「FAVICON」を追加しました。
    ※v15以前のバージョンにおいてgetで全件取得した場合、ファビコンアセットのエンティティは「UNKNOWN」と返却されます。
  • AssetServiceのassetDataにフィールド「faviconAsset」を追加しました。
  • CampaignExportServiceのentityTypeにEnum値「FAVICON_ASSET」を追加しました。
    ※v15以前のバージョンで、entityTypeにALLを指定、またはnullにした場合は、ファビコンアセットのエンティティも返却されます。

2. 検索連動型ショッピング広告のレポート取得に対応

検索連動型ショッピング広告のレポートがYahoo!広告 検索広告 APIで取得可能になりました。

対象ウェブサービス

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

変更内容

  • BaseAccountService/getにおいて以下のとおり変更しました。
    • 検索広告(ショッピング)アカウントの取得が可能になりました。
    • requestにincludeSsaAccountを追加しました。この項目の初期値はEXCLUDE_SSA(検索広告(ショッピング)アカウントを除外)です。
  • SsaAccountService/getを新設しました。このウェブサービスでは検索広告(ショッピング)アカウントに関する情報を取得できます。
  • SsaReportDefinitionService /get, add, remove, getReportFields, downloadを新設しました。このウェブサービスでは検索広告(ショッピング)アカウントのレポートを取得できます。取得可能なレポートは以下のとおりです。
    • アカウントレポート
    • キャンペーンレポート
    • 広告グループレポート
    • 商品グループレポート
    • 商品レポート
    • 検索クエリーレポート
      ※上記以外のレポートは、検索広告 APIでは提供されません。

注意事項

  • 広告管理ツールで取得可能なレポート項目のうち、以下の項目は検索広告 APIからは取得できません。
    • ページ最上部のインプレッションシェア損失率(予算)
    • ページ最上部のインプレッションシェア損失率(ランク)
  • SsaReportDefinitionServiceはレポート系APIに分類されますが、QPS変更でレポート系API の上限数を変更しても、SsaReportDefinitionServiceは「最大5件/秒」のまま変更されません。リクエストの制約(QPS)上限について詳細はこちらを参照してください。

3. 保守改善

Enum値を指定する一部のフィールドにおいて、maxItems(上限数)を削除しました。maxItemsを削除したフィールドは以下のとおりです。

ウェブサービス 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

補足

Yahoo!広告 API v16の概要などをお伝えするオンラインセミナーを開催します。日程などの詳細は以下のお知らせをご確認ください。
Yahoo! JAPAN Ads API Webinar March 2025のご案内

検索広告 APIの提供終了バージョンについて

以下の日程で検索広告 API v14の提供を終了します。

  • サポート終了日:2025年3月10日(月)
  • システム終了日:2025年7月下旬(予定)
    ※日程が決まり次第お知らせいたします。

また、検索広告 API v13を以下の日程で終了します。

  • システム終了日:2025年3月10日(月)
    ※サポートは終了済みです。