The below outlines the properties possible in a standard request as outlined in Requesting banner ads for your request, and the response if you receive an ad.
バナー広告は、商品広告と同じ
/generateエンドポイントにリクエストされます。1つのリクエストで両方の広告タイプを取得することができます。
リクエストされたアイテム
| 文字列 | 説明 | 必須/任意 |
|---|---|---|
bannerSlots | バナー広告を受け取る理由となるバナースロットの配列。バナースロットに対してmaxNumberOfAdsを指定すると、そのスロットに対して複数の広告を取得できます。カルーセルプレースメントの場合などに使用されます。 | 必須 |
bannerSlotIds | バナー広告を受け取る理由となるバナースロットの配列 | 必須。bannerSlotsが優先になります。 |
catalogId | ウェブサイト用の商品カタログの識別子。 | 必須 |
contentStandardId | ウェブサイトのコンテンツ規格識別子。 | 必須 |
customerId | 広告の配信対象となる顧客の一意の識別子。 | 任意 |
filterMode | Optional way of defining the structure of your request. See Ad generation filtering for more information. | 任意、優先 |
maxNumberOfAds | 返される商品広告の最大数（最大は15）。 | 必須。商品広告を同一リクエストで配信できるようにします。商品広告を希望しない場合は、次に設定します： 0 |
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. | 標準的な統合に必要 |
dtmCookieId | ウェブサイトによって作成され保存されるクッキーで、同一ドメインでのユーザーの行動を追跡するために使用されます。 | 任意 |
audience | Specifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3 | 任意 |
リターンアイテム
| 文字列 | 説明 | 値例 |
|---|---|---|
banners.altText | 万が一、ヒーロー画像が表示されない場合の代替テキスト。 | Advertisement for <BRAND>. Art of the Burger. Create your delicious masterpiece. Shop Now. |
banners.contentStandardId | ウェブサイトのコンテンツ規格識別子。 | `4ffb80ba-b9a9-4567-8069-79b2eca93473 |
banners.expiry | 広告の有効期限。Epsilon Retail Mediaにクリックが報告される最終の時点です。 | 2021-06-01T23:48:16.573967987Z |
banners.id | 広告の一意のID。 これは、Epsilon Retail Mediaへの各リクエストに固有のもので、キャッシュできません。 | banner_j2vfi9pN2BiQZk4X9sC55PgNu5k3ODIzOTlfMDAwODc2ODQwMDEwNzM= |
banners.imageUrl | バナーの画像リンク。 | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
banners.gtins | キャンペーンの広告対象商品から選択された最大20個の商品コードの配列。 | [ "7714107", "7163379", "7733636", "7733657", "7733628" ], |
banners.linkUrl | 顧客がバナーをクリックした際に、バナーから転送されるURL。 | <https://www.retailer.com/groceries/en-GB/search?query=double-fudge> |
banners.slotId | リクエストしたバナーに関する特定のスロットのID。 | Category_Top |
banners.tags | このフィールドは、広告主がキャンペーンで入力したサードパーティタグを返します。 | { "dv": "<script src=\"<https://cdn.doubleverify.com/dvtp_src.js?ctx=111111&cmp=11111111&sid=111111&plc=111111&adsrv=111&btreg=&btadsrv=&crt=&tagtype=&dvtagver=6.1.src>" type=\"text/javascript\"></script>" } |
banners.text | カスタムメイドのインテグレーションで、追加のテキストフィールドとして使用されます。 | |
banners.position | Epsilon Retail Mediaのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。 | 1 |
banners.sellerId | 出品者の一意のID。チームにsellerIdが設定されている場合にのみ設定されます。sellerIdは通常、マーケットプレイス出品者をオンボーディングするときに使用されます。 | 73nns-32sxr-32ss 統合ごとのカスタム |
banners.metadata | Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Act in Europe.
| "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |
metadata.warnings | 広告リクエストに関する警告情報を含むオブジェクト。現在は最大セグメント数を超えた場合のみ警告が出ます。 | "metadata": { "warnings": [ "Audience Segment IDs exceeded the limit of 100 and were truncated" ] } |