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

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

enum (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)

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

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

ฟิลด์ Union 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

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