# REST Resource: guaranteedOrders

> [!WARNING]
> Display \& Video 360 API v3 has sunset. Use [v4](https://developers.google.com/display-video/api/reference/rest/v4) instead.

- [Resource: GuaranteedOrder](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder)
  - [JSON representation](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.SCHEMA_REPRESENTATION)
- [GuaranteedOrderStatus](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderStatus)
  - [JSON representation](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderStatus.SCHEMA_REPRESENTATION)
- [GuaranteedOrderConfigStatus](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderConfigStatus)
- [Methods](https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#METHODS_SUMMARY)

## Resource: GuaranteedOrder

A guaranteed order.

Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

| JSON representation |
|---|
| ``` { "name": string, "legacyGuaranteedOrderId": string, "exchange": enum (`https://developers.google.com/display-video/api/reference/rest/v3/Exchange`), "guaranteedOrderId": string, "displayName": string, "status": { object (`https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#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. |
| `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 (`https://developers.google.com/display-video/api/reference/rest/v3/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 (`https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderStatus`)`` The status settings of the guaranteed order. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp when the guaranteed order was last updated. Assigned by the system. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `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 `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_partner_id` have read access to the guaranteed order. Only applicable if `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_partner_id` is set. If True, overrides `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_advertiser_ids`. |
| `readAdvertiserIds[]` | `string (https://developers.google.com/discovery/v1/type-format format)` The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_advertiser_id` if it is set. All advertisers in this field must belong to `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_partner_id` or the same partner as `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_advertiser_id`. |
| `defaultAdvertiserId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_write_advertiser_id` or, if that is not set, the first advertiser listed in `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrder.FIELDS.read_advertiser_ids`. Otherwise, there is no default advertiser. |
| `defaultCampaignId` | `string (https://developers.google.com/discovery/v1/type-format 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 (https://developers.google.com/discovery/v1/type-format format)` The partner with read/write access to the guaranteed order. |
| `readWriteAdvertiserId` | `string (https://developers.google.com/discovery/v1/type-format format)` The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. |

## GuaranteedOrderStatus

The status settings of the guaranteed order.

| JSON representation |
|---|
| ``` { "entityStatus": enum (`https://developers.google.com/display-video/api/reference/rest/v3/EntityStatus`), "entityPauseReason": string, "configStatus": enum (`https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderConfigStatus`) } ``` |

| Fields ||
|---|---|
| `entityStatus` | ``enum (`https://developers.google.com/display-video/api/reference/rest/v3/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 `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#GuaranteedOrderStatus.FIELDS.entity_status` is set to `ENTITY_STATUS_PAUSED`. |
| `configStatus` | ``enum (`https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders#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 ||
|---|---|
| ### `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders/create` | Creates a new guaranteed order. |
| ### `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders/editGuaranteedOrderReadAccessors` | Edits read advertisers of a guaranteed order. |
| ### `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders/get` | Gets a guaranteed order. |
| ### `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders/list` | Lists guaranteed orders that are accessible to the current user. |
| ### `https://developers.google.com/display-video/api/reference/rest/v3/guaranteedOrders/patch` | Updates an existing guaranteed order. |