1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DisplayVideo
  7. \
  8. Resource
  9. \
  10. GuaranteedOrders

GuaranteedOrders

class GuaranteedOrders extends Resource (View source)

The "guaranteedOrders" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $guaranteedOrders = $displayvideoService->guaranteedOrders;

Methods

GuaranteedOrder
create(GuaranteedOrder $postBody, array $optParams = [])

Creates a new guaranteed order. Returns the newly created guaranteed order if successful. (guaranteedOrders.create)

EditGuaranteedOrderReadAccessorsResponse
editGuaranteedOrderReadAccessors(string $guaranteedOrderId, EditGuaranteedOrderReadAccessorsRequest $postBody, array $optParams = [])

Edits read advertisers of a guaranteed order.

GuaranteedOrder
get(string $guaranteedOrderId, array $optParams = [])

Gets a guaranteed order. (guaranteedOrders.get)

ListGuaranteedOrdersResponse
listGuaranteedOrders(array $optParams = [])

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. (guaranteedOrders.listGuaranteedOrders)

GuaranteedOrder
patch(string $guaranteedOrderId, GuaranteedOrder $postBody, array $optParams = [])

Updates an existing guaranteed order. Returns the updated guaranteed order if successful. (guaranteedOrders.patch)

Details

at line 49
GuaranteedOrder create(GuaranteedOrder $postBody, array $optParams = [])

Creates a new guaranteed order. Returns the newly created guaranteed order if successful. (guaranteedOrders.create)

Parameters

GuaranteedOrder $postBody
array $optParams

Optional parameters.

Return Value

GuaranteedOrder

Exceptions

Exception

at line 66
EditGuaranteedOrderReadAccessorsResponse editGuaranteedOrderReadAccessors(string $guaranteedOrderId, EditGuaranteedOrderReadAccessorsRequest $postBody, array $optParams = [])

Edits read advertisers of a guaranteed order.

(guaranteedOrders.editGuaranteedOrderReadAccessors)

Parameters

string $guaranteedOrderId

Required. The ID of the guaranteed order to edit. The ID is of the format {exchange}-{legacy_guaranteed_order_id}
EditGuaranteedOrderReadAccessorsRequest $postBody
array $optParams

Optional parameters.

Return Value

EditGuaranteedOrderReadAccessorsResponse

Exceptions

Exception

at line 86
GuaranteedOrder get(string $guaranteedOrderId, array $optParams = [])

Gets a guaranteed order. (guaranteedOrders.get)

Parameters

string $guaranteedOrderId

Required. The ID of the guaranteed order to fetch. The ID is of the format {exchange}-{legacy_guaranteed_order_id}
array $optParams

Optional parameters.

Return Value

GuaranteedOrder

Exceptions

Exception

at line 130
ListGuaranteedOrdersResponse listGuaranteedOrders(array $optParams = [])

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. (guaranteedOrders.listGuaranteedOrders)

Parameters

array $optParams

Optional parameters.

Return Value

ListGuaranteedOrdersResponse

Exceptions

Exception

at line 155
GuaranteedOrder patch(string $guaranteedOrderId, GuaranteedOrder $postBody, array $optParams = [])

Updates an existing guaranteed order. Returns the updated guaranteed order if successful. (guaranteedOrders.patch)

Parameters

string $guaranteedOrderId

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}.
GuaranteedOrder $postBody
array $optParams

Optional parameters.

Return Value

GuaranteedOrder

Exceptions

Exception