Yahoo!広告 API | Developer Center

English

2024/02/20

【Yahoo!広告】API v13 システムリリースについて

更新履歴

2024年2月20日　APIv13のリリース完了に伴い記事を更新しました。

初回お知らせ時よりリリース内容が変更になっています。詳細は以下のリリースノートをご確認ください。

Yahoo!広告 検索広告 API v13リリースノート
Yahoo!広告 ディスプレイ広告 API v13リリースノート

ーーーーーーーーーーーーーーーーーーーーーーーーーー

Yahoo!広告 APIの新バージョンをリリースします。詳細を以下のとおりお知らせいたしますので、ご確認ください。

対象サービス

Yahoo!広告 検索広告 API
Yahoo!広告 ディスプレイ広告 API

リリースのバージョン

v13

実施日（予定）

2024年2月19日（月）
※日程は変更になる場合があります。

検索広告 APIの変更点

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

  • 対象サービス
    BiddingSeasonalityAdjustmentService（get）
  • 変更内容
    GET時にキャンペーンIDを指定できます。

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

  • 対象サービス
    ReportDefinitionService
    FeedItemService
    FeedService
  • 変更内容
    • ReportDefinitionService（add）のreportTypeから「FEED_ITEM」（広告表示オプションレポート）を削除します。
    • FeedItemService（get）およびFeedService（get）を削除します。

■保守改善：RetargetingListServiceのENUM値の変更
RetargetingListService UrlRuleKeyのENUM値「REFFER_URL」を「REFER_URL」に変更します。

■保守改善：フィールド「startIndex」の改善
実際の挙動にあわせて対象のサービスでフィールド名「startIndex」の名称を変更し、わかりやすくなるよう改善します。

  • KeywordPlanIdeaService（get）では挙動にあわせてフィールド名「startIndex」を「pageIndex」に変更します。
    ※その他のサービスでは引き続きフィールド名「startIndex」のまま変更ありません。
  • 改善後のstartIndex、pageIndexとnumberResultsの説明は以下のとおりです。
フィールド名 説明
startIndex 取得を開始する結果セット内の位置です。このフィールドは、1以上を指定する必要があります。
pageIndex ページの先頭のインデックスです。このフィールドは、1以上を指定する必要があります。
numberResults 開始位置から取得する結果の数です。このフィールドは、1以上を指定する必要があります。
※numberResultsの名称変更はありませんが、startIndex、pageIndexどちらを指定するサービスでも利用できるため、リファレンス等の説明を変更します。

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

ディスプレイ広告 APIの変更点

■オーディエンスリストターゲティングの新しいリスト種別「高度なセグメント」に対応
サーチキーワードターゲティングをオーディエンスリストターゲティングの1つとして集約した、オーディエンスリストの新規リスト種別「高度なセグメント」に対応します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のお知らせを参照してください。
サーチキーワードターゲティングの移行と提供終了について

  • 対象サービス
    AudienceListService
    AdGroupTargetService
    EstimatedUserSizeService
  • 変更内容
    • AudienceListService 、AdGroupTargetServiceのAudienceListTypeに「ADVANCED_SEGMENTS（高度なセグメント）」を追加します。
    • EstimatedUserSizeService（get）を新設します。

■Yahoo!タグマネージャーのサービス終了に伴う変更
2024年6月に予定しているYahoo!タグマネージャーのサービス終了に先行して、以下のとおり変更します。

  • 対象サービス
    AudienceListService
  • 変更内容
    AudienceListのuploadTypeから「CUSTOM_UID_KEY」を削除します。

■広告タイプ（旧）の項目削除について
提供を終了している項目「広告タイプ（旧）」をレポートから削除します。

  • 対象サービス
    ReportDefinitionService
  • 変更内容
    レポートから「AD_TYPE_PREV」フィールドを削除します。

■アプリのコンバージョン測定が可能な広告効果測定ツールの変更に伴う対応
アプリのコンバージョン測定の対応を終了したツールを削除します。

  • 対象サービス
    AudienceListService
    AppLinkService
    CampaignService
  • 変更内容
    各サービスのappVendorsから「BRANCH」を削除します。

■保守改善

  • AudienceListService、AdGroupTargetServiceのaudienceListTypesから提供終了した項目「DEFAULT_LIST」を削除します。
  • オーディエンスカテゴリーターゲティングの提供終了（オーディエンスリストターゲティングに統合済み）に伴い、以下を変更します。
    • AdGroupTargetServiceから「AUDIENCE_CATEGORY_TARGET」を削除します。
    • DictionaryServiceから「getAudienceCategory」を削除します。
  • CampaignServiceのフィールド名を以下のとおり修正します。
    • conversionOptimizer → optimizerに変更します。
    • conversionOptimizerTrainingStatus → optimizerTrainingStatusに変更します。
  • AdGroupTargetServiceのageから以下の使用されていないフィールドを削除します。
    OLD_GT_RANGE13_14
    OLD_GT_RANGE15_17
    OLD_GT_RANGE18_19
    OLD_GT_RANGE20_21
    OLD_GT_RANGE22_29
    OLD_GT_RANGE30_39
    OLD_GT_RANGE40_49
    OLD_GT_RANGE50_59
    OLD_GT_RANGE60_69
    OLD_GT_RANGE70_UL
    OLD_GT_UNKNOWN
  • FeedItemService/setをクローズします。
  • AudienceListService/getUploadUserListStatusのselectorのフィールド名を以下のとおり修正します。
    • jobStatues → jobStatusesに変更します。

補足

  • 各機能に関する詳細は、リリース時に公開されるリリースノート、およびリファレンスをご確認ください。
  • リリースに合わせて、APIv13の概要などをお伝えするオンラインセミナーを開催する予定です。詳細は別途お知らせします。

旧バージョンの終了について

Yahoo!広告 APIv11の提供を以下の日程で終了します。
　サポート終了日：2024年3月13日（水）
　システム終了日：2024年6月12日（水）

また、Yahoo!広告 APIv10の提供を以下の日程で終了します。
　システム終了日：2024年3月13日（水）
　※サポートは終了済みです。

Developer Center

関連サイト