Documentation

Google_Service_DisplayVideo_Resource_AdvertisersInsertionOrders extends Google_Service_Resource
in package

Application

The "insertionOrders" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $insertionOrders = $displayvideoService->insertionOrders;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_DisplayVideo_InsertionOrder: Creates a new insertion order. Returns the newly created insertion order if successful. (insertionOrders.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DisplayVideo_DisplayvideoEmpty: 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() : Google_Service_DisplayVideo_InsertionOrder: Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. (insertionOrders.get)
listAdvertisersInsertionOrders() : Google_Service_DisplayVideo_ListInsertionOrdersResponse: 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.
patch() : Google_Service_DisplayVideo_InsertionOrder: Updates an existing insertion order. Returns the updated insertion order if successful. (insertionOrders.patch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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


    public
                create(string $advertiserId, Google_Service_DisplayVideo_InsertionOrder $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_InsertionOrder

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the insertion order belongs to.
$postBody : Google_Service_DisplayVideo_InsertionOrder
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_InsertionOrder —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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.


    public
                delete(string $advertiserId, string $insertionOrderId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_DisplayvideoEmpty

(insertionOrders.delete)

Parameters

$advertiserId : string: The ID of the advertiser this insertion order belongs to.
$insertionOrderId : string: The ID of the insertion order we need to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_DisplayvideoEmpty —

get()

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


    public
                get(string $advertiserId, string $insertionOrderId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_InsertionOrder

Parameters

$advertiserId : string: Required. The ID of the advertiser this insertion order belongs to.
$insertionOrderId : string: Required. The ID of the insertion order to fetch.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_InsertionOrder —

listAdvertisersInsertionOrders()

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.


    public
                listAdvertisersInsertionOrders(string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListInsertionOrdersResponse

(insertionOrders.listAdvertisersInsertionOrders)

Parameters

$advertiserId : string: Required. The ID of the advertiser to list insertion orders for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_ListInsertionOrdersResponse —

patch()

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


    public
                patch(string $advertiserId, string $insertionOrderId, Google_Service_DisplayVideo_InsertionOrder $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_InsertionOrder

Parameters

$advertiserId : string: Output only. The unique ID of the advertiser the insertion order belongs to.
$insertionOrderId : string: Output only. The unique ID of the insertion order. Assigned by the system.
$postBody : Google_Service_DisplayVideo_InsertionOrder
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_InsertionOrder —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —