商品広告のリファレンス

以下に、標準リクエストで使用できるプロパティと、広告を受信した場合の応答の概要を示しました。

リクエストされたアイテム

文字列説明必須/任意
catalogIdウェブサイト用の商品カタログの識別子。必須
customerId広告の配信対象となる顧客の一意の識別子。任意
filterModeリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
maxNumberOfAds返される広告の最大数(最大は15)。必須
optionsリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
placement広告の依頼対象となる特定のプレースメント。必須
productFiltersリクエストに関連する商品のフィルタ。カテゴリ、場所、サイズなど。必須
sessionId顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。標準的な統合に必要
memoryTokenページネーションに使用されます。以前の広告リクエストで提供されたトークンを使用して、CitrusAdが顧客に新しい広告のみを配信するようにします。

提供されると、CitrusAdは、配信済みの広告を広告レスポンスから除外します。詳しくはページネーションを参照してください。
任意

リターンアイテム

文字列説明値例
customPayloadカタログファイルから広告生成に通される必要がある、カスタムペイロードです。

このフィールドは、有効なJSONオブジェクトをバイト配列にシリアル化し、Base64エンコードしたものである必要があります。JSONオブジェクトはスキーマに準拠する必要があります。
統合ごとのカスタム
sellerId出品者の一意のID。チームにsellerIdが設定されている場合にのみ設定されます。sellerIdは通常、マーケットプレイス出品者をオンボーディングするときに使用されます。73nns-32sxr-32ss 統合ごとのカスタム
id広告の一意のID。
これは、CitrusAdへの各リクエストに固有のもので、キャッシュできません。
display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4
gtin広告の商品コード。商品カタログで同期される商品コードになります。25813383
discountレガシーです。無視できます。{ "amount": 0, "minPrice": 0, "maxPerCustomer": 0 }
positionCitrusAdのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。1
memoryToken広告リクエストのページネーションとチェーンに使用されます。

同じコンテキストの次の広告リクエストで提供されると、CitrusAdは、配信済みの広告を広告レスポンスから除外します。詳しくはページネーションを参照してください。