REST Resource: guaranteedOrders

Resource: GuaranteedOrder

A guaranteed order. The guaranteed order is the parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order must be assigned to the inventory source, which can never be changed afterwards.

JSON representation
{
  "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.
}
Fields
name

string

Output only. The resource name of the guaranteed order.

Guaranteed order resource names have the format guaranteedOrders/{guaranteedOrderId}.

legacyGuaranteedOrderId

string

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.

exchange

enum (Exchange)

Required. Immutable. The exchange where the guaranteed order originated.

guaranteedOrderId

string

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacyGuaranteedOrderId}.

displayName

string

Required. The display name of the guaranteed order.

Must be UTF-8 encoded with a maximum size of 240 bytes.

status

object (GuaranteedOrderStatus)

The status settings of the guaranteed order.

updateTime

string (Timestamp format)

Output only. The timestamp when the guaranteed order was last updated. 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".

publisherName

string

Required. The publisher name of the guaranteed order.

Must be UTF-8 encoded with a maximum size of 240 bytes.

readAccessInherited

boolean

Whether all advertisers of readWritePartnerId have read access to the guaranteed order. Only applicable if readWritePartnerId is set. If True, overrides readAdvertiserIds.

readAdvertiserIds[]

string (int64 format)

The IDs of advertisers with read access to the guaranteed order.

This field must not include readWriteAdvertiserId if it is set. All advertisers in this field must belong to readWritePartnerId or the same partner as readWriteAdvertiserId.

defaultAdvertiserId

string (int64 format)

Output only. The ID of default advertiser of the guaranteed order.

The default advertiser is either the readWriteAdvertiserId or, if that is not set, the first advertiser listed in readAdvertiserIds. Otherwise, there is no default advertiser.

defaultCampaignId

string (int64 format)

The ID of the default campaign that is assigned to the guaranteed order.

The default campaign must belong to the default advertiser.

Union field read_write_accessor. Required.

The partner or advertiser with read/write access to the guaranteed order read_write_accessor can be only one of the following:

readWritePartnerId

string (int64 format)

The partner with read/write access to the guaranteed order.

readWriteAdvertiserId

string (int64 format)

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.

GuaranteedOrderStatus

The status-related settings of the guaranteed order.

JSON representation
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Fields
entityStatus

enum (EntityStatus)

Whether or not the guaranteed order is servable.

Acceptable values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. Default value is ENTITY_STATUS_ACTIVE.

entityPauseReason

string

The user-provided reason for pausing this guaranteed order.

Must be UTF-8 encoded with a maximum length of 100 bytes.

Only applicable when entityStatus is set to ENTITY_STATUS_PAUSED.

configStatus

enum (GuaranteedOrderConfigStatus)

Output only. The configuration status of the guaranteed order.

Acceptable values are PENDING and COMPLETED.

A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.

GuaranteedOrderConfigStatus

Possible configuration states for a guaranteed order.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED The approval status is not specified or is unknown in this version.
PENDING The beginning state of a guaranteed order. The guaranteed order in this state needs to be configured before it can serve.
COMPLETED The state after the buyer configures a guaranteed order.

Methods

create

Creates a new guaranteed order.

editGuaranteedOrderReadAccessors

Edits read advertisers of a guaranteed order.

get

Gets a guaranteed order.

list

Lists guaranteed orders that are accessible to the current user.

patch

Updates an existing guaranteed order.