REST Resource: guaranteedOrders

Tài nguyên: Đảm bảo đơn đặt hàng

Đơ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, mã đơn hàng được đảm bảo phải được chỉ định 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,

  // 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.
}
Các 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ã cũ của đơn đặt hàng được đảm bảo. Do đối tác trao đổi ban đầu chỉ định. Mã nhận dạng cũ là duy nhất trong một lần trao đổi, nhưng không đảm bảo là mã duy nhất trên tất cả các đơn đặt hàng được đảm bảo. Mã 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 đơn đặt hàng được đảm bảo bắt nguồn.
guaranteedOrderId

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất của đơn đặt hàng được đảm bảo. Mã đơn 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 là mã 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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
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 là mã UTF-8 với kích thước tối đa là 240 byte.
readAccessInherited

boolean

Liệu tất cả các nhà quảng cáo của readWritePartnerId có quyền đọc đơn đặt hàng được đảm bảo hay không. Chỉ áp dụng nếu bạn đặt readWritePartnerId. Nếu đúng, hãy ghi đè readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Mã nhận dạng của các nhà quảng cáo có quyền đọc đơ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 bạn đặt trường này. Tất cả nhà quảng cáo trong trường này phải thuộc về readWritePartnerId hoặc cùng đối tác với readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Chỉ có đầu ra. Mã của nhà quảng cáo mặc định trong đơ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 chưa được đặt. 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 gán 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.

Trường nhóm read_write_accessor. 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. read_write_accessor chỉ có thể là một trong những trạng thái sau đây:
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.

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)
}
Các trường
entityStatus

enum (EntityStatus)

Liệu đơn đặt hàng được đảm bảo có thể phân phát được 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 do người dùng đưa ra để tạm dừng đơn đặt hàng được cam kết giá tốt này.

Phải là mã UTF-8 với độ dài tối đa là 100 byte.

Chỉ áp dụng khi bạn đặt entityStatus 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.

Đơn đặt hàng được đảm bảo phải được định cấu hình (đ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) trước khi đơn đặt hàng 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 đơ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. Đơn đặt hàng được đảm bảo ở trạng thái này cần phải được định cấu hình trước khi 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 được đảm bảo.

Phương thức

create

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

editGuaranteedOrderReadAccessors

 Nội dung chỉnh sửa sẽ đọc thông tin về nhà quảng cáo có đơ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 một đơn đặt hàng được đảm bảo hiện có.