sync_catalogs は、セラーが広告のレンダリングやターゲティングに使う、バイヤー提供のデータフィードを管理します。これは、get_products buying_mode: "wholesale" が公開するセラー側のホールセール商品フィードや、get_signals discovery_mode: "wholesale" が公開するホールセールシグナルフィードとは別物です。Webhook はそれらセラー側フィードの変更をプッシュするレイヤーです。
レスポンス時間: 即時〜数日(小規模カタログは completed、プラットフォームレビューが必要な大規模フィードは submitted を返す)
リクエストスキーマ: /schemas/v3/media-buy/sync-catalogs-request.json
レスポンススキーマ: /schemas/v3/media-buy/sync-catalogs-response.json
呼び出し関係
バイヤーがセラーアカウントにカタログフィードをプッシュするために、セラーに対してsync_catalogs を呼び出す。セラーはアイテムを検証し、コンテンツポリシーチェックを実行し、アイテムごとの承認ステータスを返します。
このタスクはアカウント状態セットアップシーケンスにおいて、フォーマットディスカバリーとクリエイティブ提出の間に位置します:
list_creative_formats— 各フォーマットのassets配列にあるcatalogアセットタイプを確認し、同期すべきフィードを把握しますsync_catalogs— 必要なフィードをアカウントにプッシュしますsync_creatives—catalog_idで同期済みカタログを参照するクリエイティブを提出しますcreate_media_buy— キャンペーンを開始します
クイックスタート
商品フィードを同期します:リクエストパラメータ
Catalog オブジェクト
catalogs 配列内の各カタログは Catalog オブジェクトです。主要フィールド:
レスポンス
成功レスポンス — カタログごとの結果:
エラーレスポンス — 操作が完全に失敗した場合:
レスポンスは判別ユニオンを使用する —
catalogs または errors のいずれかが返され、両方が同時に返されることはない。
アイテムレベルレビューのレスポンス例
アイテムレビューのライフサイクル
カタログアイテムはシンプルなレビューサイクルをたどります: アイテムは同期時にpending に入り、プラットフォームが非同期にレビューします。アイテムは approved、(理由付きの)rejected、または warning 付きの approved(配信されるが修正可能な問題あり)のいずれかになります。
却下は最終的なものではありません——ソースカタログで問題を修正して再同期します。アイテムを再同期すると、再レビューのために pending にリセットされます。レスポンスの item_issues 配列がアイテムごとの却下理由を示します。
ディスカバリーモード
catalogs を省略することで、アカウント上のすべてのカタログを変更なしで一覧表示できます:
非同期承認ワークフロー
大規模なフィードやコンテンツポリシーレビューが必要なフィードは、task_id とともに status: "submitted" を返します。セラーは非同期でアイテムをレビューし、完了したら Webhook でバイヤーに通知します。
非同期レスポンスの状態:
working— プラットフォームがフィードを処理中(URL の取得、アイテムの検証)input-required— プラットフォームがバイヤーのアクションを必要としている(バリデーションエラーの修正、不足フィールドの提供)submitted— レビュー完了、最終的なカタログごとの結果が利用可能
push_notification_config を設定します。
一般的なシナリオ
リテールメディア(product + inventory + store)
採用(インライン求人オファリング)
ドライランバリデーション
エラーハンドリング
ベストプラクティス
-
フォーマット要件を最初に確認する — 同期前に
list_creative_formatsを呼び出し、各フォーマットのassets配列にあるcatalogアセットタイプを確認します。これにより、同期すべきカタログタイプと各アイテムに必要なフィールドがわかる。 -
ディスカバリーモードを使用する — 同期前に
catalogsなしで呼び出し、セラーがすでに持っているものを確認します。セラーが他のソースからブランドデータを持っている可能性があります。 -
update_frequencyを設定する — URL ベースのフィードでは、プラットフォームが再取得頻度を把握できるよう、常にupdate_frequencyを設定します。フィードが古くなると、在庫切れ商品の広告が表示されることになります。 -
conversion_eventsを宣言する — どのイベントタイプがカタログアイテムのコンバージョンを表すかを宣言して、カタログをコンバージョントラッキングシステムに接続します。 -
大規模フィードには
dry_runを使用する — 特に数千のアイテムを含む初回同期では、コミット前にバリデーションを行います。 -
アイテムレベルの失敗を処理する —
lenientモードでは、一部のアイテムが失敗しても有効なアイテムは処理されます。却下されたアイテムを修正するには、レスポンスのitem_issuesを確認します。
次のステップ
- Catalogs — カタログタイプ、ソーシング、フォーマット要件に関する完全なドキュメント
- アカウント状態 — アカウントセットアップシーケンスにおけるカタログの位置づけ
- sync_creatives — 同期済みカタログを参照するクリエイティブの提出
- list_creative_formats — フォーマットのカタログ要件のディスカバリー