Documentation

Google_Service_Dfareporting_Resource_Creatives extends Google_Service_Resource
in package

The "creatives" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $creatives = $dfareportingService->creatives;

Table of Contents

$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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Dfareporting_Creative
Gets one creative by ID. (creatives.get)
insert()  : Google_Service_Dfareporting_Creative
Inserts a new creative. (creatives.insert)
listCreatives()  : Google_Service_Dfareporting_CreativesListResponse
Retrieves a list of creatives, possibly filtered. This method supports paging. (creatives.listCreatives)
patch()  : Google_Service_Dfareporting_Creative
Updates an existing creative. This method supports patch semantics.
update()  : Google_Service_Dfareporting_Creative
Updates an existing creative. (creatives.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

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>
Tags
static
Return values
string —

$requestUrl

get()

Gets one creative by ID. (creatives.get)

public get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Creative
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Creative ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_Creative —

listCreatives()

Retrieves a list of creatives, possibly filtered. This method supports paging. (creatives.listCreatives)

public listCreatives(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_CreativesListResponse
Parameters
$profileId : string

User profile ID associated with this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string renderingIds Select only creatives with these rendering IDs.

opt_param

string advertiserId Select only creatives with this advertiser ID.

opt_param

string types Select only creatives with these creative types.

opt_param

string creativeFieldIds Select only creatives with these creative field IDs.

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "creative2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".

opt_param

string sortOrder Order of sorted results.

opt_param

bool archived Select only archived creatives. Leave blank to select archived and unarchived creatives.

opt_param

string companionCreativeIds Select only in-stream video creatives with these companion IDs.

opt_param

bool active Select only active creatives. Leave blank to select active and inactive creatives.

opt_param

string ids Select only creatives with these IDs.

opt_param

string studioCreativeId Select only creatives corresponding to this Studio creative ID.

opt_param

string sizeIds Select only creatives with these size IDs.

opt_param

int maxResults Maximum number of results to return.

opt_param

string sortField Field by which to sort the list.

opt_param

string campaignId Select only creatives with this campaign ID.

Return values
Google_Service_Dfareporting_CreativesListResponse —

patch()

Updates an existing creative. This method supports patch semantics.

public patch(string $profileId, string $id, Google_Service_Dfareporting_Creative $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Creative

(creatives.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Creative ID.

$postBody : Google_Service_Dfareporting_Creative
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_Creative —

update()

Updates an existing creative. (creatives.update)

public update(string $profileId, Google_Service_Dfareporting_Creative $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Creative
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_Creative
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_Creative —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results