ด้านล่างสรุปคุณสมบัติที่เป็นไปได้ในคําขอมาตรฐานตามที่ระบุไว้ใน คําขอโฆษณา สําหรับคําขอของคุณและการตอบกลับ หากคุณได้รับโฆษณา
รายการที่ร้องขอ
สตริง | คำอธิบาย | จำเป็นต้องใช้/ไม่บังคับ |
---|---|---|
BannerSlotIds | มีการร้องขออาร์เรย์ json ของแบนเนอร์ slotIds | ต้องระบุ |
catalogId | ตัวระบุแคตตาล็อกผลิตภัณฑ์สำหรับเว็บไซต์ของคุณ | ต้องระบุ |
contentStandardId | ตัวระบุมาตรฐานเนื้อหาสำหรับเว็บไซต์ของคุณ | ต้องระบุ |
customerId | ตัวระบุที่ไม่ซ้ำสำหรับลูกค้าเห็นโฆษณา | ไม่บังคับ |
filterMode | ทางเลือกในการกำหนดโครงสร้างคำขอของคุณ ดูข้อมูลเพิ่มเติมที่การกรองการสร้างโฆษณา | ไม่บังคับ, ที่ต้องการ |
maxNumberOfAds | จำนวนสูงสุดของช่องแบนเนอร์แต่ละช่องที่คุณต้องการส่งคืน | ต้องระบุ |
options | ทางเลือกในการกำหนดโครงสร้างคำขอของคุณ ดูข้อมูลเพิ่มเติมที่การกรองการสร้างโฆษณา | ไม่บังคับ, ที่ต้องการ |
placement | ตําแหน่งการจัดวางที่ไม่ซ้ํากันที่คุณขอโฆษณา | ต้องระบุ |
productFilters | ตัวกรองผลิตภัณฑ์ใดๆ ที่เกี่ยวข้องกับคำขอของคุณ เช่น ตัวกรองหมวดหมู่ สถานที่ตั้ง หรือขนาด | จําเป็นสําหรับตําแหน่งในหมวดหมู่ |
searchTerm | ข้อความค้นหาที่ลูกค้าของคุณป้อนลงในเว็บไซต์ของคุณ | จําเป็นสําหรับตําแหน่งการค้นหา |
sessionId | ตัวระบุที่ไม่ซ้ำของเซสชันของลูกค้า ใช้สำหรับการระบุแหล่งที่มาในการผสานการทำงานมาตรฐาน ตรวจสอบ ตัวเลือกเวิร์กโฟลว์การรวม สำหรับข้อมูลเพิ่มเติม | จำเป็นสำหรับการผสานการทำงานแบบมาตรฐาน |
slotId | ซึ่งมี SlotId ที่ร้องขอในบริบท อาจมีหนึ่งหรือหลายรายการ | ต้องระบุ |
dtmCookieId | คุกกี้ที่สร้างและจัดเก็บโดยเว็บไซต์ใช้เพื่อติดตามพฤติกรรมของผู้ใช้บนโดเมนเดียวกัน | ไม่บังคับ |
รายการที่ส่งคืน
สตริง | คำอธิบาย | ค่าตัวอย่าง |
---|---|---|
backgroundColour | สีพื้นหลังของแบนเนอร์ - ค่า HEX เท่านั้น | 6e6c6c |
backgroundImage | ลิงก์ภาพของภาพพื้นหลังแบนเนอร์ | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3 >](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 | รหัสที่ไม่ซ้ํากันของโฆษณา เป็นรหัสที่ไม่ซ้ำกันสำหรับคำขอแต่ละรายการที่ทำกับ CitrusAd และไม่สามารถแคชได้ | shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3 |
citrusCampaignName | ชื่อแคมเปญของโฆษณา | CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6 |
citrusContentStandardId | รหัสมาตรฐานเนื้อหาที่เกี่ยวข้องกับช่อง | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
citrusExpiry | การหมดอายุของโฆษณา นี่คือจุดล่าสุดที่สามารถรายงานการคลิกไปยัง CitrusAd | 2021-06-01T23:48:16.573967987Z |
citrusSlotId | รหัสของช่องเฉพาะสำหรับแบนเนอร์ที่คุณร้องขอ | Category_Top |
contentStandardId | รหัสมาตรฐานเนื้อหาที่เกี่ยวข้องกับช่อง ซ้ำกันของ citrusContentStandardId | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ctaFlag | ซึ่งกำหนดว่า CTA จะแสดงหรือไม่ | true false |
ctaLink | URL ที่ส่งต่อจาก CTA (เหมือนกับ linkUrl สำหรับแบนเนอร์) ให้บริการเฉพาะเมื่อ ctaFlag เป็น true | <https://www.retailer.com/groceries/en-GB/search?query=double-fudge > |
ctaText | ข้อความภายใน CTA | Shop now |
ctaTextAccessibility | ข้อความการสามารถเข้าถึงของ CTA สำหรับผู้ใช้โปรแกรมอ่านหน้าจอ | for Double Fudge Ice Cream |
gtins | อาร์เรย์รหัสผลิตภัณฑ์สูงสุด 20 รหัสที่เลือกจากผลิตภัณฑ์ที่โฆษณาของแคมเปญ ผู้ค้าปลีกอาจใช้รายการนี้เพื่อทําให้หน้าผู้ลงรายการเป็นแบบอัตโนมัติเมื่อคลิกแบนเนอร์หรือทําให้ฟังก์ชันการแสดงผลบางอย่างเป็นอัตโนมัติ (วงกลมมีจุด การกําหนดราคา การตรวจสอบระดับสต็อกรอง) | [ "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 >](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
position | ตำแหน่งของแบนเนอร์ในการตอบกลับ CitrusAd คุณควรรักษาตำแหน่งนี้ไว้ในกรณีที่มีการใช้แคมเปญผู้เช่าคงที่ | 1 |
secondaryBackgroundImage | ลิงก์ภาพของภาพพื้นหลังรอง | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3 >](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 >](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
secondaryHeroMode | สิ่งนี้กำหนดโหมดการแสดงผลของภาพฮีโร่รอง หากไม่มีค่า คุณจะต้องตั้งค่าเริ่มต้นเป็น block . | block landscape |
slotId | รหัสช่องของแบนเนอร์ที่คุณร้องขอ เมื่อขอแบนเนอร์หลายอัน สามารถใช้เพื่ออ้างอิง ID ที่ร้องขอได้ | Category_Top |
tags | ฟิลด์นี้ส่งคืนแท็กของบุคคลที่สามที่ป้อนโดยผู้โฆษณาในแคมเปญของตน ขณะนี้แบนเนอร์ x ไม่รองรับ แม้ว่าจะมีการจัดรูปแบบการตอบสนอง API | {} |
sellerId | รหัสเฉพาะของผู้ขาย จะเติมก็ต่อเมื่อมีการตั้งค่ารหัสผู้ขายในทีม มักใช้รหัสผู้ขายเมื่อแนะนำการใช้งานผู้ขายในตลาด | 73nns-32sxr-32ss กําหนดเองต่อการผสานการทํางาน |
หากมีฟิลด์ที่ไม่ได้กำหนดค่าเป็นส่วนหนึ่งของแคมเปญของโฆษณา ฟิลด์นั้นจะไม่แสดงผล กล่าวคือ หากผู้โฆษณาไม่ได้กำหนดค่า
heroImage
CitrusAd จะไม่ให้บริการheroImage
ทรัพย์สิน