เวิร์กโฟลว์ API

คู่มือนี้อธิบายเวิร์กโฟลว์ API ทั่วไปสำหรับการสร้าง ยกเลิก ดึงข้อมูล อัปเดต และเจรจาต่อรองดีลโดยใช้ Deal Sync API

สร้างดีล

  1. ตรวจสอบว่าได้สร้างผลิตภัณฑ์แล้วหรือยังโดยเรียก LIST products ด้วยตัวกรอง externalDealId โปรดทราบว่าระบบรองรับทั้ง externalDealId แบบ camelCase และ external_deal_id แบบ snake_case ในสตริงตัวกรอง external_deal_id ต้องไม่ซ้ำกันในทุกผลิตภัณฑ์

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"

  2. สร้าง คำสั่งซื้อ. ระบบ DV360 จะสร้างชื่อคำสั่งซื้อ และเราขอแนะนำให้จัดเก็บรหัสนี้ไว้ในระบบเพื่อดึงข้อมูลในอนาคต

  3. สร้างผลิตภัณฑ์ภายใต้ คำสั่งซื้อ ระบบ DV360 จะสร้างชื่อผลิตภัณฑ์ และเราขอแนะนำให้จัดเก็บรหัสนี้ไว้ในระบบเพื่อดึงข้อมูลในอนาคต

หรือจะเรียก LIST ด้วย external_deal_id ก็ได้ ชื่อทรัพยากรจะมีทั้งรหัสคำสั่งซื้อและรหัสผลิตภัณฑ์ คุณจึงระบุคำสั่งซื้อระดับบนได้

ยกเลิกดีล

  1. อัปเดตสถานะการสั่งซื้อเป็น CANCELED ระบบจะรองรับการยกเลิกก็ต่อเมื่อยังไม่มีการยอมรับคำสั่งซื้อ CANCELED เป็นสถานะสิ้นสุด คุณจะเปิดใช้งานคำสั่งซื้ออีกครั้งไม่ได้เมื่อยกเลิกแล้ว หากคำสั่งซื้อมีผลิตภัณฑ์ external_deal_id ของผลิตภัณฑ์เหล่านั้นจะนำกลับมาใช้ซ้ำไม่ได้

ดูรายละเอียดของดีล

  1. ดูรายละเอียดของ คำสั่งซื้อ สถานะจะอัปเดตเมื่อผู้ใช้ยอมรับ เก็บ หรือยกเลิกคำสั่งซื้อ
  2. ดูรายละเอียดของ ผลิตภัณฑ์

ดูรายการดีล

  1. เรียก LIST orders ด้วยตัวกรองสถานะเพื่อดูคำสั่งซื้อทั้งหมดที่ยอมรับแล้วหรือรอการยอมรับ
  2. เรียก LIST products ด้วยตัวกรอง external_deal_id
  3. เรียก LIST ผลิตภัณฑ์ทั้งหมดภายในคำสั่งซื้อ

อัปเดตดีล

  1. อัปเดต คำสั่งซื้อสำหรับข้อมูลติดต่อของผู้เผยแพร่โฆษณา
    1. อัปเดต name ไม่ได้ (ตั้งค่าใน updateMask ไม่ได้) คุณจะตั้งค่าสถานะเป็น CANCELED ได้โดยใช้ API เท่านั้น
    2. อัปเดต partner_id ไม่ได้
  2. อัปเดต ผลิตภัณฑ์สำหรับการอัปเดตข้อกำหนดของดีลที่เฉพาะเจาะจง
    1. name, externalDealId, transactionType, pricingType, และ updateTime อัปเดตไม่ได้
    2. การอัปเดต displayName ไม่ต้องให้ผู้ใช้ยอมรับอีกครั้ง
    3. การอัปเดต rateDetails หรือ creativeConfig จะเปลี่ยนสถานะคำสั่งซื้อระดับบนเป็น PENDING_ACCEPTANCE ระบบจะขอให้ผู้ลงโฆษณา DV360 ยอมรับข้อกำหนดใหม่ในหน้าการเจรจาต่อรอง ไม่ว่าคำสั่งซื้อก่อนหน้าจะได้รับการยอมรับแล้วหรือไม่ก็ตาม

ตรวจสอบว่าผู้ใช้ยอมรับดีลแล้วหรือยัง

  1. เรียก คำสั่งซื้อ หากทราบชื่อคำสั่งซื้อที่เกี่ยวข้อง ตรวจสอบช่อง status
  2. หากไม่ได้ติดตามชื่อคำสั่งซื้อ: เรียก List Products ด้วยตัวกรอง external_deal_id, ระบุชื่อคำสั่งซื้อจาก ชื่อผลิตภัณฑ์, แล้วเรียก Get Order ตรวจสอบช่อง status

ตรวจสอบว่าผู้ใช้กำหนดค่าดีลแล้วหรือยัง (การรับประกันแบบเป็นโปรแกรมเท่านั้น)

  1. เรียกแหล่งที่มาของพื้นที่โฆษณา ชื่อทรัพยากรคือ exchanges/{exchangeId}/inventorysources/{external_deal_id} ตรวจสอบสถานะ ผู้ซื้อ
    1. ดีลแบบจองล่วงหน้า
      1. BUYER_STATUS_ACTIVE: ดีลได้รับการยอมรับและกำหนดค่าแล้ว ดีลจะเริ่มใช้จ่ายเมื่อ DV360 ได้รับคำขอราคาเสนอที่ตรงกับข้อกำหนดของดีล ระบบจะสร้างรายการโฆษณาโดยอัตโนมัติระหว่างการกำหนดค่าดีล ดูรายละเอียดได้ที่การกำหนดค่า ดีล
      2. BUYER_STATUS_PENDING: คำสั่งซื้อได้รับการยอมรับแล้ว แต่ยังไม่ได้กำหนดค่าดีล ไม่มีการใช้จ่ายในสถานะนี้
      3. BUYER_STATUS_PAUSED: ผู้ลงโฆษณาหยุดดีลชั่วคราว ไม่มีการใช้จ่ายในสถานะนี้
    2. ดีลที่ไม่ใช่แบบจองล่วงหน้า
      1. BUYER_STATUS_ACTIVE: ดีลได้รับการยอมรับแล้ว ดีลจะเริ่มใช้จ่ายเมื่อ DV360 ได้รับคำขอราคาเสนอที่ตรงกัน รายการโฆษณาที่ใช้งานอยู่กำหนดเป้าหมายเป็นดีล และคำขอราคาเสนอตรงกับเกณฑ์การกำหนดเป้าหมายของรายการโฆษณา ดูรายละเอียดได้ที่รายการ โฆษณา (หมายเหตุ: ไม่มี Seller API สำหรับค้นหาว่ารายการโฆษณากำหนดเป้าหมายเป็นดีลหรือไม่)
      2. BUYER_STATUS_PENDING: ไม่สามารถใช้ได้กับดีลที่ไม่ใช่แบบจองล่วงหน้า
      3. BUYER_STATUS_PAUSED: ผู้ลงโฆษณาหยุดดีลชั่วคราวอย่างชัดเจน ไม่มีการใช้จ่ายในสถานะนี้

หยุดและกลับมาแสดงดีลอีกครั้งหลังจากยอมรับแล้ว

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

การเจรจาต่อรองใหม่ (การอัปเดตดีลหลังจากยอมรับแล้ว)

การเจรจาต่อรองใหม่หมายถึงการอัปเดตดีลหลังจากที่ผู้ซื้อยอมรับแล้ว ซึ่งจะช่วยให้ Exchange และผู้ซื้อปรับข้อกำหนดในดีลที่มีอยู่ได้ ตัวอย่างเช่น Exchange อาจพบว่าเวลาสิ้นสุดของดีลที่ยอมรับแล้ว ไม่ถูกต้อง Exchange สามารถใช้ Product Patch เพื่อส่งการอัปเดตไปยังผู้ซื้อ DV360 ก่อนที่ดีลจะเริ่มแสดง

การเปลี่ยนแปลงที่อนุญาตและไม่อนุญาต

ดูรายละเอียดทั้งหมดเกี่ยวกับการเจรจาต่อรองดีลและกฎการเจรจาต่อรองอีกครั้งได้ในบทความในศูนย์ช่วยเหลือของ Display &Video 360 ดังนี้

ก่อนหน้า
โครงสร้างเอนทิตี
ถัดไป
กระบวนการเบต้า