REST Resource: availabilityOrders

Resource: AvailabilityOrder

An availability order is a collection of AvailabilityLines. The availability order is created by the buyer. The seller updates the availability with the response.

The workflow is as follows:

  • Buyer creates availability order and lines and sets the state to pending. Further buyer changes to availability order or line are not allowed.
  • Seller acts on all availability lines by either completing with availability terms or marking as rejected. Complete or reject actions are only possible when the order and lines are in the pending state.
  • Seller uses complete custom action to mark the availability request as complete. Further changes to the availability order or child lines are not allowed once complete.
JSON representation 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "pendingExpirationTime": string,
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Fields
name

string

Output only. The resource name of the availability order in the format: availabilityOrders/{id}.
description

string

Output only. Additional freeform field to describe the availability order.
state

enum (State)

Output only. The state of this availability order. See AvailabilityOrder.State for the lifecycle of an AvailabilityOrder.

Seller can use the Complete custom method to set to STATE_COMPLETED.
pendingExpirationTime

string (Timestamp format)

Output only. Expiration timestamp for the pending availability order. Seller needs to complete before a pending availability order expires or it will be treated as complete with no availability.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

Output only. Creation timestamp. Assigned by the system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last updated timestamp. Assigned by the system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

Output only. Advertiser info.

State

Possible values for availability order state.

Enums
STATE_UNSPECIFIED The default value when the availability order state has not been specified or is unknown in this version.
STATE_PENDING Pending availability when the buyer provided the availability request settings.
STATE_COMPLETED Completed availability state when the seller provided the availability response for all lines.
STATE_CANCELLED Cancelled availability state when buyer provided the cancel request before seller provided the availability response for all lines.
STATE_EXPIRED Expired availability state when order expired before seller completed it.

Methods

complete

 Marks an existing availability order as complete.

get

 Retrieves an individual availability order.

list

 Lists availability orders.