バナー広告(静止)のリファレンス

以下はリクエストに対する「広告のリクエスト」で説明された、標準的なリクエストで可能なプロパティと、広告を取得した場合のレスポンスの概要です。

📘

バナー広告は、商品広告と同じ /generate エンドポイントにリクエストされます。1つのリクエストで両方の広告タイプを取得することができます。

リクエストされたアイテム

文字列説明必須/任意
bannerSlotsバナー広告を受け取る理由となるバナースロットの配列。バナースロットに対してmaxNumberOfAdsを指定すると、そのスロットに対して複数の広告を取得できます。カルーセルプレースメントの場合などに使用されます。必須
bannerSlotIdsバナー広告を受け取る理由となるバナースロットの配列必須。bannerSlotsが優先になります。
catalogIdウェブサイト用の商品カタログの識別子。必須
contentStandardIdウェブサイトのコンテンツ規格識別子。必須
customerId広告の配信対象となる顧客の一意の識別子。任意
filterModeリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
maxNumberOfAds返される商品広告の最大数(最大は15)。必須。商品広告を同一リクエストで配信できるようにします。商品広告を希望しない場合は、次に設定します: 0
optionsリクエストの構造を定義するもう1つの方法です。詳しくは、「広告生成フィルタリング」を参照してください。任意、優先
placement広告の依頼対象となる特定のプレースメント。必須
productFiltersリクエストに関連する商品のフィルタ。カテゴリ、場所、サイズなど。必須
sessionId顧客のセッションに対する一意の識別子です。標準的な統合でアトリビューションに使用されます。詳しくは、「統合ワークフローオプション」を参照してください。標準的な統合に必要

リターンアイテム

文字列説明値例
altText万が一、ヒーロー画像が表示されない場合の代替テキスト。Advertisement for <BRAND>. Art of the Burger. Create your delicious masterpiece. Shop Now.
contentStandardIdウェブサイトのコンテンツ規格識別子。`4ffb80ba-b9a9-4567-8069-79b2eca93473
expiry広告の有効期限。CitrusAdにクリックが報告される最終の時点です。2021-06-01T23:48:16.573967987Z
id広告の一意のID。
これは、CitrusAdへの各リクエストに固有のもので、キャッシュできません。
banner_j2vfi9pN2BiQZk4X9sC55PgNu5k3ODIzOTlfMDAwODc2ODQwMDEwNzM=
imageUrlバナーの画像リンク。[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[サーバー].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
gtinsキャンペーンの広告対象商品から選択された最大20個の商品コードの配列。 [ "7714107", "7163379", "7733636", "7733657", "7733628" ],
linkUrl顧客がバナーをクリックした際に、バナーから転送されるURL。<https://www.retailer.com/groceries/en-GB/search?query=double-fudge>
slotIdリクエストしたバナーに関する特定のスロットのID。Category_Top
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>" }
textカスタムメイドのインテグレーションで、追加のテキストフィールドとして使用されます。
positionCitrusAdのレスポンスにおける広告の位置。固定契約キャンペーンを利用する場合は、この位置を尊重する必要があります。1
sellerId出品者の一意のID。チームにsellerIdが設定されている場合にのみ設定されます。sellerIdは通常、マーケットプレイス出品者をオンボーディングするときに使用されます。73nns-32sxr-32ss 統合ごとのカスタム