API ของคู่ค้า

ข้อกําหนดการผสานการทํางาน

ภาพรวมระดับสูง

คุณจะต้องดำเนินการดังต่อไปนี้ซึ่งเป็นส่วนหนึ่งของการผสานรวมนี้

  1. ใช้คำขอโฆษณาเพิ่มเติมสำหรับตำแหน่งหมวดหมู่การขายต่อเนื่อง
    1. ซึ่งรวมถึงงานเพื่อวางตำแหน่งและแสดงโฆษณาบนไซต์ของคุณ ตลอดจนรายงานการคลิกและการแสดงผล
    2. คุณต้องส่งคำสั่งซื้อให้กับ CitrusAd ซึ่งเป็นส่วนหนึ่งของการผสานรวมมาตรฐานของคุณ
  2. หากคุณซิงโครไนซ์รหัสหมวดหมู่กับ CitrusAd คุณจะต้องใช้ filterMapping API เพื่อให้ค่าที่มนุษย์อ่านได้สําหรับการเลือกหมวดหมู่ UI
    1. สิ่งนี้ใช้ได้เฉพาะเมื่อคุณรวมเข้ากับรหัสหมวดหมู่แทนชื่อ (เช่น เมื่อคุณขอโฆษณา ตัวกรองของคุณคือ category:123j-dsef-er แทนที่ category:Milk
  3. (แนะนำ) - ซิงโครไนซ์การแมปการขายต่อเนื่องของหมวดหมู่ เพื่อให้การอนุมัติเป็นอัตโนมัติและลดภาระการจัดการแคมเปญ

คําขอโฆษณาและการผสานรวมไซต์

คําขอโฆษณา

เนื่องจากการขายต่อเนื่องหมวดหมู่ต้องใช้ตําแหน่งการจัดวางแบบสแตนด์อโลน คุณจึงต้องผสานรวมคําขอโฆษณาเพิ่มเติมต่อประเภทโฆษณาที่คุณกําลังผสานรวมหมวดหมู่การขายต่อเนื่อง

รูปแบบคำขอของคุณควรตรงกับคำขอโฆษณาหมวดหมู่การขายต่อเนื่องตามรายการด้านล่าง

การรายงานการแสดงผลและการคลิก

เมื่อคุณผสานรวมคำขอโฆษณาของคุณแล้ว คุณจะต้องตรวจสอบให้แน่ใจว่าคุณรายงานการคลิกและการแสดงผลอย่างถูกต้องสำหรับโฆษณาแต่ละรายการที่แสดง ตรวจสอบให้แน่ใจว่าคุณได้อ่าน การรายงานการแสดงผลและการคลิก

การรายงานคําสั่งซื้อ

โดยทั่วไป การผสานรวมส่วนใหญ่จะรายงานข้อมูลคำสั่งซื้อทั้งหมดไปยัง CitrusAd ตามการผสานรวมมาตรฐาน คุณต้องแน่ใจว่าคุณรายงานคำสั่งซื้อทั้งหมดอย่างถูกต้องไปยัง CitrusAd ตาม ข้อมูลคำสั่งซื้อ

การแมปตัวกรอง

สามารถใช้เอนพอยต์การแมปตัวกรองเพื่อแมปรหัสหมวดหมู่ของคุณกับค่าที่มนุษย์อ่านได้ จำเป็นต้องมีหากคุณซิงโครไนซ์รหัสหมวดหมู่เนื่องจาก UI แสดงค่าให้กับผู้ใช้ของคุณ

📘

หากคุณซิงโครไนซ์หมวดหมู่ที่มนุษย์อ่านได้ในแคตตาล็อกผลิตภัณฑ์ของคุณกับ CitrusAd ขั้นตอนนี้จะไม่จำเป็น

ผู้ใช้จะไม่เข้าใจสิ่งที่ category:12345-abcde คือ สามารถใช้ filterMapping API เพื่อแมปค่ากับชื่อหมวดหมู่ที่เกี่ยวข้องบนเว็บไซต์ของคุณ เช่น category:Pantry.

ไม่มีวิธีการแบบไฟล์ในการซิงโครไนซ์ข้อมูลนี้ แต่จะต้องทำผ่าน filterMapping API

🚧

เมื่อคุณสร้างหมวดหมู่เพิ่มเติมบนไซต์ของคุณ คุณจะต้องแน่ใจว่ามีการใช้ filterMapping API เพื่ออัปเดตหมวดหมู่

การแมปการขายต่อเนื่องตามหมวดหมู่ (แนะนำ)

ขอแนะนำอย่างยิ่งเมื่อผสานรวมตำแหน่งประเภทนี้เข้าด้วยกัน เพื่อจัดทำการแมปว่าหมวดหมู่ใดบ้างที่ได้รับอนุญาตให้กำหนดเป้าหมายซึ่งกันและกัน การกระทำนี้ปรับปรุงการดำเนินงานของคุณหลังจากงานการผสานรวมครั้งแรก ประสบการณ์ของผู้ลงโฆษณาได้รับการปรับปรุงให้อนุญาตเฉพาะหมวดหมู่ที่ได้รับอนุญาตให้เลือกแล้วเท่านั้น

นอกจากนี้ ยังสามารถกำหนดค่าการอนุมัติอัตโนมัติสำหรับแคมเปญหมวดหมู่การขายต่อเนื่องได้เมื่อมีการแมปการขายต่อเนื่อง

วิธีการผสานรวม

  • คุณสามารถใช้ crossSellCategory API เพื่อสร้างและจัดการการแมปได้ตามที่คุณต้องการ
  • หรือคุณสามารถจัดเตรียมไฟล์ TSV ให้กับที่เก็บข้อมูล GCS ที่โฮสต์โดย CitrusAd โดยมีรูปแบบตามรายการด้านล่าง

การผสานรวม API

ข้อมูลที่จำเป็นทั้งหมดสามารถดูได้ในการอ้างอิง crossSellCategory API

การผสานรวมไฟล์

หากผสานรวมตามไฟล์ CitrusAd ต้องใช้ไฟล์ต่อแคตตาล็อก ซึ่งหมวดหมู่ต่างๆ ได้รับอนุญาตให้กำหนดเป้าหมายระหว่างกัน

แต่ละแถวในไฟล์แสดงถึงการแมปหมวดหมู่เดียว และหมวดหมู่ที่สามารถกำหนดเป้าหมายได้ การทำแผนที่แต่ละครั้งเป็นแบบทิศทางเดียว (หากคุณซิงโครไนซ์ช็อกโกแลต -> นม ผลิตภัณฑ์ช็อกโกแลตสามารถปรากฏในหมวดหมู่นมได้ หากผลิตภัณฑ์นมจำเป็นต้องสามารถปรากฏบนช็อกโกแลต และต้องมีแถวเพิ่มเติม)

เราต้องมีฟีดข้อมูลในรูปแบบ TSV ที่สอดคล้องกับข้อกำหนดด้านล่าง:

ชื่อคอลัมน์ต้องระบุประเภทข้อมูลคำอธิบายตัวอย่าง
categoryต้องระบุข้อความนี่คือรหัสหมวดหมู่ที่ไม่ซ้ำกันซึ่งระบุหมวดหมู่ของผลิตภัณฑ์ที่โฆษณาcategory:cookies
cross_category_idต้องระบุข้อความนี่คือรหัสหมวดหมู่ที่ไม่ซ้ำกันซึ่งระบุหมวดหมู่ที่มีสิทธิ์ซึ่งผลิตภัณฑ์ของ category_id สามารถนำไปขายต่อได้category:milk

ข้อกำหนดไฟล์เพิ่มเติมอยู่ด้านล่าง:

  • รองรับไฟล์ TSV เท่านั้น
  • TSV ควรอยู่ใน LF ไม่ใช่ CRLF
  • TSV ควรเข้ารหัสแบบ UTF-8 ประเภทใดก็ตามจะทำให้ฟีดล้มเหลว
  • จำเป็นต้องมีแบบแผนการตั้งชื่อ: ^cross_sell_category.*.tsv$

ตัวอย่างข้อมูลโค้ดจะมีลักษณะดังนี้:

หมวดหมู่cross_category_id
หมวดหมู่:คุกกี้หมวดหมู่:นม
หมวดหมู่:คุกกี้หมวดหมู่:ช็อกโกแลต
หมวดหมู่:นมหมวดหมู่:คุกกี้

ตัวอย่างด้านบนนี้ช่วยให้หมวดหมู่ คุกกี้ สามารถขายต่อเนื่องในหมวดหมู่ นม และ ช็อกโกแลต หมวดหมู่นม สามารถขายต่อเนื่องเข้าสู่หมวด คุกกี้ สามารถกำหนดเป้าหมายหมวดหมู่ ช็อกโกแลต แต่ไม่สามารถกำหนดเป้าหมายหมวดหมู่อื่นได้

❗️

แต่ละแถวเป็นชุดค่าผสมการแมปที่ไม่ซ้ำกัน

คุณต้องซิงโครไนซ์แถวที่ไม่ซ้ำกันสำหรับการแมปหมวดหมู่การขายต่อเนื่องที่ไม่ซ้ำกันแต่ละรายการ การพยายามซิงโครไนซ์ cross_category_id หลายรายการในแถวเดียว การนำเข้าไฟล์จะล้มเหลว

กระบวนการเปิดใช้งานคุณสมบัติ

เมื่อคุณพร้อมเริ่มซิงค์ฟีดข้อความค้นหาที่แนะนำ CitrusAd จะกำหนดค่าที่เก็บข้อมูล GCS ให้คุณวางไฟล์ของคุณลงไป

ความสามารถนี้รองรับเฉพาะที่เก็บข้อมูล GCS เท่านั้น ไม่รองรับที่เก็บข้อมูลภายนอก เช่น AWS/Azure/อื่นๆ

ผู้จัดการบัญชีทางเทคนิคของคุณจะสามารถแนะนำคุณตลอดการเปิดใช้งานคุณสมบัตินี้ได้ เนื่องจากทีมปฏิบัติการแพลตฟอร์มของ CitrusAd จำเป็นต้องดำเนินการกำหนดค่า โปรดทราบว่าต้องใช้เวลาดำเนินการเพิ่มเติมในการเปิดใช้งาน