class AdvertisersInsertionOrders extends Resource (View source)

The "insertionOrders" collection of methods.

Typical usage is:

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

Methods

create(string $advertiserId, InsertionOrder $postBody, array $optParams = [])

Creates a new insertion order. Returns the newly created insertion order if successful. (insertionOrders.create)

delete(string $advertiserId, string $insertionOrderId, array $optParams = [])

Deletes an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

get(string $advertiserId, string $insertionOrderId, array $optParams = [])

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. (insertionOrders.get)

listAdvertisersInsertionOrders(string $advertiserId, array $optParams = [])

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED will not be included in the results.

listAssignedTargetingOptions(string $advertiserId, string $insertionOrderId, array $optParams = [])

Lists assigned targeting options of an insertion order across targeting types. (insertionOrders.listAssignedTargetingOptions)

patch(string $advertiserId, string $insertionOrderId, InsertionOrder $postBody, array $optParams = [])

Updates an existing insertion order. Returns the updated insertion order if successful. (insertionOrders.patch)

Details

InsertionOrder create(string $advertiserId, InsertionOrder $postBody, array $optParams = [])

Creates a new insertion order. Returns the newly created insertion order if successful. (insertionOrders.create)

Parameters

string $advertiserId

Output only. The unique ID of the advertiser the insertion order belongs to.

InsertionOrder $postBody
array $optParams

Optional parameters.

Return Value

InsertionOrder

Exceptions

Exception

DisplayvideoEmpty delete(string $advertiserId, string $insertionOrderId, array $optParams = [])

Deletes an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

(insertionOrders.delete)

Parameters

string $advertiserId

The ID of the advertiser this insertion order belongs to.

string $insertionOrderId

The ID of the insertion order to delete.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

InsertionOrder get(string $advertiserId, string $insertionOrderId, array $optParams = [])

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. (insertionOrders.get)

Parameters

string $advertiserId

Required. The ID of the advertiser this insertion order belongs to.

string $insertionOrderId

Required. The ID of the insertion order to fetch.

array $optParams

Optional parameters.

Return Value

InsertionOrder

Exceptions

Exception

ListInsertionOrdersResponse listAdvertisersInsertionOrders(string $advertiserId, array $optParams = [])

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED will not be included in the results.

(insertionOrders.listAdvertisersInsertionOrders)

Parameters

string $advertiserId

Required. The ID of the advertiser to list insertion orders for.

array $optParams

Optional parameters.

Return Value

ListInsertionOrdersResponse

Exceptions

Exception

BulkListInsertionOrderAssignedTargetingOptionsResponse listAssignedTargetingOptions(string $advertiserId, string $insertionOrderId, array $optParams = [])

Lists assigned targeting options of an insertion order across targeting types. (insertionOrders.listAssignedTargetingOptions)

Parameters

string $advertiserId

Required. The ID of the advertiser the insertion order belongs to.

string $insertionOrderId

Required. The ID of the insertion order to list assigned targeting options for.

array $optParams

Optional parameters.

Return Value

BulkListInsertionOrderAssignedTargetingOptionsResponse

Exceptions

Exception

InsertionOrder patch(string $advertiserId, string $insertionOrderId, InsertionOrder $postBody, array $optParams = [])

Updates an existing insertion order. Returns the updated insertion order if successful. (insertionOrders.patch)

Parameters

string $advertiserId

Output only. The unique ID of the advertiser the insertion order belongs to.

string $insertionOrderId

Output only. The unique ID of the insertion order. Assigned by the system.

InsertionOrder $postBody
array $optParams

Optional parameters.

Return Value

InsertionOrder

Exceptions

Exception