v13バージョンアップ情報

当ページについて

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

1.v12とv13のIF差分

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

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

v12からHTTPヘッダー「x-z-base-account-id」にベースとなるアカウントIDの指定が必須になりました。
詳細は、v12バージョンアップ情報をご覧ください。

(1) 【検索広告】広告表示オプションなどの名称変更について

2024年3月6日(水)以降、過去バージョンを含む全バージョンが対象となるのでご注意ください。
ReportDefinitionService、AuditLogService、CampaignExportServiceの各ダウンロードファイルの広告表示オプションの名称が広告表示アセットに変更になります。
[ポイント]
・リクエスト/レスポンスのフィールド名:変わらない
・レポート上の表示名称:変わる
・レポート上の表示値:変わる
・(XML形式での出力の場合)XML属性:変わらない

詳細は、以下のお知らせとWebinar資料をご確認ください。
【検索広告】広告表示オプションから広告表示アセットへの名称変更について
Webianar資料 7、8スライド目

(2) 【ディスプレイ広告】レポートのダウンロードファイルの仕様変更について

V12以前は数値以外の項目は、原則ダブルクォーテーション(")で囲んでいましたが、
V13では数値以外の項目かつ、項目の値にカンマ(,)またはダブルクォーテーション(")が含まれる場合のみダブルクォーテーション(")で囲むようになりました。
例)

※検索広告と仕様を合わせた形です。

詳細は、以下のWebinar資料をご確認ください。
Webianar資料

3.Webinar情報

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

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

Webinarで出た質問と回答

Q.「検索連動型ショッピング広告」の レポートAPI 対応予定はありますか? 対応をお待ちのお客様がいらっしゃいます。
A.ご要望を多数いただいており、今後対応を検討いたします。

Q.v13のリリースノートで、AudienceListService CampaignService のappVendorsからBRANCHを削除しました。 とありますが、AudienceListServiceはappVendor(複数形のsがない)の変更であっていますでしょうか?CampaignServiceの方は何を指しているかご教示いただきたいです。
A.リリースノートの記載が分かりづらく申し訳ございません。
AudienceListService は appVendor です。
CampaignService は vendorName です。

Q.更新されたリソースのみを取得したいのですが、createdDateRangeだと作成日基準になってしまうので更新日を基準としたフィルタリングは不可能でしょうか?
A.以前からご要望いただいており、今後対応を検討いたします。

Q.Webinar資料のスライド22の広告のトラッキングURLの編集で同じ広告IDのデータが分割される件、将来的な対応予定もないということでしょうか?(以前、すぐの対応は難しいが検討はするといただいていたため)
A.仕組み上対応が難しいため、大変申し訳ないのですが、現状対応予定はありません。

Q.度々起きるフィールド名や値の全バージョンへの変更ですが、適用前にあらかじめサンプルの提供もしくはこちらで取得をできるようにできないでしょうか?
A.GitHubでの差分など、差分がわかりやすい形での掲載を検討いたします。

4.Appendix

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