Yahoo!広告 API | Developer Center

ディスプレイ広告 API v12 リリースノート

リリースバージョン

v12

リリース日

2023年9月13日（水）

本リリースの主な内容

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

1. MCCアカウント複数階層構造の対応に伴う変更

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

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

• サービスの新設
  以下のサービスを新設しました。
  BaseAccountService

• 一部サービスにおけるインターフェースの変更
  対象サービスにおいて、以下の通り変更しました。

  対象サービス	変更内容
  AccountService	リクエスト - authType、includeManagerAccountを削除 ‐ includeMccAccountを新規追加 レスポンス - authType、isManagerAccountを削除 - isMccAccountを新規追加
  AccountLinkService	リクエスト/レスポンス共通 - managerAccountIdをmccAccountIdに名称変更 - audienceListSharingEnabledを削除 レスポンス ‐ linkAccessPermissionを削除
  AccountManagementService	リクエスト/レスポンス共通 - authTypeを削除 - statusから「CANCELED」を削除

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

2. レスポンシブディスプレイ広告のタイトル別・説明文別レポートに対応

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

対象サービス

ReportDefinitionService

内容

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

3. コンバージョンのインポート機能に対応

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

対象サービス

OfflineConversionService（get,upload,downloadErrorFile）
ConversionTrackerService

内容

• OfflineConversionServiceを新設しました。

• ConversionTrackerServiceのconversionTrackerTypeに「IMPORT」を追加しました。

4. 最適化提案に関する変更

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

対象サービス

RecommendationService

内容

• RecommendationServiceTypeに以下を追加しました。

  ENUM名	最適化提案の内容
  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」を追加しました。

5. トップページ トピックスPRの広告タイプ変更に伴う対応

ディスプレイ広告（予約型）のトップページ トピックスPRの広告タイプ変更に対応します。
※詳細は以下のお知らせを参照してください。
「Yahoo! JAPAN トップページトピックス PR」の正式販売開始に伴う機能変更について

対象サービス

GuaranteedAdGroupAdService(get)

内容

GuaranteedAdGroupAdServiceAdTypeにトップページ トピックスPR広告を表す「TOP_PAGE_TOPICS_PR」を追加します。
※トップページ トピックスPR広告の情報が取得可能になるのは2023年10月3日以降です。

6. オーディエンスリストの一部提供終了に伴う変更

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

対象サービス

AudienceListService

内容

• ruleAudienceListを削除しました。
  →延期となりました。v13で削除を予定しています。

• customAudienceListを削除しました。

• audienceListTypeから「RULE」と「CUSTOM_AUDIENCE」を削除しました。

7. AccountServiceにエラーコードを追加

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

対象サービス

AccountService（set）

内容

以下のエラーコードを追加しました。

以下のどちらかに当てはまる場合に上記のエラーが返却されます。

• 配信期間前または配信中の予約型キャンペーンがある状態でアカウントの配信設定をオフにする

• アカウント終了日を予約型キャンペーンの配信期間より前または配信期間中の日付に更新する

8. レポートの機能改善

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

対象サービス

ReportDefinitionService

内容

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

9. 操作履歴のダウンロード機能改善

操作履歴のファイル形式の指定が可能になりました。

対象サービス

AuditLogService

内容

addのリクエストおよびget、addのレスポンスにoutputを追加しました。

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

API v12の概要などをお伝えするオンラインセミナーを開催します。今回のセミナーでは、APIの認証にベースアカウントIDが必要となる件について詳しくご説明いたします。認証に関する重要な内容をお伝えするため、ぜひご参加ください。 日程など詳細は以下のお知らせをご確認ください。
Yahoo! JAPAN Ads API Webinarのご案内

ディスプレイ広告 API v10の提供終了について

以下の日程でディスプレイ広告 API v10の提供を終了いたします。

• サポート終了日：2023年10月23日（月）

• システム終了日：2024年2月14日（水）

また、以前にお伝えしたとおり、ディスプレイ広告 API v9を以下の日程で終了します。

• システム終了日：2023年10月23日（月）
  ※サポートは終了済みです。

更新履歴

2023年11月14日　6. オーディエンスリストの一部提供終了に伴う変更　の内容を修正しました。