REST Resource: orders

แหล่งข้อมูล: คำสั่งซื้อ

คำสั่งซื้อคือคอลเล็กชันของ Lines ซึ่งระบุเวลาและตำแหน่งที่แสดงโฆษณา

การแสดง JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของคำสั่งซื้อในรูปแบบ: Orders/{id}`
externalId

string

ไม่บังคับ รหัสที่ใช้ในการแมปเอนทิตีนี้กับแหล่งที่มาภายนอก
displayName

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของคำสั่งซื้อ

ต้องเป็น UTF-8 ที่เข้ารหัสขนาดไม่เกิน 240 ไบต์
description

string

เอาต์พุตเท่านั้น ฟิลด์รูปแบบอิสระเพิ่มเติมเพื่ออธิบายคำสั่งซื้อ
orderState

enum (OrderState)

เอาต์พุตเท่านั้น แสดงสถานะที่คำนวณของคำสั่งซื้อตามสถานะบรรทัด
createTime

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
advertiserInfo

object (AdvertiserInfo)

เอาต์พุตเท่านั้น ข้อมูลผู้ลงโฆษณา

OrderState

สถานะของคำสั่งซื้อ

Enum
ORDER_STATE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่มีการระบุสถานะการสั่งซื้อหรือไม่รู้จักในเวอร์ชันนี้
ORDER_STATE_PENDING_RESERVATION

คำสั่งซื้อประกอบด้วย:

  • อย่างน้อย 1 บรรทัดที่อยู่ในสถานะการจองที่รอดำเนินการ
  • มี 0 บรรทัดขึ้นไปในสถานะที่สงวนไว้
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_RESERVED

คำสั่งซื้อประกอบด้วย:

  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • อย่างน้อย 1 บรรทัดที่อยู่ในสถานะสงวน
  • บรรทัดหรือมากกว่าที่สถานะผู้ขายปฏิเสธ
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_PENDING_BOOKING

คำสั่งซื้อประกอบด้วย:

  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะสงวนไว้
  • มีอย่างน้อย 1 บรรทัดที่อยู่ในสถานะการจองที่รอดำเนินการ
  • บรรทัดหรือมากกว่าที่สถานะผู้ขายปฏิเสธ
  • ผู้ซื้อยกเลิกบรรทัดอย่างน้อย 0 บรรทัด
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_BOOKED

คำสั่งซื้อประกอบด้วย:

  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะสงวนไว้
  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • อย่างน้อย 1 บรรทัดในสถานะจองแล้ว
  • บรรทัดหรือมากกว่าที่สถานะผู้ขายปฏิเสธ
  • ผู้ซื้อยกเลิกบรรทัดอย่างน้อย 0 บรรทัด
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_REJECTED_BY_SELLER

คำสั่งซื้อประกอบด้วย:

  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะสงวนไว้
  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะจองแล้ว
  • อย่างน้อย 1 บรรทัดที่สถานะผู้ขายปฏิเสธ
  • ผู้ซื้อยกเลิกบรรทัดศูนย์
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_CANCELLED_BY_BUYER

คำสั่งซื้อประกอบด้วย:

  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะสงวนไว้
  • เส้น 0 เส้นในสถานะการจองที่รอดำเนินการ
  • เส้น 0 เส้นในสถานะจองแล้ว
  • สถานะผู้ขายปฏิเสธเส้นศูนย์
  • ผู้ซื้อยกเลิกบรรทัดหนึ่งบรรทัดขึ้นไป
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_PENDING_RESERVATION_EXPIRED

คำสั่งซื้อประกอบด้วย:

  • การจองที่รอดำเนินการอย่างน้อย 1 บรรทัดหมดอายุแล้ว
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด
ORDER_STATE_RESERVED_EXPIRED

คำสั่งซื้อประกอบด้วย:

  • บรรทัดที่สงวนไว้อย่างน้อย 1 บรรทัดหมดอายุแล้ว
  • เป็น 0 บรรทัดในรัฐอื่นๆ ทั้งหมด

เมธอด

get

 เรียกข้อมูลคำสั่งซื้อแต่ละรายการ

list

 แสดงรายการคำสั่งซื้อ

patch

 อัปเดตคำสั่งซื้อที่มีอยู่