2022-05-28
▼ ▲ displayvideo.guaranteedOrders.create
Path: v1/guaranteedOrders
Parameters:
advertiserId
Description: The ID of the advertiser that the request is being made within.
Type: string
Location: query
Format: int64
partnerId
Location: query
Type: string
Description: The ID of the partner that the request is being made within.
Format: int64
Description: Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v1/guaranteedOrders
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Description: Edits read advertisers of a guaranteed order.
Path: v1/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Parameter Order: guaranteedOrderId
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
guaranteedOrderId
Description: Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Required: Yes
Location: path
Pattern: ^[^/]+$
Type: string
▼ ▲ displayvideo.guaranteedOrders.patch
HTTP Method: PATCH
Parameters:
partnerId
Description: The ID of the partner that the request is being made within.
Location: query
Type: string
Format: int64
guaranteedOrderId
Required: Yes
Description: Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Location: path
Type: string
Pattern: ^[^/]+$
advertiserId
Format: int64
Location: query
Type: string
Description: The ID of the advertiser that the request is being made within.
updateMask
Location: query
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Type: string
Path: v1/guaranteedOrders/{+guaranteedOrderId}
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}
Parameter Order: guaranteedOrderId
Description: Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
▼ ▲ displayvideo.guaranteedOrders.get
Parameter Order: guaranteedOrderId
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Parameters:
advertiserId
Description: The ID of the advertiser that has access to the guaranteed order.
Location: query
Format: int64
Type: string
partnerId
Location: query
Format: int64
Type: string
Description: The ID of the partner that has access to the guaranteed order.
guaranteedOrderId
Location: path
Pattern: ^[^/]+$
Required: Yes
Type: string
Description: Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Description: Gets a guaranteed order.
Flat Path: v1/guaranteedOrders/{guaranteedOrdersId}
Path: v1/guaranteedOrders/{+guaranteedOrderId}
▼ ▲ displayvideo.guaranteedOrders.list
Flat Path: v1/guaranteedOrders
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
pageSize
Description: Requested page size. Must be between `1` and `100`. If unspecified or greater than `100` will default to `100`.
Type: integer
Location: query
Format: int32
filter
Description: Allows filtering by guaranteed order properties. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `guaranteed_order_id` - `exchange` - `display_name` - `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters.
Location: query
Type: string
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
Type: string
Location: query
orderBy
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Location: query
Type: string
advertiserId
Location: query
Format: int64
Description: The ID of the advertiser that has access to the guaranteed order.
Type: string
partnerId
Description: The ID of the partner that has access to the guaranteed order.
Location: query
Format: int64
Type: string
Path: v1/guaranteedOrders
Description: Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
▼ ▲ displayvideo.inventorySources.patch
Description: Updates an existing inventory source. Returns the updated inventory source if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: PATCH
Path: v1/inventorySources/{+inventorySourceId}
Flat Path: v1/inventorySources/{inventorySourcesId}
Parameters:
updateMask
Type: string
Description: Required. The mask to control which fields to update.
Location: query
Format: google-fieldmask
inventorySourceId
Required: Yes
Pattern: ^[^/]+$
Location: path
Format: int64
Description: Output only. The unique ID of the inventory source. Assigned by the system.
Type: string
advertiserId
Description: The ID of the advertiser that the request is being made within.
Location: query
Type: string
Format: int64
partnerId
Type: string
Format: int64
Location: query
Description: The ID of the partner that the request is being made within.
Parameter Order: inventorySourceId
▼ ▲ displayvideo.inventorySources.create
Scopes: https://www.googleapis.com/auth/display-video
Description: Creates a new inventory source. Returns the newly created inventory source if successful.
HTTP Method: POST
Flat Path: v1/inventorySources
Path: v1/inventorySources
Parameters:
partnerId
Format: int64
Type: string
Description: The ID of the partner that the request is being made within.
Location: query
advertiserId
Format: int64
Location: query
Description: The ID of the advertiser that the request is being made within.
Type: string
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
Flat Path: v1/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
Path: v1/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
Description: Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
HTTP Method: POST
Parameters:
inventorySourceId
Required: Yes
Location: path
Description: Required. The ID of inventory source to update.
Type: string
Pattern: ^[^/]+$
Format: int64
Parameter Order: inventorySourceId