REST Resource: orders

Tài nguyên: Đơn đặt hàng

Đơn đặt hàng là một tập hợp gồm Lines. Đơn đặt hàng này chỉ định thời điểm và vị trí phân phát quảng cáo.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của đơn đặt hàng theo định dạng: đơn hàng/{id}.

externalId

string

Không bắt buộc. Mã nhận dạng dùng để liên kết thực thể này với các nguồn bên ngoài.

displayName

string

Chỉ có đầu ra. Tên hiển thị của đơn đặt hàng.

Phải được mã hoá UTF-8 với kích thước tối đa là 240 byte.

description

string

Chỉ có đầu ra. Trường dạng tự do bổ sung để mô tả đơn đặt hàng.

orderState

enum (OrderState)

Chỉ có đầu ra. Biểu thị trạng thái tính toán của đơn đặt hàng dựa trên trạng thái của các dòng.

createTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian tạo cho đơn đặt hàng.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian cập nhật gần đây nhất cho đơn đặt hàng.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

advertiserInfo

object (AdvertiserInfo)

Chỉ có đầu ra. Thông tin của nhà quảng cáo.

OrderState

Trạng thái của đơn đặt hàng.

Enum
ORDER_STATE_UNSPECIFIED Giá trị mặc định khi trạng thái đơn đặt hàng chưa được chỉ định hoặc không xác định trong phiên bản này.
ORDER_STATE_PENDING_RESERVATION

Đơn đặt hàng bao gồm:

  • một hoặc nhiều dòng ở trạng thái đặt trước đang chờ xử lý.
  • không có hoặc có nhiều dòng ở trạng thái dành riêng.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_RESERVED

Đơn đặt hàng bao gồm:

  • 0 dòng ở trạng thái đặt trước đang chờ xử lý.
  • một hoặc nhiều dòng ở trạng thái dành riêng.
  • không có hoặc có nhiều dòng ở trạng thái bị người bán từ chối.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_PENDING_BOOKING

Đơn đặt hàng bao gồm:

  • không có dòng nào ở trạng thái đặt trước đang chờ xử lý.
  • 0 dòng ở trạng thái dành riêng.
  • một hoặc nhiều tuyến ở trạng thái đặt trước đang chờ xử lý.
  • không có hoặc có nhiều dòng ở trạng thái bị người bán từ chối.
  • không có hoặc nhiều dòng bị người mua huỷ.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_BOOKED

Đơn đặt hàng bao gồm:

  • không có dòng nào ở trạng thái đặt trước đang chờ xử lý.
  • 0 dòng ở trạng thái dành riêng.
  • không có dòng nào ở trạng thái đặt vé đang chờ xử lý.
  • một hoặc nhiều tuyến ở trạng thái đã đặt trước.
  • không có hoặc có nhiều dòng ở trạng thái bị người bán từ chối.
  • không có hoặc nhiều dòng bị người mua huỷ.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_REJECTED_BY_SELLER

Đơn đặt hàng bao gồm:

  • không có dòng nào ở trạng thái đặt trước đang chờ xử lý.
  • 0 dòng ở trạng thái dành riêng.
  • không có dòng nào trong trạng thái đặt vé đang chờ xử lý.
  • 0 dòng ở trạng thái đã đặt trước.
  • một hoặc nhiều dòng bị trạng thái người bán từ chối.
  • 0 dòng bị người mua huỷ.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_CANCELLED_BY_BUYER

Đơn đặt hàng bao gồm:

  • không có dòng nào ở trạng thái đặt trước đang chờ xử lý.
  • 0 dòng ở trạng thái dành riêng.
  • không có dòng nào trong trạng thái đặt vé đang chờ xử lý.
  • 0 dòng ở trạng thái đã đặt trước.
  • không có dòng nào ở trạng thái bị người bán từ chối.
  • một hoặc nhiều dòng bị người mua huỷ.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

Đơn đặt hàng bao gồm:

  • một hoặc nhiều dòng trong yêu cầu đặt trước đang chờ xử lý đã hết hạn.
  • dòng 0 ở tất cả các trạng thái khác.
ORDER_STATE_RESERVED_EXPIRED

Đơn đặt hàng bao gồm:

  • một hoặc nhiều dòng trong gói đặt trước đã hết hạn.
  • dòng 0 ở tất cả các trạng thái khác.

Phương thức

get

Truy xuất một đơn đặt hàng riêng lẻ.

list

Liệt kê đơn đặt hàng.

patch

Cập nhật đơn đặt hàng hiện tại.