Google_Service_Dfareporting_EventTags_Resource Class Reference

The "eventTags" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_EventTags_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($profileId, $id, $optParams=array())
	Deletes an existing event tag.
	get ($profileId, $id, $optParams=array())
	Gets one event tag by ID.
	insert ($profileId, Google_Service_Dfareporting_EventTag $postBody, $optParams=array())
	Inserts a new event tag.
	listEventTags ($profileId, $optParams=array())
	Retrieves a list of event tags, possibly filtered.
	patch ($profileId, $id, Google_Service_Dfareporting_EventTag $postBody, $optParams=array())
	Updates an existing event tag.
	update ($profileId, Google_Service_Dfareporting_EventTag $postBody, $optParams=array())
	Updates an existing event tag.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "eventTags" collection of methods.

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

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_Dfareporting_EventTags_Resource::delete	(		$profileId,
			$id,
			$optParams = array() )

Deletes an existing event tag.

(eventTags.delete)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Event tag ID.
array	$optParams	Optional parameters.

get()

Google_Service_Dfareporting_EventTags_Resource::get	(		$profileId,
			$id,
			$optParams = array() )

Gets one event tag by ID.

(eventTags.get)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Event tag ID.
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_EventTag

insert()

Google_Service_Dfareporting_EventTags_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_EventTag	$postBody,
			$optParams = array() )

Inserts a new event tag.

(eventTags.insert)

Parameters

string	$profileId	User profile ID associated with this request.
Google_EventTag	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_EventTag

listEventTags()

Google_Service_Dfareporting_EventTags_Resource::listEventTags	(		$profileId,
			$optParams = array() )

Retrieves a list of event tags, possibly filtered.

(eventTags.listEventTags)

Parameters

string	$profileId	User profile ID associated with this request.
array	$optParams	Optional parameters.

@opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" 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 campaignId Select only event tags that belong to this campaign. @opt_param string sortField Field by which to sort the list. @opt_param bool enabled Select only enabled event tags. 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 ids Select only event tags with these IDs. @opt_param string advertiserId Select only event tags that belong to this advertiser. @opt_param string adId Select only event tags that belong to this ad. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @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 ad or campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign is examined as well. In addition, when set to false, the status field is examined as well along with the enabledByDefault field.

Return values

Google_Service_Dfareporting_EventTagsListResponse

patch()

Google_Service_Dfareporting_EventTags_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_EventTag	$postBody,
			$optParams = array() )

Updates an existing event tag.

This method supports patch semantics. (eventTags.patch)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Event tag ID.
Google_EventTag	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_EventTag

update()

Google_Service_Dfareporting_EventTags_Resource::update	(		$profileId,
		Google_Service_Dfareporting_EventTag	$postBody,
			$optParams = array() )

Updates an existing event tag.

(eventTags.update)

Parameters

string	$profileId	User profile ID associated with this request.
Google_EventTag	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_EventTag

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Dfareporting.php