Documentation

Google_Service_Dfareporting_Resource_EventTags extends Google_Service_Resource
in package

The "eventTags" collection of methods.

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

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 event tag. (eventTags.delete)
get()  : Google_Service_Dfareporting_EventTag
Gets one event tag by ID. (eventTags.get)
insert()  : Google_Service_Dfareporting_EventTag
Inserts a new event tag. (eventTags.insert)
listEventTags()  : Google_Service_Dfareporting_EventTagsListResponse
Retrieves a list of event tags, possibly filtered. (eventTags.listEventTags)
patch()  : Google_Service_Dfareporting_EventTag
Updates an existing event tag. This method supports patch semantics.
update()  : Google_Service_Dfareporting_EventTag
Updates an existing event tag. (eventTags.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 event tag. (eventTags.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

Event tag ID.

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

Optional parameters.

Return values
mixed —

get()

Gets one event tag by ID. (eventTags.get)

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

User profile ID associated with this request.

$id : string

Event tag ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_EventTag —

listEventTags()

Retrieves a list of event tags, possibly filtered. (eventTags.listEventTags)

public listEventTags(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_EventTagsListResponse
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

string adId Select only event tags that belong to this ad.

opt_param

string sortOrder Order of sorted results.

opt_param

bool enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

opt_param

string eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click- through URL for either impression or click tracking.

opt_param

bool definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

opt_param

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

opt_param

string advertiserId Select only event tags that belong to this advertiser.

opt_param

string ids Select only event tags with these IDs.

opt_param

string campaignId Select only event tags that belong to this campaign.

Return values
Google_Service_Dfareporting_EventTagsListResponse —

patch()

Updates an existing event tag. This method supports patch semantics.

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

(eventTags.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

EventTag ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_EventTag —

update()

Updates an existing event tag. (eventTags.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_EventTag —

convertToArrayAndStripNulls()

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

Search results