Google_Service_Dfareporting_Advertisers_Resource Class Reference

The "advertisers" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Advertisers_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "advertisers" collection of methods.

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

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

get()

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

Gets one advertiser by ID.

(advertisers.get)

Parameters

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

Return values

Google_Service_Dfareporting_Advertiser

insert()

Google_Service_Dfareporting_Advertisers_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Advertiser	$postBody,
			$optParams = array() )

Inserts a new advertiser.

(advertisers.insert)

Parameters

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

Return values

Google_Service_Dfareporting_Advertiser

listAdvertisers()

Google_Service_Dfareporting_Advertisers_Resource::listAdvertisers	(		$profileId,
			$optParams = array() )

Retrieves a list of advertisers, possibly filtered.

(advertisers.listAdvertisers)

Parameters

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

@opt_param string status Select only advertisers with the specified status. @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 June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". @opt_param string subaccountId Select only advertisers with these subaccount IDs. @opt_param bool includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only advertisers 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 bool onlyParent Select only advertisers which use another advertiser's floodlight configuration. @opt_param string sortOrder Order of sorted results, default is ASCENDING. @opt_param string floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. @opt_param string advertiserGroupIds Select only advertisers with these advertiser group IDs.

Return values

Google_Service_Dfareporting_AdvertisersListResponse

patch()

Google_Service_Dfareporting_Advertisers_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Advertiser	$postBody,
			$optParams = array() )

Updates an existing advertiser.

This method supports patch semantics. (advertisers.patch)

Parameters

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

Return values

Google_Service_Dfareporting_Advertiser

update()

Google_Service_Dfareporting_Advertisers_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Advertiser	$postBody,
			$optParams = array() )

Updates an existing advertiser.

(advertisers.update)

Parameters

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

Return values

Google_Service_Dfareporting_Advertiser

---

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

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