Documentation

Google_Service_Dfareporting_Resource_CreativeGroups extends Google_Service_Resource
in package

The "creativeGroups" collection of methods.

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

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_CreativeGroup
Gets one creative group by ID. (creativeGroups.get)
insert()  : Google_Service_Dfareporting_CreativeGroup
Inserts a new creative group. (creativeGroups.insert)
listCreativeGroups()  : Google_Service_Dfareporting_CreativeGroupsListResponse
Retrieves a list of creative groups, possibly filtered. This method supports paging. (creativeGroups.listCreativeGroups)
patch()  : Google_Service_Dfareporting_CreativeGroup
Updates an existing creative group. This method supports patch semantics.
update()  : Google_Service_Dfareporting_CreativeGroup
Updates an existing creative group. (creativeGroups.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

insert()

Inserts a new creative group. (creativeGroups.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeGroup —

listCreativeGroups()

Retrieves a list of creative groups, possibly filtered. This method supports paging. (creativeGroups.listCreativeGroups)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

int groupNumber Select only creative groups that belong to this subgroup.

opt_param

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

opt_param

string sortOrder Order of sorted results.

opt_param

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

opt_param

string ids Select only creative groups with these IDs.

opt_param

string searchString Allows searching for creative groups by name or ID. Wildcards () are allowed. For example, "creativegroup2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 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 "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".

opt_param

string sortField Field by which to sort the list.

opt_param

int maxResults Maximum number of results to return.

Return values
Google_Service_Dfareporting_CreativeGroupsListResponse —

patch()

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

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

(creativeGroups.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

CreativeGroup ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeGroup —

update()

Updates an existing creative group. (creativeGroups.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_CreativeGroup —

convertToArrayAndStripNulls()

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

Search results