以下に、標準リクエストで使用できるプロパティと、広告を受信した場合の応答の概要を示しました。
リクエストされたアイテム
| 文字列 | 説明 | 必須/任意 |
|---|---|---|
catalogId | ウェブサイト用の商品カタログの識別子。 | 必須 |
customerId | 広告の配信対象となる顧客の一意の識別子。 | 任意 |
filterMode | Optional way of defining the structure of your request. See Ad generation filtering for more information. | 任意、優先 |
maxNumberOfAds | 返される広告の最大数（最大は10）。 | 必須 |
options | Optional way of defining the structure of your request. See Ad generation filtering for more information. This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s Digital Services Act. | 任意、優先 |
placement | 広告の依頼対象となる特定のプレースメント。 | 必須 |
productFilters | リクエストに関連する商品のフィルタ。カテゴリ、場所、サイズなど。 | 必須 |
sessionId | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information. | 標準的な統合に必要 |
memoryToken | Used for pagination. Use a token provided in a previous ad request to ensure Epsilon Retail Media only serves new ads to your customers. If provided, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more. | 任意 |
dtmCookieId | ウェブサイトによって作成され保存されるクッキーで、同一ドメインでのユーザーの行動を追跡するために使用されます。 | 任意 |
audience | Specifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3 | 任意 |
リターンアイテム
| 文字列 | 説明 | 値例 |
|---|---|---|
ads.customPayload | カタログファイルから広告生成に通される必要がある、カスタムペイロードです。 このフィールドは、有効なJSONオブジェクトをバイト配列にシリアル化し、Base64エンコードしたものである必要があります。JSONオブジェクトはスキーマに準拠する必要があります。 | 統合ごとのカスタム |
ads.sellerId | 出品者の一意のID。チームにsellerIdが設定されている場合にのみ設定されます。sellerIdは通常、マーケットプレイス出品者をオンボーディングするときに使用されます。 | 73nns-32sxr-32ss 統合ごとのカスタム |
ads.id | 広告の一意のID。 これは、Epsilon Retail Mediaへの各リクエストに固有のもので、キャッシュできません。 | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
ads.gtin | 広告の商品コード。商品カタログで同期される商品コードになります。 | 25813383 |
ads.discount | レガシーです。無視できます。 | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
ads.position | Epsilon Retail Mediaのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。 | 1 |
ads.memoryToken | 広告リクエストのページネーションとチェーンに使用されます。 If provided in your next ad request for the same context, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more. | |
ads.metadata | Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Actin Europe.
| "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |
banners | Comprises of banner objects. View the Banner ad (static) reference to learn more. | "banners": [], |
metadata.warnings | 広告リクエストに関する警告情報を含むオブジェクト。現在は最大セグメント数を超えた場合のみ警告が出ます。 | "metadata": { "warnings": [ "Audience Segment IDs exceeded the limit of 100 and were truncated" ] |