REST Resource: guaranteedOrders

ทรัพยากร: GuaranteedOrder

คำสั่งซื้อที่รับประกันการแสดงผล

คำสั่งซื้อที่รับประกันการแสดงผลเป็นเอนทิตีหลักของแหล่งที่มาของพื้นที่โฆษณาที่รับประกันการแสดงผล เมื่อสร้างแหล่งที่มาของพื้นที่โฆษณาที่รับประกันการแสดงผล คุณต้องกำหนดรหัสคำสั่งซื้อที่รับประกันการแสดงผลให้กับแหล่งที่มาของพื้นที่โฆษณา

การแสดง JSON 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของคำสั่งซื้อที่รับประกันการแสดงผล
legacyGuaranteedOrderId

string

เอาต์พุตเท่านั้น รหัสเดิมของคำสั่งซื้อที่รับประกันการแสดงผล กำหนดโดยตลาดหลักทรัพย์เดิม รหัสเดิมจะไม่ซ้ำกันภายใน Exchange เดียว แต่ไม่รับประกันว่าจะไม่ซ้ำกันในคำสั่งซื้อที่รับประกันการแสดงผลทั้งหมด รหัสนี้ใช้ใน SDF และ UI
exchange

enum (Exchange)

ต้องระบุ เปลี่ยนแปลงไม่ได้ Exchange ที่เป็นต้นทางของคำสั่งซื้อที่รับประกันการแสดงผล
guaranteedOrderId

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันของคำสั่งซื้อที่รับประกันการแสดงผล รหัสคำสั่งซื้อที่รับประกันจะมีรูปแบบ {exchange}-{legacyGuaranteedOrderId}
displayName

string

ต้องระบุ ชื่อที่แสดงของคำสั่งซื้อที่มีการรับประกันการแสดงผล

ต้องเข้ารหัส UTF-8 โดยมีขนาดสูงสุด 240 ไบต์
status

object (GuaranteedOrderStatus)

การตั้งค่าสถานะของคำสั่งซื้อที่รับประกันการแสดงผล
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดตคำสั่งซื้อที่รับประกันครั้งล่าสุด กำหนดโดยระบบ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
publisherName

string

ต้องระบุ ชื่อผู้เผยแพร่โฆษณาของคำสั่งซื้อที่รับประกันการแสดงผล

ต้องเข้ารหัส UTF-8 โดยมีขนาดสูงสุด 240 ไบต์
readAccessInherited

boolean

ผู้ลงโฆษณาทั้งหมดของ readWritePartnerId มีสิทธิ์อ่านรายการโฆษณาที่รับประกันการแสดงผลหรือไม่ ใช้ได้เฉพาะเมื่อตั้งค่า readWritePartnerId ไว้เท่านั้น หากเป็นจริง จะลบล้าง readAdvertiserIds
readAdvertiserIds[]

string (int64 format)

รหัสของผู้ลงโฆษณาที่มีสิทธิ์อ่านรายการโฆษณาที่รับประกันการแสดงผล

ช่องนี้ต้องไม่มีผู้ลงโฆษณาที่กำหนดให้กับ readWriteAdvertiserId หากมีการตั้งค่าไว้ ผู้ลงโฆษณาทั้งหมดในช่องนี้ต้องเป็นของ readWritePartnerId หรือพาร์ทเนอร์รายเดียวกับ readWriteAdvertiserId
defaultAdvertiserId

string (int64 format)

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

ผู้ลงโฆษณาเริ่มต้นคือ readWriteAdvertiserId หรือหากไม่ได้ตั้งค่าไว้ จะเป็นผู้ลงโฆษณารายแรกที่แสดงใน readAdvertiserIds แต่หากไม่เห็นแสดงว่าไม่มีผู้ลงโฆษณาเริ่มต้น
defaultCampaignId

string (int64 format)

รหัสของแคมเปญเริ่มต้นที่กำหนดให้กับคำสั่งซื้อที่รับประกันการแสดงผล

แคมเปญเริ่มต้นต้องเป็นของผู้ลงโฆษณาเริ่มต้น

ต้องระบุ

พาร์ทเนอร์หรือผู้ลงโฆษณาที่มีสิทธิ์อ่าน/เขียนในคำสั่งซื้อที่มีการรับประกัน ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
readWritePartnerId

string (int64 format)

พาร์ทเนอร์ที่มีสิทธิ์อ่าน/เขียนในคำสั่งซื้อที่รับประกันการแสดงผล
readWriteAdvertiserId

string (int64 format)

ผู้ลงโฆษณาที่มีสิทธิ์อ่าน/เขียนในคำสั่งซื้อที่มีการรับประกัน และยังเป็นผู้ลงโฆษณาเริ่มต้นของคำสั่งซื้อที่มีการรับประกันด้วย
สิ้นสุดฟิลด์ที่แยกกัน

GuaranteedOrderStatus

การตั้งค่าสถานะของคำสั่งซื้อที่รับประกันการแสดงผล

การแสดง JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
ช่อง
entityStatus

enum (EntityStatus)

รายการสั่งซื้อที่รับประกันการแสดงผลแสดงได้หรือไม่

ค่าที่ยอมรับคือ ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED และ ENTITY_STATUS_PAUSED ค่าเริ่มต้นคือ ENTITY_STATUS_ACTIVE
entityPauseReason

string

เหตุผลที่ผู้ใช้ระบุสำหรับการหยุดคำสั่งซื้อที่รับประกันการแสดงผลนี้ชั่วคราว

ต้องเข้ารหัสแบบ UTF-8 โดยมีความยาวสูงสุด 100 ไบต์

ใช้ได้เฉพาะเมื่อตั้งค่า entityStatus เป็น ENTITY_STATUS_PAUSED เท่านั้น
configStatus

enum (GuaranteedOrderConfigStatus)

เอาต์พุตเท่านั้น สถานะการกำหนดค่าของคำสั่งซื้อที่มีการรับประกัน

ค่าที่ยอมรับคือ PENDING และ COMPLETED

คุณต้องกำหนดค่าคำสั่งซื้อที่รับประกันการแสดงผล (กรอกข้อมูลในช่องที่ต้องกรอก เลือกครีเอทีฟโฆษณา และเลือกแคมเปญเริ่มต้น) ก่อนจึงจะแสดงได้ ปัจจุบันการดำเนินการกำหนดค่าทำได้ผ่าน UI เท่านั้น

GuaranteedOrderConfigStatus

สถานะการกำหนดค่าที่เป็นไปได้สำหรับคำสั่งซื้อที่รับประกันการแสดงผล

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

เมธอด

create

 สร้างคำสั่งซื้อแบบรับประกันใหม่

editGuaranteedOrderReadAccessors

 แก้ไขสิทธิ์อ่านผู้ลงโฆษณาของคำสั่งซื้อที่มีการรับประกัน

get

 รับคำสั่งซื้อที่รับประกันการแสดงผล

list

 แสดงรายการคำสั่งซื้อที่รับประกันซึ่งผู้ใช้ปัจจุบันเข้าถึงได้

patch

 อัปเดตคำสั่งซื้อที่มีการรับประกันที่มีอยู่