Documentation

Google_Service_Dfareporting_Resource_AdvertiserGroups extends Google_Service_Resource
in package

The "advertiserGroups" collection of methods.

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

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 advertiser group. (advertiserGroups.delete)
get()  : Google_Service_Dfareporting_AdvertiserGroup
Gets one advertiser group by ID. (advertiserGroups.get)
insert()  : Google_Service_Dfareporting_AdvertiserGroup
Inserts a new advertiser group. (advertiserGroups.insert)
listAdvertiserGroups()  : Google_Service_Dfareporting_AdvertiserGroupsListResponse
Retrieves a list of advertiser groups, possibly filtered. This method supports paging. (advertiserGroups.listAdvertiserGroups)
patch()  : Google_Service_Dfareporting_AdvertiserGroup
Updates an existing advertiser group. This method supports patch semantics.
update()  : Google_Service_Dfareporting_AdvertiserGroup
Updates an existing advertiser group. (advertiserGroups.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 advertiser group. (advertiserGroups.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

Advertiser group ID.

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

Optional parameters.

Return values
mixed —

insert()

Inserts a new advertiser group. (advertiserGroups.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AdvertiserGroup —

listAdvertiserGroups()

Retrieves a list of advertiser groups, possibly filtered. This method supports paging. (advertiserGroups.listAdvertiserGroups)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string sortField Field by which to sort the list.

opt_param

int maxResults Maximum number of results to return.

opt_param

string sortOrder Order of sorted results.

opt_param

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

opt_param

string ids Select only advertiser groups with these IDs.

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".

Return values
Google_Service_Dfareporting_AdvertiserGroupsListResponse —

patch()

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

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

(advertiserGroups.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

AdvertiserGroup ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AdvertiserGroup —

update()

Updates an existing advertiser group. (advertiserGroups.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AdvertiserGroup —

convertToArrayAndStripNulls()

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

Search results