パートナーAPI

ブランドページのリファレンス

以下は「広告のリクエスト」で説明された、標準的なリクエストで可能なプロパティの概要です。ここでは3つのAPIコールが必要になります。1つは商品広告用、もう1つはバナーX広告用、最後は静的コンテンツ用のAPIコールです。

商品広告のリクエストされたアイテム

文字列説明必須/任意
catalogIdウェブサイト用の商品カタログの識別子。必須
customerId広告の配信対象となる顧客の一意の識別子。任意
filterModeリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
maxNumberOfAds返される広告の最大数（最大は15）。必須
optionsリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
placement広告の依頼対象となる特定のプレースメント。必須
productFiltersリクエストに関連する商品のフィルタ。場所など。

次のブランドページフィルタを追加する必要があります： brandpage:<VALUE>

この値は、ブランドページの一意のURLサフィックスです。サフィックスに設定されたブランドページがある場合、CitrusAdはペイロードでコンテンツを送信します。		必須
sessionId顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。標準的な統合に必要

商品広告のリターンアイテム

文字列説明値例
customPayloadカタログファイルから広告生成に通される必要がある、カスタムペイロードです。

このフィールドは、有効なJSONオブジェクトをバイト配列にシリアル化し、Base64エンコードしたものである必要があります。JSONオブジェクトはスキーマに準拠する必要があります。		統合ごとのカスタム
id広告の一意のID。
これは、CitrusAdへの各リクエストに固有のもので、キャッシュできません。		display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4
gtin広告の商品コード。商品カタログで同期される商品コードになります。25813383
discountレガシーです。無視できます。{ "amount": 0, "minPrice": 0, "maxPerCustomer": 0 }
positionCitrusAdのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。1

バナー×のリクエストされたアイテム

文字列説明必須/任意
bannerSlotIds要求されたバナーslotIdsのjson配列。必須
catalogIdウェブサイト用の商品カタログの識別子。必須
contentStandardIdウェブサイトのコンテンツ規格識別子。必須
customerId広告の配信対象となる顧客の一意の識別子。任意
filterModeリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
maxNumberOfAds返される各バナースロットの最大数。必須
optionsリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
placement広告の依頼対象となる特定のプレースメント。必須
productFiltersリクエストに関連する商品のフィルタ。場所など。

次のブランドページフィルタを追加する必要があります： brandpage:<VALUE>

この値は、ブランドページの一意のURLサフィックスです。サフィックスに設定されたブランドページがある場合、CitrusAdはペイロードでコンテンツを送信します。		必須
sessionId顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。標準的な統合に必要
slotIdコンテキスト内のリクエストされたSlotIdを含んでいます。1つの場合も、複数の場合もあります。必須

バナーXのリターンアイテム

文字列説明値例
backgroundColourバナーの背景色 - HEX値のみ。6e6c6c
backgroundImageバナー背景画像の画像リンク。https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3
backgroundImagePosition背景画像の位置タイプを定義します。値がない場合は、次をデフォルトに設定する必要があります： leftaligned .leftaligned
rightaligned
fill
repeating
bannerTextバナーに表示されるテキスト。HTMLタグを含む場合があります。<strong>Double Fudge Ice Cream</strong>
bannerTextColourバナーテキストの色 - HEX値のみ。Citrusは次を送信しません： #.1dc711
citrusAdId広告の一意のID。
これは、CitrusAdへの各リクエストに固有のもので、キャッシュできません。		shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3
citrusCampaignName広告のキャンペーン名CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6
citrusContentStandardIdスロットに関連するコンテンツ規格ID。8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
citrusExpiry広告の有効期限。CitrusAdにクリックが報告される最終の時点です。2021-06-01T23:48:16.573967987Z
citrusSlotIdリクエストしたバナーに関する特定のスロットのID。Category_Top
contentStandardIdスロットに関連するコンテンツの標準ID。以下の複製： citrusContentStandardId8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ctaFlagCTAを表示するかどうかを定義。true
false
ctaLinkCTAから転送されるURL（バナーのlinkUrlと同様）。ctaFlagが以下の場合にのみ提供： truehttps://www.retailer.com/groceries/en-GB/search?query=double-fudge
ctaTextCTA内のテキスト。Shop now
`ctaTextAccessibilityスクリーンリーダー利用者のためのCTAのアクセシビリティテキスト。for Double Fudge Ice Cream
gtinsキャンペーンの広告対象商品から選択された最大20個の商品コードの配列。

小売業者はこのリストを使用して、バナーがクリックされた時のリスターページの自動化や、特定のレンダリング機能（ラウンデル、価格、二次在庫レベルのチェック）の自動化ができます。		"gtins": [ "7714107", "7163379", "7733636", "7733657", "7733628" ],
headingTextスクリーンリーダー利用者のための見出しテキスト。Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button
heroImageAltText万が一、ヒーロー画像が表示されない場合の代替テキスト。Image of double fudge iced cream
heroImageバナーのヒーロー画像の画像リンク。https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3
positionCitrusAdのレスポンスにおけるバナーの位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。1
secondaryBackgroundImage二番目の背景画像の画像リンク。https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3
secondaryBackgroundImagePosition二番目の背景画像の位置タイプを定義します。leftaligned
rightaligned
secondaryHeroImageAltText万が一、二番目のヒーロー画像が表示されない場合の代替テキスト。Image of [brand] logo
secondaryHeroImage二番目のヒーロー画像の画像リンク。https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3
secondaryHeroMode二番目のヒーロー画像の表示モードを定義します。値がない場合は、次をデフォルトに設定する必要があります： block .block
landscape
slotIdリクエストしたバナーのスロットID。複数のバナーをリクエストする場合、これを使用して、リクエストされたIDを参照できます。Category_Top
tagsこのフィールドは、広告主がキャンペーンで入力したサードパーティタグを返します。APIレスポンスはフォーマットされていますが、バナーXでは現在サポートされていません。{}

ブランドページのリクエスト項目

文字列説明必須/任意
catalogIdウェブサイト用の商品カタログの識別子。必須
placement広告の依頼対象となる特定のプレースメント。必須
brandPageIdブランドページの一意のIDです。
この値は、ブランドページの一意のURLサフィックスです。		必須

商品広告のリターンアイテム

文字列説明値例
pageContentText広告主により入力されたページコンテンツです。一般的には、ブランドページのコンテンツを宣伝するための1～2段落から成る文章です。ミルクチョコチャンクは、ミルクチョコレートをベースに、ホワイトチョコレートでコーティングしたサクサクのウエハースバーとクッキーのかけらをトッピングした、クッキー好きにはたまらないお菓子です。

170gのブロックと45gのバーからお選びください。
pageHeaderTextブランドページの見出し新発売のチョコクッキー

📘

広告のキャンペーンの一部として設定されていないフィールドがある場合、そのフィールドは配信されません。例：広告主が heroImageを設定していない場合、CitrusAdは heroImage プロパティを提供しません。