เกตเวย์ API คอนเวอร์ชั่นสำหรับ Control Plane API แบบหลายบัญชี

การผสานการทำงานกับพาร์ทเนอร์

ภาพรวม

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

กรณีการใช้งานที่เป็นไปได้มีดังนี้

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

โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับขั้นตอนการผสานการทำงานที่เนื้อหาในส่วนด้านล่างนี้

เราจะใช้คำว่าเกตเวย์ API คอนเวอร์ชั่นสำหรับ Control Plane API แบบหลายบัญชีหรือเกตเวย์แทนกันได้ในเอกสารฉบับนี้

คู่มือการผสานการทำงาน

คุณสามารถผสานการทำงานได้ 2 รูปแบบ (ดังที่แสดงในแผนภาพด้านล่าง) โดยขึ้นอยู่กับกรณีการใช้งาน ดังนี้

การผสานการทำงาน Control Plane API บางส่วน โดยรูปแบบนี้ไม่ต้องมีการยืนยันตัวตนจากผู้ลงโฆษณา
การผสานการทำงาน Control Plane API แบบสมบูรณ์ โดยรูปแบบนี้ต้องมีการยืนยันตัวตนจากผู้ลงโฆษณาโดยใช้ส่วนขยาย Meta Business (MBE) หรือสร้างโทเค็นด้วยตนเองอย่างใดอย่างหนึ่ง

ข้อกำหนดเบื้องต้น

ในการผสานการทำงานทั้ง 2 รูปแบบ พาร์ทเนอร์จำเป็นต้องดำเนินขั้นตอนต่อไปนี้ให้เสร็จสิ้นเสียก่อน

ขั้นตอนที่ 1: เริ่มต้นใช้งานในฐานะโฮสต์ของอินสแตนซ์เกตเวย์

ขั้นตอนที่ 2: สร้างชื่อบัญชี API และคีย์ลับของ API

ไปที่:

https://<Conversions API Gateway Endpoint>/hub/

ไปที่แท็บ "การตั้งค่าโฮสต์" เลือกหน้า "จัดการบัญชี API" จากนั้นคลิกปุ่ม "เพิ่มบัญชี API"

ป้อนรหัสผ่านของคุณอีกครั้ง คลิก "ดำเนินการต่อ"

ป้อนชื่อของบัญชี API คลิก "ดำเนินการต่อ"

ทั้งนี้ ชื่อบัญชีต้องประกอบด้วยตัวอักษรและตัวเลขเท่านั้น และห้ามเว้นวรรค โดยเราจำกัดความยาวสูงสุดที่ 20 อักขระ

คัดลอกและบันทึกคีย์ลับที่ระบบสร้างขึ้น ทั้งนี้คุณจะไม่สามารถดูคีย์นี้ได้อีกในภายหลัง

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

การผสานการทำงานบางส่วน

กรณีการใช้งานสำหรับการผสานการทำงานบางส่วนมีดังนี้

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

ขั้นตอนของผู้ใช้ระดับสูงจะมีลักษณะตามด้านล่างนี้

พาร์ทเนอร์สามารถผสานการทำงานชุดย่อยของ Control Plane API เพื่อดำเนินการตามข้างต้น ดังนี้

รับโทเค็นการเข้าถึง API
สร้างบัญชีสำหรับผู้ลงโฆษณา
รับข้อมูลการใช้งานบัญชีเพื่อวัตถุประสงค์ในการเรียกเก็บเงิน เป็นต้น

การผสานการทำงานแบบสมบูรณ์

กรณีการใช้งานสำหรับการผสานการทำงานแบบสมบูรณ์มีดังนี้

ผู้ลงโฆษณาเลือกใช้บริการเกตเวย์โดยใช้ UI ของพาร์ทเนอร์
พาร์ทเนอร์เริ่มต้นใช้งานบัญชีเกตเวย์ของผู้ลงโฆษณา และได้รับสิทธิ์การอนุญาตให้จัดการบัญชี โดยผู้โฆษณาจะให้สิทธิ์การอนุญาตแก่พาร์ทเนอร์โดยใช้ส่วนขยาย Meta Business (MBE) หรือสร้างโทเค็นด้วยตนเอง
ผู้ลงโฆษณาสามารถจัดการแหล่งข้อมูล ตลอดจนจัดการผู้ใช้บัญชี โดเมน และการกำหนดเส้นทางใน UI ของพาร์ทเนอร์ได้
พาร์ทเนอร์เรียกดูข้อมูลการใช้งานบัญชีของผู้ลงโฆษณาและใบเรียกเก็บเงินที่เกี่ยวข้อง

ขั้นตอนของผู้ใช้ระดับสูงจะมีลักษณะตามด้านล่างนี้

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

การยืนยันตัวตน

พาร์ทเนอร์มีตัวเลือกการยืนยันตัวตน 2 ตัวเลือกสำหรับพิกเซลของ Meta ที่ตนเองไม่ได้จัดการดังต่อไปนี้

ตัวเลือกที่ 1 - ส่วนขยาย Meta Business (MBE)

ก่อนเริ่มต้น คุณจะต้องดำเนินการดังต่อไปนี้

ทำตามข้อกำหนดทุกข้อในการนำ MBE ไปใช้
ติดต่อให้ตัวแทน Meta เพิ่มแอพของคุณลงในรายการที่อนุญาตเพื่อรับสิทธิ์การอนุญาตส่วนตัว: open_bridge_configuration_management

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

ตั้งค่าพารามิเตอร์ช่องทางในอ็อบเจ็กต์การกำหนดค่าการตั้งค่าเป็น CONVERSIONS_API_GATEWAY_ADVERTISER.
สามารถรับการตอบกลับจาก Webhook เมื่อการเริ่มต้นใช้งานเสร็จสิ้นแล้ว
ใช้โทเค็นการเข้าถึงที่ส่งคืนผ่าน FBE แล้วแปลงเป็นโทเค็นการเข้าถึงผู้ใช้ระบบด้วยการเรียกใช้ API เพิ่มเติม
บันทึกสำเนา external_business_id, pixel_id, business_id และโทเค็นการเข้าถึงผู้ใช้ระบบลงในระบบของคุณ

ตัวเลือกที่ 2 - โทเค็นการเข้าถึงผู้ใช้ระบบของไคลเอ็นต์

ตัวเลือกนี้ช่วยให้พาร์ทเนอร์อนุญาตให้ผู้ลงโฆษณาดำเนินการต่อไปนี้ได้

สร้างโทเค็นการเข้าถึงผู้ใช้ระบบด้วยตนเองผ่าน API คอนเวอร์ชั่นใน "การตั้งค่า" ภายในตัวจัดการเหตุการณ์ (EM)
แชร์ pixel_id, business_id และโทเค็นการเข้าถึงผู้ใช้ระบบกับพาร์ทเนอร์และบันทึกสำเนา

การผสานการทำงาน

พาร์ทเนอร์สามารถผสานการทำงานชุด Control Plane API แบบสมบูรณ์ได้ รายละเอียดเพิ่มเติมมีอธิบายอยู่ในเอกสารอ้างอิง API

ความทัดเทียมกันของ API และ UI

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