ด้านล่างนี้แสดงคุณสมบัติที่เป็นไปได้ในคำขอมาตรฐาน และการตอบสนองหากคุณได้รับโฆษณา
รายการที่ร้องขอ
| สตริง | คำอธิบาย | จำเป็นต้องใช้/ไม่บังคับ |
|---|---|---|
catalogId | ตัวระบุแคตตาล็อกผลิตภัณฑ์สำหรับเว็บไซต์ของคุณ | ต้องระบุ |
customerId | ตัวระบุที่ไม่ซ้ำสำหรับลูกค้าเห็นโฆษณา | ไม่บังคับ |
filterMode | ทางเลือกในการกำหนดโครงสร้างคำขอของคุณ ดูข้อมูลเพิ่มเติมที่การกรองการสร้างโฆษณา | ไม่บังคับ, ที่ต้องการ |
maxNumberOfAds | จำนวนโฆษณาสูงสุดที่คุณต้องการให้ส่งคืนสูงสุด 15 รายการ | ต้องระบุ |
options | ทางเลือกในการกำหนดโครงสร้างคำขอของคุณ ดูข้อมูลเพิ่มเติมที่การกรองการสร้างโฆษณา | ไม่บังคับ, ที่ต้องการ |
placement | ตําแหน่งการจัดวางที่ไม่ซ้ํากันที่คุณขอโฆษณา | ต้องระบุ |
productFilters | ตัวกรองผลิตภัณฑ์ใดๆ ที่เกี่ยวข้องกับคำขอของคุณ เช่น หมวดหมู่ สถานที่ หรือขนาด | ต้องระบุ |
sessionId | ตัวระบุที่ไม่ซ้ำของเซสชันของลูกค้า ใช้สำหรับการระบุแหล่งที่มาในการผสานการทำงานมาตรฐาน ตรวจสอบ ตัวเลือกเวิร์กโฟลว์การรวม สำหรับข้อมูลเพิ่มเติม | จำเป็นสำหรับการผสานการทำงานแบบมาตรฐาน |
memoryToken | ใช้สําหรับให้เลขหน้า ใช้โทเค็นที่ให้ไว้ในคำขอโฆษณาก่อนหน้าเพื่อให้แน่ใจว่า CitrusAd แสดงเฉพาะโฆษณาใหม่แก่ลูกค้าของคุณ หากมีให้ CitrusAd จะยกเว้นโฆษณาที่แสดงก่อนหน้านี้ในการตอบกลับโฆษณา ตรวจสอบการ แบ่งหน้า เพื่อเรียนรู้เพิ่มเติม | ไม่บังคับ |
รายการที่ส่งคืน
| สตริง | คำอธิบาย | ค่าตัวอย่าง |
|---|---|---|
customPayload | เพย์โหลดแบบกำหนดเองนี้ควรถูกเธรดจากไฟล์แค็ตตาล็อกไปยังการสร้างโฆษณา ฟิลด์ควรมีอ็อบเจ็กต์ JSON ที่ถูกต้องที่ถูกทำให้เป็นอนุกรมในอาร์เรย์ไบต์และเข้ารหัส Base64 อ็อบเจ็กต์ JSON ควรเป็นไปตามสคีมา | กําหนดเองต่อการผสานการทํางาน |
sellerId | รหัสเฉพาะของผู้ขาย จะเติมก็ต่อเมื่อมีการตั้งค่ารหัสผู้ขายในทีม มักใช้รหัสผู้ขายเมื่อแนะนำการใช้งานผู้ขายในตลาด | 73nns-32sxr-32ss กําหนดเองต่อการผสานการทํางาน |
id | รหัสที่ไม่ซ้ํากันของโฆษณา เป็นรหัสที่ไม่ซ้ำกันสำหรับคำขอแต่ละรายการที่ทำกับ CitrusAd และไม่สามารถแคชได้ | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
gtin | รหัสสินค้าของโฆษณา นี่จะเป็นรหัสผลิตภัณฑ์ที่ซิงโครไนซ์ในแค็ตตาล็อกผลิตภัณฑ์ของคุณ | 25813383 |
discount | มรดกสามารถละเว้นได้ | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
position | ตำแหน่งของโฆษณาในการตอบกลับ CitrusAd คุณควรรักษาตำแหน่งนี้ไว้ในกรณีที่มีการใช้แคมเปญผู้เช่าคงที่ | 1 |
memoryToken | ใช้สำหรับให้เลขหน้าและเชื่อมโยงคำขอโฆษณา หากระบุไว้ในคำขอโฆษณาครั้งต่อไปของคุณในบริบทเดียวกัน CitrusAd จะไม่รวมโฆษณาที่แสดงก่อนหน้านี้ในการตอบกลับโฆษณา ตรวจสอบ เลขหน้า เพื่อเรียนรู้เพิ่มเติม |