Documentation

Google_Service_Dfareporting_Resource_Campaigns extends Google_Service_Resource
in package

The "campaigns" collection of methods.

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

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_Campaign
Gets one campaign by ID. (campaigns.get)
insert()  : Google_Service_Dfareporting_Campaign
Inserts a new campaign. (campaigns.insert)
listCampaigns()  : Google_Service_Dfareporting_CampaignsListResponse
Retrieves a list of campaigns, possibly filtered. This method supports paging. (campaigns.listCampaigns)
patch()  : Google_Service_Dfareporting_Campaign
Updates an existing campaign. This method supports patch semantics.
update()  : Google_Service_Dfareporting_Campaign
Updates an existing campaign. (campaigns.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 campaign by ID. (campaigns.get)

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

User profile ID associated with this request.

$id : string

Campaign ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Campaign —

listCampaigns()

Retrieves a list of campaigns, possibly filtered. This method supports paging. (campaigns.listCampaigns)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string ids Select only campaigns with these 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 pageToken Value of the nextPageToken from the previous result page.

opt_param

string excludedIds Exclude campaigns with these IDs.

opt_param

string advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups.

opt_param

bool atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity.

opt_param

bool archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

opt_param

string subaccountId Select only campaigns that belong to this subaccount.

opt_param

string overriddenEventTagId Select only campaigns that have overridden this event tag ID.

opt_param

string sortOrder Order of sorted results.

opt_param

string advertiserIds Select only campaigns that belong to these advertisers.

opt_param

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

Return values
Google_Service_Dfareporting_CampaignsListResponse —

patch()

Updates an existing campaign. This method supports patch semantics.

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

(campaigns.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Campaign ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Campaign —

update()

Updates an existing campaign. (campaigns.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Campaign —

convertToArrayAndStripNulls()

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

Search results