REST Resource: guaranteedOrders

แหล่งข้อมูล: WarrantyOrder

คำสั่งซื้อที่รับประกัน

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

การแสดง 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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
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

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