Documentation

Google_Service_Dfareporting_Resource_CreativeFields extends Google_Service_Resource
in package

The "creativeFields" collection of methods.

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

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.
delete()  : mixed
Deletes an existing creative field. (creativeFields.delete)
get()  : Google_Service_Dfareporting_CreativeField
Gets one creative field by ID. (creativeFields.get)
insert()  : Google_Service_Dfareporting_CreativeField
Inserts a new creative field. (creativeFields.insert)
listCreativeFields()  : Google_Service_Dfareporting_CreativeFieldsListResponse
Retrieves a list of creative fields, possibly filtered. This method supports paging. (creativeFields.listCreativeFields)
patch()  : Google_Service_Dfareporting_CreativeField
Updates an existing creative field. This method supports patch semantics.
update()  : Google_Service_Dfareporting_CreativeField
Updates an existing creative field. (creativeFields.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

delete()

Deletes an existing creative field. (creativeFields.delete)

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

User profile ID associated with this request.

$id : string

Creative Field ID

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

Optional parameters.

Return values
mixed —

insert()

Inserts a new creative field. (creativeFields.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeField —

listCreativeFields()

Retrieves a list of creative fields, possibly filtered. This method supports paging. (creativeFields.listCreativeFields)

public listCreativeFields(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_CreativeFieldsListResponse
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 searchString Allows searching for creative fields by name or ID. Wildcards () are allowed. For example, "creativefield2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".

opt_param

string ids Select only creative fields with these IDs.

opt_param

int maxResults Maximum number of results to return.

opt_param

string advertiserIds Select only creative fields that belong to these advertisers.

opt_param

string sortField Field by which to sort the list.

opt_param

string sortOrder Order of sorted results.

Return values
Google_Service_Dfareporting_CreativeFieldsListResponse —

patch()

Updates an existing creative field. This method supports patch semantics.

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

(creativeFields.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

CreativeField ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeField —

update()

Updates an existing creative field. (creativeFields.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeField —

convertToArrayAndStripNulls()

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

Search results