REST Resource: networks.orders

Resource: Order

The Order resource.

JSON representation 
{
  "name": string,
  "orderId": string,
  "displayName": string,
  "programmatic": boolean,
  "trafficker": string,
  "advertiserContacts": [
    string
  ],
  "advertiser": string,
  "agencyContacts": [
    string
  ],
  "agency": string,
  "appliedTeams": [
    string
  ],
  "effectiveTeams": [
    string
  ],
  "creator": string,
  "currencyCode": string,
  "startTime": string,
  "endTime": string,
  "unlimitedEndTime": boolean,
  "externalOrderId": string,
  "archived": boolean,
  "lastModifiedByApp": string,
  "updateTime": string,
  "notes": string,
  "poNumber": string,
  "status": enum (OrderStatus),
  "salesperson": string,
  "secondarySalespeople": [
    string
  ],
  "secondaryTraffickers": [
    string
  ],
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "effectiveAppliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ]
}
Fields
name

string

Identifier. The resource name of the Order. Format: networks/{networkCode}/orders/{orderId}
orderId

string (int64 format)

Output only. Order ID.
displayName

string

Required. The display name of the Order. This value has a maximum length of 255 characters.
programmatic

boolean

Optional. Specifies whether or not the Order is a programmatic order.
trafficker

string

Required. The resource name of the User responsible for trafficking the Order. Format: "networks/{networkCode}/users/{userId}"
advertiserContacts[]

string

Optional. The resource names of Contacts from the advertiser of this Order. Format: "networks/{networkCode}/contacts/{contactId}"
advertiser

string

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. Format: "networks/{networkCode}/companies/{companyId}"
agencyContacts[]

string

Optional. The resource names of Contacts from the advertising Agency of this Order. Format: "networks/{networkCode}/contacts/{contactId}"
agency

string

Optional. The resource name of the Company, which is of type Company.Type.AGENCY, with which this order is associated. Format: "networks/{networkCode}/companies/{companyId}"
appliedTeams[]

string

Optional. The resource names of Teams directly applied to this Order. Format: "networks/{networkCode}/teams/{teamId}"
effectiveTeams[]

string

Output only. The resource names of Teams applied to this Order including inherited values. Format: "networks/{networkCode}/teams/{teamId}"
creator

string

Output only. The resource name of the User who created the Order on behalf of the advertiser. This value is assigned by Google. Format: "networks/{networkCode}/users/{userId}"
currencyCode

string

Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network's currency code.
startTime

string (Timestamp format)

Output only. The instant at which the Order and its associated line items are eligible to begin serving. This attribute is derived from the line item of the order that has the earliest LineItem.start_time.

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".
endTime

string (Timestamp format)

Output only. The instant at which the Order and its associated line items stop being served. This attribute is derived from the line item of the order that has the latest LineItem.end_time.

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".
unlimitedEndTime

boolean

Output only. Indicates whether or not this Order has an end time.
externalOrderId

string (int64 format)

Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.
archived

boolean

Output only. The archival status of the Order.
lastModifiedByApp

string

Output only. The application which modified this order. This attribute is assigned by Google.
updateTime

string (Timestamp format)

Output only. The instant this Order was last modified.

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".
notes

string

Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.
poNumber

string

Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.
status

enum (OrderStatus)

Output only. The status of the Order.
salesperson

string

Optional. The resource name of the User responsible for the sales of the Order. Format: "networks/{networkCode}/users/{userId}"
secondarySalespeople[]

string

Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: "networks/{networkCode}/users/{userId}"
secondaryTraffickers[]

string

Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: "networks/{networkCode}/users/{userId}"
appliedLabels[]

object (AppliedLabel)

Optional. The set of labels applied directly to this order.
effectiveAppliedLabels[]

object (AppliedLabel)

Output only. Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is assigned by Google.
customFieldValues[]

object (CustomFieldValue)

Optional. The set of custom field values to this order.

OrderStatus

The status of an Order.

Enums
ORDER_STATUS_UNSPECIFIED Default value. This value is unused.
DRAFT Indicates that the Order has just been created but no approval has been requested yet.
PENDING_APPROVAL Indicates that a request for approval for the Order has been made.
APPROVED Indicates that the Order has been approved and is ready to serve.
DISAPPROVED Indicates that the Order has been disapproved and is not eligible to serve.
PAUSED This is a legacy state. Paused status should be checked on LineItems within the order.
CANCELED Indicates that the Order has been canceled and cannot serve.
DELETED Indicates that the Order has been deleted.

CustomFieldValue

A value for a CustomField on a resource.

JSON representation 
{
  "customField": string,
  "value": {
    object (Value)
  }
}
Fields
customField

string

Required. The custom field for which this is a value. Format: "networks/{networkCode}/customFields/{customFieldId}"
value

object (Value)

Required. A typed value representation of the value.

Value

Represent custom field value type. Next Id: 5

JSON representation 
{

  // Union field value can be only one of the following:
  "dropdownValue": string,
  "stringValue": string,
  "numberValue": number,
  "toggleValue": boolean
  // End of list of possible types for union field value.
}
Fields
Union field value. The value of this field. value can be only one of the following:
dropdownValue

string (int64 format)

The customFieldOptionId, if the CustomFieldDataType is DROPDOWN.
stringValue

string

The value, if the CustomFieldDataType is STRING.
numberValue

number

The value, if the CustomFieldDataType is NUMBER.
toggleValue

boolean

The value, if the CustomFieldDataType is TOGGLE.

Methods

get

 API to retrieve an Order object.

list

 API to retrieve a list of Order objects.