Documentation

Google_Service_DisplayVideo_Resource_AdvertisersCreatives extends Google_Service_Resource
in package

Application

The "creatives" collection of methods.

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

$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_Creative: Creates a new creative. Returns the newly created creative if successful.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DisplayVideo_DisplayvideoEmpty: Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. (creatives.delete)
get() : Google_Service_DisplayVideo_Creative: Gets a creative. (creatives.get)
listAdvertisersCreatives() : Google_Service_DisplayVideo_ListCreativesResponse: Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
patch() : Google_Service_DisplayVideo_Creative: Updates an existing creative. Returns the updated creative if successful.
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 creative. Returns the newly created creative if successful.


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

(creatives.create)

Parameters

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

Return values

Google_Service_DisplayVideo_Creative —

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 a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. (creatives.delete)


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

Parameters

$advertiserId : string: The ID of the advertiser this creative belongs to.
$creativeId : string: The ID of the creative to be deleted.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DisplayVideo_DisplayvideoEmpty —

get()

Gets a creative. (creatives.get)


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

Parameters

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

Return values

Google_Service_DisplayVideo_Creative —

listAdvertisersCreatives()

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


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

(creatives.listAdvertisersCreatives)

Parameters

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

Return values

Google_Service_DisplayVideo_ListCreativesResponse —

patch()

Updates an existing creative. Returns the updated creative if successful.


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

(creatives.patch)

Parameters

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

Return values

Google_Service_DisplayVideo_Creative —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —