以下はリクエストに対する「広告のリクエスト」で説明された、標準的なリクエストで可能なプロパティと、広告を取得した場合のレスポンスの概要です。
リクエストされたアイテム
| 文字列 | 説明 | 必須/任意 |
|---|---|---|
BannerSlotIds | 要求されたバナーslotIdsのjson配列。 | 必須 |
catalogId | ウェブサイト用の商品カタログの識別子。 | 必須 |
contentStandardId | ウェブサイトのコンテンツ規格識別子。 | 必須 |
customerId | 広告の配信対象となる顧客の一意の識別子。 | 任意 |
filterMode | リクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。 | 任意、優先 |
maxNumberOfAds | 返される各バナースロットの最大数。 | 必須 |
options | リクエストの構造を定義するもう1つの方法。詳細については、広告生成フィルタリングを参照してください。 また、欧州のデジタルサービス法のような現地の広告法に準拠するために、広告主情報をリクエストできるオブジェクトでもあります。 | 任意、優先 |
placement | 広告の依頼対象となる特定のプレースメント。 | 必須 |
productFilters | リクエストに関連する商品のフィルタ。カテゴリ、場所、サイズのフィルタなど。 | カテゴリプレースメントに必要 |
searchTerm | 顧客によってお客様のウェブサイトに入力された検索キーワード。 | 検索プレースメントに必要 |
sessionId | 顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。 | 標準的な統合に必要 |
slotId | コンテキスト内のリクエストされたSlotIdを含んでいます。1つの場合も、複数の場合もあります。 | 必須 |
dtmCookieId | ウェブサイトによって作成され保存されるクッキーで、同一ドメインでのユーザーの行動を追跡するために使用されます。 | 任意 |
audience | 買い物客が属する特定のオーディエンスセグメントを指定します。関連するのはオーディエンスターゲティングオプション3の使用のみです | 任意 |
リターンアイテム
| 文字列 | 説明 | 値例 |
|---|---|---|
ads.backgroundColour | バナーの背景色 - HEX値のみ。 | 6e6c6c |
ads.backgroundImage | バナー背景画像の画像リンク。 | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[サーバー].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
ads.backgroundImagePosition | 背景画像の位置タイプを定義します。値がない場合は、次をデフォルトに設定する必要があります: leftaligned . | leftalignedrightalignedfillrepeating |
ads.bannerText | バナーに表示されるテキスト。HTMLタグを含む場合があります。 | <strong>Double Fudge Ice Cream</strong> |
ads.bannerTextColour | バナーテキストの色 - HEX値のみ。Citrusは次を送信しません: #. | 1dc711 |
ads.citrusAdId | 広告の一意のID。 これは、Epsilon Retail Mediaへの各リクエストに固有のもので、キャッシュできません。 | shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3 |
ads.citrusCampaignName | 広告のキャンペーン名 | Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6 |
ads.citrusContentStandardId | スロットに関連するコンテンツ規格ID。 | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.citrusExpiry | 広告の有効期限。Epsilon Retail Mediaにクリックが報告される最終の時点です。 | 2021-06-01T23:48:16.573967987Z |
ads.citrusSlotId | リクエストしたバナーに関する特定のスロットのID。 | Category_Top |
ads.contentStandardId | スロットに関連するコンテンツの標準ID。以下の複製: citrusContentStandardId | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.ctaFlag | CTAを表示するかどうかを定義。 | truefalse |
ads.ctaLink | CTAから転送されるURL(バナーのlinkUrlと同様)。ctaFlagが以下の場合にのみ提供: true | <https://www.retailer.com/groceries/en-GB/search?query=double-fudge> |
ads.ctaText | CTA内のテキスト。 | Shop now |
ads.ctaTextAccessibility | スクリーンリーダー利用者のためのCTAのアクセシビリティテキスト。 | for Double Fudge Ice Cream |
ads.gtins | キャンペーンの広告対象商品から選択された最大20個の商品コードの配列。 小売業者はこのリストを使用して、バナーがクリックされた時のリスターページの自動化や、特定のレンダリング機能(ラウンデル、価格、二次在庫レベルのチェック)の自動化ができます。 | [ "7714107", "7163379", "7733636", "7733657", "7733628" ], |
ads.headingText | スクリーンリーダー利用者のための見出しテキスト。 | Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button |
ads.heroImageAltText | 万が一、ヒーロー画像が表示されない場合の代替テキスト。 | Image of double fudge iced cream |
ads.heroImage | バナーのヒーロー画像の画像リンク。 | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[サーバー].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
ads.position | Epsilon Retail Mediaのレスポンスにおけるバナーの位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。 | 1 |
ads.secondaryBackgroundImage | 二番目の背景画像の画像リンク。 | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[サーバー].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
ads.secondaryBackgroundImagePosition | 二番目の背景画像の位置タイプを定義します。 | leftalignedrightaligned |
ads.secondaryHeroImageAltText | 万が一、二番目のヒーロー画像が表示されない場合の代替テキスト。 | Image of [brand] logo |
ads.secondaryHeroImage | 二番目のヒーロー画像の画像リンク。 | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[サーバー].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
ads.secondaryHeroMode | 二番目のヒーロー画像の表示モードを定義します。値がない場合は、次をデフォルトに設定する必要があります: block . | blocklandscape |
ads.slotId | リクエストしたバナーのスロットID。複数のバナーをリクエストする場合、これを使用して、リクエストされたIDを参照できます。 | Category_Top |
ads.tags | このフィールドは、広告主がキャンペーンで入力したサードパーティタグを返します。APIレスポンスはフォーマットされていますが、バナーXでは現在サポートされていません。 | {} |
ads.sellerId | 出品者の一意のID。チームにsellerIdが設定されている場合にのみ設定されます。sellerIdは通常、マーケットプレイス出品者をオンボーディングするときに使用されます。 | 73nns-32sxr-32ss 統合ごとのカスタム |
ads.metadata | 広告主が欧州のデジタルサービス法などの現地の広告法に準拠するために必要な広告主情報を含むオブジェクト。advertiser はサプライヤーチームの会社名から引き継がれます。onBehalfOf はサプライヤーチームの広告資金提供者から提供されます。 | "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |
ads.adm | VASTタグを含む動画広告の詳細を含むオブジェクト。 | "\n<VAST version="4.0">\n <Ad id="1">\n \n CitrusAd\n ![CDATA[https://integration.BASE-URL.citrusad.com/v1/resource/first-i/shotgun_2DbJUbTdlM3HFvLuF75YoA2FgpwKBQoDMTIzEgAaCwjHsuG_BhD7sqZzIgIIAQ==]] \n \n ![CDATA[https://integration.BASE-URL.citrusad.com/v1/resource/first-i/shotgun_2DbJUbTdlM3HFvLuF75YoA2FgpwKBQoDMTIzEgAaCwjHsuG_BhD7sqZzIgIIAQ==]] \n \n \n \n VAST-4.0-Short-Intro.mp4\n \n \n <UniversalAdId idRegistry="http://citrusad.com " idValue="VAST-4.0-Short-Intro.mp4">VAST-4.0-Short-Intro.mp4\n \n \n \n <MediaFile delivery="progressive" type="video/mp4" width="0" height="0" bitrate="0" codec="">![CDATA[https://cdn.flavedo.io./citrus/VAST-4.0-Short-Intro.mp4]] \n ![CDATA[https://cdn.flavedo.io./citrus/VAST-4.0-Short-Intro.mp4]] \n \n \n ![CDATA[https://integration.BASE-URL.citrusad.com/v1/resource/second-c/shotgun_2DbJUbTdlM3HFvLuF75YoA2FgpwKBQoDMTIzEgAaCwjHsuG_BhD7sqZzIgIIAQ==]] \n \n \n \n \n \n \n \n" |
ads.companionProducts | 関連製品の詳細。 | “companionProducts”: [ "Banana14-simfk15" "Oranges5-qgxeb6", "Incaberries20-ppscn21" |
metadata.warnings | Object containing warning information about the ad request. Currently only warns if the maximum number of segments is exceeded. | "metadata": { "warnings": [ "Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated" ] } |
広告のキャンペーンの一部として設定されていないフィールドがある場合、そのフィールドは配信されません。例:広告主が
heroImageを設定していない場合、Epsilon Retail MediaはheroImageプロパティを提供しません。
