Yahoo!広告 API | Developer Center

English

2023/09/14

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

更新履歴

2023年9月14日　APIv12のリリース完了に伴い記事を更新しました。

初回お知らせ時よりリリース内容が変更になっています。詳細は以下のリリースノートをご確認ください。
Yahoo!広告 検索広告 API v12リリースノート
Yahoo!広告 ディスプレイ広告 API v12リリースノート

ーーーーーーーー

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

対象サービス

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

リリースのバージョン

v12

実施日

2023年9月13日（水）

Yahoo!広告 API共通の変更点

MCCアカウント複数階層構造の対応に伴い、検索広告APIおよびディスプレイ広告 APIの全てのサービスのリクエストを変更します。また、検索広告APIおよびディスプレイ広告 API両方でサービスの新設やインターフェースの変更を実施します。
※機能の詳細は以下のお知らせを参照してください。
MCCアカウント 複数階層構造での設定に対応

  • リクエストの変更
    原則全てのサービスのリクエストヘッダーにx-z-base-account-idの指定が必須となります。x-z-base-account-idは新設するBaseAccountServiceで取得が可能です。
    ※以下のサービスではx-z-base-account-idの指定は不要です。
    ・DictionaryService
    ・BaseAccountService（新設）
    ・PlacementUrlIdeaService（ディスプレイ広告のみ）
    ・ContentsKeywordIdeaService（ディスプレイ広告のみ）
    ・SearchKeywordIdeaService（ディスプレイ広告のみ）

  • サービスの新設
    検索広告APIおよびディスプレイ広告 APIにおいて、以下のサービスを新設します。
    ＜新設するサービス＞
    BaseAccountService

  • 一部サービスにおけるインターフェースの変更
    検索広告APIおよびディスプレイ広告 APIの対象サービスにおいて、以下の通り変更します。
対象サービス変更内容
AccountService
  • リクエスト
    - authType、includeManagerAccountを削除
    ‐ includeMccAccountを新規追加
  • レスポンス
    - authType、isManagerAccountを削除
    - isMccAccountを新規追加
AccountLinkService
  • リクエスト/レスポンス共通
    - managerAccountIdをmccAccountIdに名称変更
    - audienceListSharingEnabledを削除
AccountManagementService
  • リクエスト/レスポンス共通
    - authTypeを削除

  • 注意事項
    ‐ アカウントに付与されている権限はBaseAccountService（新設）で確認できます。
    ‐ AccountManagementService（add）では、 ルートMCC直下にのみアカウントの作成が可能です。また、リクエストヘッダーの x-z-base-account-idにはルートMCC アカウントのIDを指定する必要があります。

検索広告 APIの変更点

■自動入札のスポット調整機能に対応
自動入札のコンバージョン率を短期間で調整できる「自動入札のスポット調整」機能に対応します。機能の詳細については、以下のお知らせを参照してください。
自動入札のスポット調整の提供について

  • 対象サービス
    BiddingSeasonalityAdjustmentService

  • 変更内容
    BiddingSeasonalityAdjustmentServiceを新設します。

■広告の有効性に対応
レスポンシブ検索広告の設定内容について、効果的なパフォーマンスが期待できるかどうかを確認できる指標「広告の有効性」に対応します。機能の詳細については、以下のお知らせを参照してください。
広告の有効性の提供について

  • 対象サービス
    ReportDefinitionService

  • 変更内容
    広告レポートのレポートフィールドに「 Ad Strength（広告の有効性）」を追加します。

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

■レスポンシブディスプレイ広告のタイトル別・説明文別レポートに対応
レスポンシブディスプレイ広告のタイトル、説明文単位のレポート出力に対応します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のお知らせを参照してください。
レスポンシブディスプレイ広告におけるタイトル別・説明文別レポート提供開始のお知らせ

  • 対象サービス
    ReportDefinitionService

  • 変更内容
    広告レポートでレスポンシブディスプレイ広告のタイトル、説明文単位の実績値の出力が可能になります。

■コンバージョンのインポート機能に対応
ウェブサイト外で発生したコンバージョンのインポート機能に対応します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のお知らせを参照してください。
コンバージョンのインポート機能の提供について

  • 対象サービス
    OfflineConversionService（get,upload,downloadErrorFile）
    ConversionTrackerService

  • 変更内容
    - OfflineConversionServiceを新設します。
    - ConversionTrackerServiceのconversionTrackerTypeに「IMPORT」を追加します。

■最適化提案に関する変更
最適化提案の提案種別を追加します。また、既存の「入稿を推奨する画像サイズがある広告グループ」で提案する画像サイズを追加します。

  • 対象サービス
    RecommendationService

  • 変更内容
    - RecommendationServiceTypeに以下を追加します。

    ENHANCED_CPC 拡張クリック単価の利用を推奨するキャンペーンです
    CREATE_CAMPAIGN キャンペーンを作成しましょう
    CREATE_AD_GROUP 広告グループを作成しましょう
    CREATE_AD 広告を作成しましょう
    CREATE_RESPONSIVE_DISPLAY_ADS レスポンシブディスプレイ広告の利用を推奨する広告グループです
    TURN_YOUR_ACCOUNT_ON アカウントの配信設定をオンにしましょう
    TURN_YOUR_AD_ON 広告の配信設定をオンにしましょう
    INSUFFICIENT_ACCOUNT_BALANCE 広告費用が未入金か、またはアカウント残高が少ない状態です


    - 「ADGROUPS_FOR_ADDING_ADS」（入稿を推奨する画像サイズがある広告グループ）のmediaAdFormatにアスペクト比「6:5」を追加します。

■オーディエンスリストの一部提供終了に伴う変更
リスト種別が「カスタム」および「条件」のオーディエンスリストの提供終了に伴い、以下のとおり変更します。

  • 対象サービス
    AudienceListService

  • 変更内容
    - ruleAudienceListおよびcustomAudienceListを削除します。
    - audienceListTypeから「RULE」と「CUSTOM_AUDIENCE」を削除します。

■AccountServiceにエラーコードを追加
予約型キャンペーンを作成しているアカウントにおいて、特定の操作をした場合にエラーを返却します。

  • 対象サービス
    AccountService（set）

  • 変更内容
    以下のエラーコードを追加します。

    コードメッセージ説明
    210005 Cannot update due to the dependency with the delivery settings of guaranteed campaign. 予約型キャンペーンの配信設定との依存関係があるため、更新できません。


    以下のどちらかに当てはまる場合に上記のエラーが返却されます。
    - 配信期間前または配信中の予約型キャンペーンがある状態でアカウントの配信設定をオフにする
    ‐ アカウント終了日を予約型キャンペーンの配信期間より前または配信期間中の日付に更新する

■レポートの機能改善
削除済みのエンティティをレポートに出力するか選択可能になります。

  • 対象サービス
    ReportDefinitionService

  • 変更内容
    addのリクエストにreportIncludeDeletedを追加します。falseを指定すると、削除済みのエンティティをレポートの出力対象から除外します。trueの場合は今まで通り削除済みエンティティを含めて出力します。

補足

  • 各機能に関する詳細は、リリース時に公開されるリリースノート、およびリファレンスをご確認ください。

  • リリースに合わせて、APIv12の概要などをお伝えするオンラインセミナーを開催する予定です。詳細は別途お知らせします。

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

Yahoo!広告 APIv10の提供を以下の日程で終了します。
　サポート終了日：2023年10月23日（月）
　システム終了日：2024年2月14日（水）

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

Developer Center

関連サイト