The below outlines the properties possible in a standard request as outlined in Requesting ads for your request, and the response if you receive an ad.
รายการที่ร้องขอ
| สตริง | คำอธิบาย | จำเป็นต้องใช้/ไม่บังคับ |
|---|---|---|
BannerSlotIds | มีการร้องขออาร์เรย์ json ของแบนเนอร์ slotIds | ต้องระบุ |
catalogId | ตัวระบุแคตตาล็อกผลิตภัณฑ์สำหรับเว็บไซต์ของคุณ | ต้องระบุ |
contentStandardId | ตัวระบุมาตรฐานเนื้อหาสำหรับเว็บไซต์ของคุณ | ต้องระบุ |
customerId | ตัวระบุที่ไม่ซ้ำสำหรับลูกค้าเห็นโฆษณา | ไม่บังคับ |
filterMode | Optional way of defining the structure of your request. See Ad generation filtering for more information. | ไม่บังคับ, ที่ต้องการ |
maxNumberOfAds | จำนวนสูงสุดของช่องแบนเนอร์แต่ละช่องที่คุณต้องการส่งคืน | ต้องระบุ |
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 | ตัวกรองผลิตภัณฑ์ใดๆ ที่เกี่ยวข้องกับคำขอของคุณ เช่น ตัวกรองหมวดหมู่ สถานที่ตั้ง หรือขนาด | จําเป็นสําหรับตําแหน่งในหมวดหมู่ |
searchTerm | ข้อความค้นหาที่ลูกค้าของคุณป้อนลงในเว็บไซต์ของคุณ | จําเป็นสําหรับตําแหน่งการค้นหา |
sessionId | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow optionsfor more information. | จำเป็นสำหรับการผสานการทำงานแบบมาตรฐาน |
slotId | ซึ่งมี SlotId ที่ร้องขอในบริบท อาจมีหนึ่งหรือหลายรายการ | ต้องระบุ |
dtmCookieId | คุกกี้ที่สร้างและจัดเก็บโดยเว็บไซต์ใช้เพื่อติดตามพฤติกรรมของผู้ใช้บนโดเมนเดียวกัน | ไม่บังคับ |
audience | Specifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3 | ไม่บังคับ |
รายการที่ส่งคืน
| สตริง | คำอธิบาย | ค่าตัวอย่าง |
|---|---|---|
ads.backgroundColour | สีพื้นหลังของแบนเนอร์ - ค่า HEX เท่านั้น | 6e6c6c |
ads.backgroundImage | ลิงก์ภาพของภาพพื้นหลังแบนเนอร์ | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].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 | รหัสที่ไม่ซ้ํากันของโฆษณา นี่เป็นข้อมูลเฉพาะสำหรับแต่ละคำขอที่ส่งไปยัง Epsilon Retail Media และไม่สามารถแคชได้ | shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3 |
ads.citrusCampaignName | ชื่อแคมเปญของโฆษณา | Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6 |
ads.citrusContentStandardId | รหัสมาตรฐานเนื้อหาที่เกี่ยวข้องกับช่อง | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.citrusExpiry | การหมดอายุของโฆษณา นี่คือจุดล่าสุดที่สามารถรายงานการคลิกไปยัง Epsilon Retail Media ได้ | 2021-06-01T23:48:16.573967987Z |
ads.citrusSlotId | รหัสของช่องเฉพาะสำหรับแบนเนอร์ที่คุณร้องขอ | Category_Top |
ads.contentStandardId | รหัสมาตรฐานเนื้อหาที่เกี่ยวข้องกับช่อง ซ้ำกันของ citrusContentStandardId | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.ctaFlag | ซึ่งกำหนดว่า CTA จะแสดงหรือไม่ | truefalse |
ads.ctaLink | URL ที่ส่งต่อจาก CTA (เหมือนกับ 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.[server].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.[server].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.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
ads.secondaryHeroMode | สิ่งนี้กำหนดโหมดการแสดงผลของภาพฮีโร่รอง หากไม่มีค่า คุณจะต้องตั้งค่าเริ่มต้นเป็น block | blocklandscape |
ads.slotId | รหัสช่องของแบนเนอร์ที่คุณร้องขอ เมื่อขอแบนเนอร์หลายอัน สามารถใช้เพื่ออ้างอิง ID ที่ร้องขอได้ | Category_Top |
ads.tags | ฟิลด์นี้ส่งคืนแท็กของบุคคลที่สามที่ป้อนโดยผู้โฆษณาในแคมเปญของตน ขณะนี้แบนเนอร์ x ไม่รองรับ แม้ว่าจะมีการจัดรูปแบบการตอบสนอง API | {} |
ads.sellerId | รหัสเฉพาะของผู้ขาย จะเติมก็ต่อเมื่อมีการตั้งค่ารหัสผู้ขายในทีม มักใช้รหัสผู้ขายเมื่อแนะนำการใช้งานผู้ขายในตลาด | 73nns-32sxr-32ss กําหนดเองต่อการผสานการทํางาน |
ads.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" } ... |
ads.adm | ออบเจกต์ที่ประกอบด้วยรายละเอียดโฆษณาวิดีโอรวมทั้งแท็ก VAST | "\n<VAST version="4.0">\n <Ad id="1">\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" ] } |
หากมีฟิลด์ที่ไม่ได้กำหนดค่าเป็นส่วนหนึ่งของแคมเปญของโฆษณา ฟิลด์นั้นจะไม่แสดงผล กล่าวคือ หากผู้โฆษณาไม่ได้กำหนดค่า
heroImageEpsilon Retail Media จะไม่แสดงคุณสมบัติheroImage

