以下に、標準リクエストで使用できるプロパティと、広告を受信した場合の応答の概要を示しました。
リクエストされたアイテム
文字列 | 説明 | 必須/任意 |
---|---|---|
catalogId | ウェブサイト用の商品カタログの識別子。 | 必須 |
customerId | 広告の配信対象となる顧客の一意の識別子。 | 任意 |
filterMode | リクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。 | 任意、優先 |
maxNumberOfAds | 返される広告の最大数(最大は10)。 | 必須 |
options | リクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。 | 任意、優先 |
placement | 広告の依頼対象となる特定のプレースメント。 | 必須 |
productFilters | リクエストに関連する商品のフィルタ。カテゴリ、場所、サイズなど。 | 必須 |
sessionId | 顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。 | 標準的な統合に必要 |
memoryToken | ページネーションに使用されます。以前の広告リクエストで提供されたトークンを使用して、CitrusAdが顧客に新しい広告のみを配信するようにします。 提供されると、CitrusAdは、配信済みの広告を広告レスポンスから除外します。詳しくはページネーションを参照してください。 | 任意 |
dtmCookieId | ウェブサイトによって作成され保存されるクッキーで、同一ドメインでのユーザーの行動を追跡するために使用されます。 | 任意 |
リターンアイテム
文字列 | 説明 | 値例 |
---|---|---|
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 } |
position | CitrusAdのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。 | 1 |
memoryToken | 広告リクエストのページネーションとチェーンに使用されます。 同じコンテキストの次の広告リクエストで提供されると、CitrusAdは、配信済みの広告を広告レスポンスから除外します。詳しくはページネーションを参照してください。 |