Google_Service_Dfareporting_AdvertiserGroups_Resource Class Reference

The "advertiserGroups" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_AdvertiserGroups_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "advertiserGroups" collection of methods.

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

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_AdvertiserGroups_Resource::delete	(		$profileId,
			$id,
			$optParams = array() )

Deletes an existing advertiser group.

(advertiserGroups.delete)

Parameters

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

get()

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

Gets one advertiser group by ID.

(advertiserGroups.get)

Parameters

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

Return values

Google_Service_Dfareporting_AdvertiserGroup

insert()

Google_Service_Dfareporting_AdvertiserGroups_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_AdvertiserGroup	$postBody,
			$optParams = array() )

Inserts a new advertiser group.

(advertiserGroups.insert)

Parameters

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

Return values

Google_Service_Dfareporting_AdvertiserGroup

listAdvertiserGroups()

Google_Service_Dfareporting_AdvertiserGroups_Resource::listAdvertiserGroups	(		$profileId,
			$optParams = array() )

Retrieves a list of advertiser groups, possibly filtered.

(advertiserGroups.listAdvertiserGroups)

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, "advertiser*2015" 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". @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only advertiser groups with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is ASCENDING.

Return values

Google_Service_Dfareporting_AdvertiserGroupsListResponse

patch()

Google_Service_Dfareporting_AdvertiserGroups_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_AdvertiserGroup	$postBody,
			$optParams = array() )

Updates an existing advertiser group.

This method supports patch semantics. (advertiserGroups.patch)

Parameters

string	$profileId	User profile ID associated with this request.
string	$id	Advertiser group ID.
Google_AdvertiserGroup	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_AdvertiserGroup

update()

Google_Service_Dfareporting_AdvertiserGroups_Resource::update	(		$profileId,
		Google_Service_Dfareporting_AdvertiserGroup	$postBody,
			$optParams = array() )

Updates an existing advertiser group.

(advertiserGroups.update)

Parameters

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

Return values

Google_Service_Dfareporting_AdvertiserGroup

---

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

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