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,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
ช่อง
name

string

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

string

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

enum (Exchange)

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

string

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

string

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

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

object (GuaranteedOrderStatus)

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

string (Timestamp format)

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

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

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

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

ฟิลด์สหภาพ read_write_accessor ต้องระบุ

พาร์ทเนอร์หรือผู้ลงโฆษณาที่มีสิทธิ์อ่าน/เขียนคำสั่งซื้อที่มีการรับประกัน read_write_accessor ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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

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