REST Resource: guaranteedOrders

Tài nguyên: GuaranteedOrder

Đơn đặt hàng được đảm bảo.

Đơn đặt hàng được đảm bảo là thực thể mẹ của nguồn khoảng không quảng cáo được đảm bảo. Khi tạo nguồn khoảng không quảng cáo được đảm bảo, bạn phải chỉ định mã đơn đặt hàng được đảm bảo cho nguồn khoảng không quảng cáo đó.

Biểu diễn dưới dạng 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của đơn đặt hàng được đảm bảo.
legacyGuaranteedOrderId

string

Chỉ có đầu ra. Mã nhận dạng cũ của đơn đặt hàng được đảm bảo. Do sàn giao dịch ban đầu chỉ định. Mã cũ là mã nhận dạng duy nhất trong một sàn giao dịch, nhưng không được đảm bảo là duy nhất trên tất cả các đơn đặt hàng được đảm bảo. Mã nhận dạng này được dùng trong SDF và giao diện người dùng.
exchange

enum (Exchange)

Bắt buộc. Không thể thay đổi. Sàn giao dịch nơi bắt nguồn đơn đặt hàng được đảm bảo.
guaranteedOrderId

string

Chỉ có đầu ra. Giá trị nhận dạng riêng biệt của đơn đặt hàng được đảm bảo. Mã đơn đặt hàng được đảm bảo có định dạng {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Bắt buộc. Tên hiển thị của đơn đặt hàng được đảm bảo.

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

object (GuaranteedOrderStatus)

Chế độ cài đặt trạng thái của đơn đặt hàng được đảm bảo.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian khi đơn đặt hàng được đảm bảo được cập nhật lần gần đây nhất. Do hệ thống chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
publisherName

string

Bắt buộc. Tên nhà xuất bản của đơn đặt hàng được đảm bảo.

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

boolean

Liệu tất cả nhà quảng cáo của readWritePartnerId có quyền đọc đối với đơn đặt hàng được đảm bảo hay không. Chỉ áp dụng nếu bạn đặt readWritePartnerId. Nếu là True, thì sẽ ghi đè readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Mã nhận dạng của những nhà quảng cáo có quyền đọc đối với đơn đặt hàng được đảm bảo.

Trường này không được bao gồm nhà quảng cáo được chỉ định cho readWriteAdvertiserId nếu được đặt. Tất cả nhà quảng cáo trong trường này phải thuộc readWritePartnerId hoặc cùng một đối tác với readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng của nhà quảng cáo mặc định của đơn đặt hàng được đảm bảo.

Nhà quảng cáo mặc định là readWriteAdvertiserId hoặc nhà quảng cáo đầu tiên được liệt kê trong readAdvertiserIds (nếu bạn chưa đặt nhà quảng cáo mặc định). Nếu không, sẽ không có nhà quảng cáo mặc định.
defaultCampaignId

string (int64 format)

Mã của chiến dịch mặc định được chỉ định cho đơn đặt hàng được đảm bảo.

Chiến dịch mặc định phải thuộc về nhà quảng cáo mặc định.

Bắt buộc.

Đối tác hoặc nhà quảng cáo có quyền đọc/ghi đối với đơn đặt hàng được đảm bảo. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
readWritePartnerId

string (int64 format)

Đối tác có quyền đọc/ghi đối với đơn đặt hàng được đảm bảo.
readWriteAdvertiserId

string (int64 format)

Nhà quảng cáo có quyền đọc/ghi đối với đơn đặt hàng được đảm bảo. Đây cũng là nhà quảng cáo mặc định của đơn đặt hàng được đảm bảo.
Kết thúc các trường loại trừ lẫn nhau.

GuaranteedOrderStatus

Chế độ cài đặt trạng thái của đơn đặt hàng được đảm bảo.

Biểu diễn dưới dạng JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Trường
entityStatus

enum (EntityStatus)

Đơn đặt hàng được đảm bảo có thể phân phát hay không.

Các giá trị được chấp nhận là ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED và ENTITY_STATUS_PAUSED. Giá trị mặc định là ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Lý do người dùng đưa ra để tạm dừng đơn đặt hàng đảm bảo này.

Phải được mã hoá theo UTF-8 với độ dài tối đa là 100 byte.

Chỉ áp dụng khi entityStatus được đặt thành ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Chỉ có đầu ra. Trạng thái cấu hình của đơn đặt hàng được đảm bảo.

Giá trị được chấp nhận là PENDING và COMPLETED.

Bạn phải định cấu hình đơn đặt hàng được đảm bảo (điền vào các trường bắt buộc, chọn mẫu quảng cáo và chọn chiến dịch mặc định) thì đơn đặt hàng đó mới có thể phân phát. Hiện tại, bạn chỉ có thể thực hiện hành động định cấu hình thông qua giao diện người dùng.

GuaranteedOrderConfigStatus

Các trạng thái cấu hình có thể có cho một đơn đặt hàng được đảm bảo.

Enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Trạng thái phê duyệt không được chỉ định hoặc không xác định trong phiên bản này.
PENDING Trạng thái bắt đầu của đơn đặt hàng được đảm bảo. Bạn cần định cấu hình đơn đặt hàng được đảm bảo ở trạng thái này thì mới có thể phân phát.
COMPLETED Trạng thái sau khi người mua định cấu hình đơn đặt hàng đảm bảo.

Phương thức

create

 Tạo đơn đặt hàng đảm bảo mới.

editGuaranteedOrderReadAccessors

 Chỉnh sửa nhà quảng cáo đã đọc của một đơn đặt hàng được đảm bảo.

get

 Nhận đơn đặt hàng được đảm bảo.

list

 Liệt kê các đơn đặt hàng được đảm bảo mà người dùng hiện tại có thể truy cập.

patch

 Cập nhật đơn đặt hàng được đảm bảo hiện có.