AdvertisersInsertionOrders
class AdvertisersInsertionOrders extends Resource (View source)
The "insertionOrders" collection of methods.
Typical usage is:
$displayvideoService = new Google\Service\DisplayVideo(...);
$insertionOrders = $displayvideoService->advertisers_insertionOrders;
Methods
Creates a new insertion order. Returns the newly created insertion order if successful. (insertionOrders.create)
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.
Gets an insertion order. Returns error code NOT_FOUND
if the insertion
order does not exist. (insertionOrders.get)
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.
Lists assigned targeting options of an insertion order across targeting types. (insertionOrders.listAssignedTargetingOptions)
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)
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)
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)
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)
BulkListInsertionOrderAssignedTargetingOptionsResponse
listAssignedTargetingOptions(string $advertiserId, string $insertionOrderId, array $optParams = [])
Lists assigned targeting options of an insertion order across targeting types. (insertionOrders.listAssignedTargetingOptions)
InsertionOrder
patch(string $advertiserId, string $insertionOrderId, InsertionOrder $postBody, array $optParams = [])
Updates an existing insertion order. Returns the updated insertion order if successful. (insertionOrders.patch)