> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/ja/references/banner-x-reference-1.md). # バナー X のリファレンス 以下は、標準的なリクエストで可能なプロパティの概要を示しています。 [広告をリクエストする](/retail-media-interface/integration/ja/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) リクエストに対するプロパティ、および広告を受信した場合のレスポンス。 ## リクエストされた項目 | 文字列 | 説明 | 必須/任意 | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | | `BannerSlotIds` | リクエストされているバナー slotId の json 配列。 | 必須 | | `catalogId` | ウェブサイトのプロダクトカタログ識別子。 | 必須 | | `contentStandardId` | ウェブサイトのコンテンツ標準識別子。 | 必須 | | `customerId` | 広告が配信される顧客の固有識別子。 | 任意 | | `filterMode` | リクエストの構造を定義するオプションの方法。詳細については次を参照してください： [広告生成フィルタリング](/retail-media-interface/integration/ja/data-api/api-overview/ad-generation-filtering-1.md) 詳細については次を参照してください。 | 任意、推奨 | | `maxNumberOfAds` | 返される各バナー枠の最大数。 | 必須 | | `options` |

リクエストの構造を定義するオプションの方法。詳細については広告生成のフィルタリングを参照してください。

これは、欧州などの地域の広告関連法規に準拠するために広告主情報をリクエストできるオブジェクトでもあります： デジタルサービス法 .

| 任意、推奨 | | `placement` | 広告をリクエストしている固有のプレースメント。 | 必須 | | `productFilters` | リクエストに関連する製品フィルター。カテゴリー、場所、サイズフィルターなど。 | カテゴリープレースメントに必須 | | `searchTerm` | 顧客がウェブサイトに入力した検索キーワード。 | 検索プレースメントに必須 | | `sessionId` | 顧客セッションの固有識別子。標準統合でのアトリビューションに使用されます。レビュー [統合ワークフローのオプション](/retail-media-interface/integration/ja/data-api/api-overview/integration-workflow-options-1.md)詳細については次を参照してください。 | 標準統合で必須 | | `slotId` | これには、コンテキスト内でリクエストされた SlotId が含まれます。1つまたは複数存在できます。 | 必須 | | `dtmCookieId` | 同一ドメイン上でのユーザー行動のトラッキングに使用される、ウェブサイトによって作成および保存される Cookie。 | 任意 | | `audience` | ショッパーが属する特定のオーディエンスセグメントを指定します。以下を使用している場合のみ関連します： [オーディエンスターゲティングオプション 3](/retail-media-interface/integration/ja/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | 任意 | ## 返された項目 | 文字列 | 説明 | 値の例 | | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | バナーの背景色 - HEX値のみ。 | `6e6c6c` | | `ads.backgroundImage` | バナー背景画像の画像リンク。 | `[]\() | | `ads.backgroundImagePosition` | 背景画像の表示位置タイプを定義します。値がない場合は、デフォルトで次にする必要があります： `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | バナーに表示されるテキスト。HTMLタグを含む場合があります | `Double Fudge Ice Cream` | | `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 が表示されるかどうかを定義します。 |

true
false

| | `ads.ctaLink` | CTA から転送される URL（これはバナーの linkUrl のようなものです）。ctaFlag が以下の場合のみ配信されます： `true` | ` | | `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` | バナーのメイン画像の画像リンク。 | `[]\() | | `ads.position` | 以下におけるバナーの掲載位置： Epsilon Retail Media レスポンス。固定掲載キャンペーンが利用されている場合は、この位置を優先する必要があります。 | 1 | | `ads.secondaryBackgroundImage` | サブ背景画像の画像リンク。 | `[]\() | | `ads.secondaryBackgroundImagePosition` | サブ背景画像の表示位置タイプを定義します。 |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | サブメイン画像が表示されない万が一の場合の代替テキスト。 | `Image of [brand] logo` | | `ads.secondaryHeroImage` | サブメイン画像の画像リンク。 | `[]\() | | `ads.secondaryHeroMode` | サブメイン画像の表示モードを定義します。値がない場合は、デフォルトで次にする必要があります： `block` . |

block
landscape

| | `ads.slotId` | リクエストしたバナーの枠 ID。複数のバナーをリクエストする場合、リクエストされた ID を参照するために使用できます。 | `Category_Top` | | `ads.tags` | このフィールドは、広告主がキャンペーンに入力したサードパーティタグを返します。現在バナー x ではサポートされていませんが、API レスポンスは整形式になっています。 | `{}` | | `ads.sellerId` | セラーのユニーク ID。チームに sellerId が設定されている場合にのみ入力されます。sellerIds は通常、マーケットプレイスセラーのオンボーディング時に使用されます。 | `73nns-32sxr-32ss` 連携ごとにカスタム | | `ads.metadata` |

広告主が以下の地域の広告関連法令を遵守するのを支援するために必要な、広告主情報を含むオブジェクト： デジタルサービス法 欧州における。

advertiser はサプライヤーチームの会社名から引き継がれます。

onBehalfOf はサプライヤーチームの広告資金提供者から引き継がれます。

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | VAST タグを含む動画広告の詳細を含むオブジェクト。 | "\n\\n \\n \\n \Epsilon Retail Media\\n \!\[CDATA\[]] \\n \\n \!\[CDATA\[]] \\n \\\n \\\n \\n \VAST-4.0-Short-Intro.mp4\\n <クリエイティブs>\n <クリエイティブ>\n \VAST-4.0-Short-Intro.mp4\\n \\n \\\n \\n \!\[CDATA\[]] \\n \!\[CDATA\[]] \\n \\n \\n \!\[CDATA\[]] \\n \\\n \\n \\n \\n \\n \\n \\n\" | | `ads.companionProducts` | コンパニオン商品の詳細。 |

“companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"

| | `metadata.warnings` | 広告リクエストに関する警告情報を含むオブジェクト。現在はセグメントの最大数を超えた場合のみ警告を発します。 | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} 広告のキャンペーンの一部として設定されていないフィールドがある場合、そのフィールドは配信されません。つまり、広告主が次を設定していない場合、 `heroImage`, Epsilon Retail Media は配信されません： `heroImage` プロパティ。 {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/ja/references/banner-x-reference-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.