v12バージョンアップ情報

当ページについて

こちらのページは、v12へバージョンアップする際に参考となる情報をまとめたページです。
以下の情報が確認できます。
1.v11とv12のIF差分
2.アップデートにあたっての注意点
3.Webinar情報
4.Appendix

1.v11とv12のIF差分

検索広告
ディスプレイ広告
IF単位での差分がご覧いただけます。

2.アップデートにあたっての注意点

(1) MCC複数階層化について

MCCアカウントの複数階層化に伴い、v12からHTTPヘッダー「x-z-base-account-id」にベースとなるアカウントIDの指定が必須となります。
詳細は、以下のお知らせ・Webinar資料をご確認ください。
Yahoo!広告 MCCアカウント 複数階層構造での設定に対応
Webianar資料 22~35スライド目

OpenAPIを利用してクライアントを生成している場合、下図のように関数の引数で指定する形となりますのでご注意ください。

Q. 「x-z-base-account-id」にルートMCCアカウントのIDを指定すれば、Webinar資料の Case4のようにマッピングを作成することなく、今までどおり全てのアカウントの操作ができる認識であっていますか?
A. 現在認証しているビジネスIDの広告管理ツールの権限によって、以下のとおり異なります。
1.現在広告管理ツールの管理権限があるビジネスIDで認証している場合
ルートMCC配下に、社外のアカウントもすべてアカウントリンクで繋がっている場合は、MCCアカウントのIDを「x-z-base-account-id」にすることで現在と同じ挙動になります。
アカウント招待*で繋がっているアカウントが存在する場合は、ルートMCCのアカウントID指定だけでは操作できないので、任意のMCCアカウント配下にアカウントリンクで繋げていただく必要がございます。
Webinar資料のCase1にあたります。

*ご参考:他企業へアカウントリンクを申請する(Yahoo!広告ヘルプ)

アカウント招待でつながっているアカウントが存在するかどうか分からないという場合は、v11のAccountService/getのレスポンスと、v12のルートMCCのAccountService/getのレスポンスで取得できるアカウントの差分を比較することでご確認いただけます。 差分となっているアカウントが、アカウント招待でつながっているアカウントです。

2.現在広告管理ツールの管理者権限を持たないビジネスIDで認証している場合
ルートMCCを指定できないので、アカウントごとに参照権限や編集権限など管理者権限以外の権限のアカウントがある場合は、以下のどちらかの方法でベースアカウントとしてのアカウントIDを指定してください。
(1) Webinar資料のCase2のように任意のMCCアカウントID(または広告アカウントID)をベースアカウントとしてのアカウントIDとして指定する方法

(2) Webinar資料のCase4のようにマッピングを作成し、ベースアカウントとしてのアカウントIDを適宜指定する方法


Q. ルートMCCアカウントのIDは運用の途中で変更されることはありますか?
A. ルートMCCアカウントのIDが運用の途中で変更されることはございません。

Q. 広告管理ツール画面上にて、 ただの「MCCアカウント」なのか「ルートMCC」なのかユーザ側で識別可能でしょうか?
A. 管理画面上でもルートMCCかどうかご確認いただけます。
ご参考:アカウント選択画面

Yahoo!広告 APIでも、ルートMCCかどうかのフラグ(isRootMccAccount)がございます。

Q. 操作したい対象の広告アカウントのアカウントIDが常に特定できている場合、「x-z-base-account-id」もそのアカウントIDを指定すればいいのでしょうか?
A. 認証しているビジネスIDが、操作対象の広告アカウント全てに対して直接権限を持っている場合はそうです。「x-z-base-account-id」に操作対象のアカウントIDを指定してください。
認証しているビジネスIDが直接権限を持っているアカウントは、BaseAccountService/getでご確認いただけます。
BaseAccountService/getのレスポンスに操作対象の広告アカウントのアカウントIDが含まれている場合、認証しているビジネスIDは操作対象の広告アカウントに直接権限を持っています。
含まれていない場合、認証しているビジネスIDは操作対象のアカウントに対して直接権限を持っていません。操作対象のアカウントの上にあるMCCアカウントに権限を持っていることが考えられます。この場合、「x-z-base-account-id」には操作対象の上にあるMCCアカウントまたはルートMCCのアカウントIDを指定してください。

例)下図の「広告アカウント2」は、直接権限を持っていません。
「広告アカウント2」広告アカウントの上の「MCCアカウント2」の権限を持っているので、「x-z-base-account-id」には「MCCアカウント2」のアカウントIDを指定することで、「広告アカウント2」が操作できるようになります。

(2) レスポンシブディスプレイ広告のレポートの仕様変更について

管理画面上では6月28日(水)から仕様変更となっていましたが、Yahoo!広告 APIではv12での対応となります。
タイトル、説明文の動作区分はSegment項目(分割項目)となるため、v12へのバージョンアップの際はご注意ください。

詳細は、以下のお知らせとWebinar資料をご確認ください。
ディスプレイ広告(運用型)レスポンシブディスプレイ広告におけるタイトル別・説明文別レポート提供開始のお知らせ
Webianar資料 12、13スライド目

(3) 操作履歴のフォーマット変更について

a)操作履歴の項目が、検索とディスプレイで統一されました。
列を指定して処理をしている場合、バージョンアップの際にご注意ください。
また、v11以前で add した操作履歴は、v12では get できませんのでご注意ください。

b)検索の AuditLogService/add で指定する期間が、ディスプレイに合わせて日時分秒単位から日時単位となりました。
下位互換はしておりませんので、バージョンアップの際は時分秒部分の削除をお願いいたします。

詳細は、以下のWebinar資料、ベストプラクティスをご確認ください。
Webianar資料 18~21スライド目
ベストプラクティス:操作履歴(ディスプレイ)
ベストプラクティス:操作履歴(検索)

(4) Java利用者向けクライアントライブラリのSpring Framework 6系への対応(再掲)

Java利用者向けクライアントライブラリについて、Spring Framework 6系に対応しました。
Spring Framework 6系はJavaバージョンが17+となるため、一定期間の間はこれまで通りの動作環境(Javaバージョン8+)を維持したバージョン("-spring5" がついたもの)を並行して提供いたします。
Spring framework 5.3系は 2024/12/31 にEOLを迎えるため、"-spring5" 付きのリリースバージョンは、一定の期間を経てサポートを終了する予定です。

詳細は、以下のWebinar資料をご確認ください。
Webianar資料 37スライド目

3.Webinar情報

2023年9月27日(水)に、v12バージョンアップWebinarを開催しました。Webinarの詳細は以下の資料を参照してください。
Webinar資料
※Webinar開催のお知らせはこちらを参照してください。

次回開催は2024年1月頃を予定しております。詳細は開催の約1カ月前にお知らせいたします。

4.Appendix

Yahoo!広告 API v12 システムリリース完了のお知らせ
 リリースした機能に関する各種資料へのリンクが記載されているお知らせです。リリース後の確定情報を記載しています。
v12のOpenAPI Specification(検索広告)
 検索広告APIのOpenAPI Specificationです。こちらをOpenAPI Generator等で読み込んで任意のプログラミング言語のクライアントを生成します。
 ※サンプルプログラムにて、OpenAPI Generator等で生成したクライアントをもとにしたサンプルプログラムを掲載しています。
v12のOpenAPI Specification(ディスプレイ広告)
 ディスプレイ広告APIのOpenAPI Specificationです。こちらをOpenAPI Generator等で読み込んで任意のプログラミング言語のクライアントを生成します。
 ※サンプルプログラムにて、OpenAPI Generator等で生成したクライアントをもとにしたサンプルプログラムを掲載しています。