Resource: Order
An order is a collection of Lines
which specify when and where to display ads.
JSON representation |
---|
{ "name": string, "externalId": string, "displayName": string, "description": string, "state": enum ( |
Fields | |
---|---|
name |
The resource name of the order. Format: sellers/{seller}/orders/{order} |
externalId |
An id used to map this entity to external sources. |
displayName |
The display name of the order. Must be UTF-8 encoded with a maximum size of 240 bytes. |
description |
Additional freeform field to describe the order. |
state |
Output only. The state of the order. Seller can use the following custom methods:
All other order states are set by the buyer. |
createTime |
Output only. Creation timestamp for the order. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Last updated timestamp for the order. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
advertiserInfo |
Advertiser info. |
cancellationReason |
Output only. Cancellation reason. |
State
The state of the order.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value when the order state has not been specified or is unknown in this version. |
STATE_PENDING_RESERVATION |
The order contains:
|
STATE_RESERVATION_COMPLETE |
The order contains:
|
STATE_PENDING_BOOKING |
The order contains:
|
STATE_BOOKING_COMPLETE |
The order contains:
|
STATE_CANCELLED_BY_BUYER |
The order contains:
|
STATE_PENDING_RESERVATION_EXPIRED |
The order contains:
|
STATE_RESERVED_EXPIRED |
The order contains:
|
CancellationReason
The reason for cancellation, if the order has been canceled.
Enums | |
---|---|
CANCELLATION_REASON_UNSPECIFIED |
The default value when the cancellation reason has not been specified or is unknown in this version. |
CANCELLATION_REASON_BUYER_REQUESTED |
The buyer requested cancellation of the order. |
CANCELLATION_REASON_INVALID_ADVERTISER_INFO |
The provided advertiser info was invalid. |
Methods |
|
---|---|
|
Completes the order booking. |
|
Completes the order reservation. |
|
Creates a new order. |
|
Retrieves an individual order. |
|
Lists orders. |
|
Updates an existing order. |