検索広告 API v13 リリースノート

リリースバージョン

v13

リリース日

2024年2月19日(月)

本リリースの主な内容

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

1. アセット組み合わせレポートに対応

レスポンシブ検索広告において、アセットの組み合わせごとの表示回数を確認できるレポート出力に対応しました。対象のアセットは以下です。

  • タイトル
  • 説明文
  • 広告表示オプション(※)

実際に利用可能になるのは2024年3月を予定しています。機能の詳細は以下のお知らせを参照してください。
アセット組み合わせレポートの追加について

※今後、広告表示オプションは「広告表示アセット」に名称変更します。詳しくはこちらをご確認ください。

対象サービス

ReportDefinitionService

内容

reportTypeに「ASSET_COMBINATIONS」を新規追加しました。

注意事項

fields(レポートの出力項目)には、出力するアセット(タイトル、説明文、広告表示オプション)を全て指定する必要があります。

レポート出力の例

No タイトル1 タイトル2 説明文1 説明文2 インプレッション数
1 aaa bbb eeeee fffff 1000
2 aaa bbb eeeee ggggg 1200
3 aaa ccc eeeee fffff 1500

※「説明文2」を出力項目に指定しなかった場合、No.1とNo.2はまったく同じ組み合わせが2行に分かれて出力されるように見えますが、実際は異なる組み合わせです。

2. 画像アセットに対応

広告表示オプション(※)の1つとして提供する「画像アセット」に対応しました。画像アセットは検索広告に画像を追加して表示できる機能です。実際に利用可能になるのは2024年4月を予定しています。機能の詳細は以下のお知らせを参照してください。
画像アセットの提供開始について

※今後、広告表示オプションは「広告表示アセット」に名称変更します。詳しくはこちらをご確認ください。

対象サービス

AssetService(add, get)
CampaignAssetService(get, replace)
AdGroupAssetService(get, replace)
CampaignExportService(add)
AuditLogService
ReportDefinitionService

内容

  • AssetService(add, get)、CampaignAssetService(get, replace)、AdGroupAssetService(get, replace)のTypeにIMAGE(画像アセット)を追加しました。
  • AssetService(get)に「downloadImage」を追加しました。画像アセットに登録されている画像ファイルのダウンロードができます。
  • CampaignExportService(add)のentityTypeにIMAGE_ASSET(画像アセット)を追加しました。
  • AuditLogServiceで画像アセットに関する操作履歴が取得できるよう変更しました。
  • ReportDefinitionServiceにおいて、以下のreportTypeで画像アセットの実績を出力できるよう変更しました。
reportType レポートの種類
CAMPAIGN_ASSET (新)広告表示オプションレポート(キャンペーン)
ADGROUP_ASSET (新)広告表示オプションレポート(広告グループ)
ASSET_COMBINATIONS アセット組み合わせレポート
※今後提供予定のレポートです

3. 自動入札のスポット調整に関する改善

自動入札のスポット調整に関する情報を取得する際に、キャンペーンIDの指定が可能になりました。

対象サービス

BiddingSeasonalityAdjustmentService(get)

内容

GET時にキャンペーンIDを指定できます。

4. データ自動挿入リストの提供終了に伴う対応

データ自動挿入リストの提供終了に伴い、データ自動挿入リストのパフォーマンスデータを取得できるレポートや、入稿済みのデータ自動挿入リストを取得できるサービスを削除しました。なお、v12以前のバージョンにおいても、提供終了日以降は該当データの取得ができません。提供終了日などの詳細は、以下のお知らせをご確認ください。
拡大テキスト広告の入稿とデータ自動挿入リストの提供終了について

対象サービス

ReportDefinitionService(add)
FeedItemService(get)
FeedService(get)

内容

  • ReportDefinitionService(add)のreportTypeから「FEED_ITEM」(広告表示オプションレポート)を削除しました。
  • FeedItemService(get)およびFeedService(get)を削除しました。

5. 保守改善

RetargetingListServiceのENUM値の変更

RetargetingListService UrlRuleKeyのENUM値「REFFER_URL」を「REFER_URL」に変更しました。

フィールド「startIndex」の改善

KeywordPlanIdeaService(get)では、挙動にあわせてフィールド名「startIndex」を「pageIndex」に変更しました。なお、KeywordPlanIdeaService(get)以外のサービスでは、引き続きフィールド名「startIndex」のまま変更ありません。
変更後のstartIndex、pageIndexとnumberResultsの説明は以下のとおりです。

フィールド名 説明
startIndex 取得を開始する結果セット内の位置です。このフィールドは、1以上を指定する必要があります。
pageIndex ページの先頭のインデックスです。このフィールドは、1以上を指定する必要があります。
numberResults 開始位置から取得する結果の数です。このフィールドは、1以上を指定する必要があります。
※numberResultsの名称変更はありませんが、startIndexとpageIndexのどちらを指定するサービスでも利用できるため、リファレンス等の説明を変更しています。

※本改善はフィールド名称の変更のみで、検索広告 APIの挙動に変更はありません。

オンラインセミナーのご案内

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

検索広告 API v11の提供終了について

以下の日程で検索広告 API v11の提供を終了いたします。
サポート終了日:2024年3月13日(水)
システム終了日:2024年6月12日(水)

また、以前にお伝えしたとおり、検索広告 API v10を以下の日程で終了します。
システム終了日:2024年3月13日(水)
※サポートは終了済みです。