Google_Service_Dfareporting_Accounts_Resource Class Reference

The "accounts" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Accounts_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($profileId, $id, $optParams=array())
	Gets one account by ID.
	listAccounts ($profileId, $optParams=array())
	Retrieves the list of accounts, possibly filtered.
	patch ($profileId, $id, Google_Service_Dfareporting_Account $postBody, $optParams=array())
	Updates an existing account.
	update ($profileId, Google_Service_Dfareporting_Account $postBody, $optParams=array())
	Updates an existing account.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "accounts" collection of methods.

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

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

Gets one account by ID.

(accounts.get)

Parameters

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

Return values

Google_Service_Dfareporting_Account

listAccounts()

Google_Service_Dfareporting_Accounts_Resource::listAccounts	(		$profileId,
			$optParams = array() )

Retrieves the list of accounts, possibly filtered.

(accounts.listAccounts)

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, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 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 "account" will match objects with name "my account", "account 2015", or simply "account". @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only accounts 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. @opt_param bool active Select only active accounts. Don't set this field to select both active and non-active accounts.

Return values

Google_Service_Dfareporting_AccountsListResponse

patch()

Google_Service_Dfareporting_Accounts_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_Account	$postBody,
			$optParams = array() )

Updates an existing account.

This method supports patch semantics. (accounts.patch)

Parameters

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

Return values

Google_Service_Dfareporting_Account

update()

Google_Service_Dfareporting_Accounts_Resource::update	(		$profileId,
		Google_Service_Dfareporting_Account	$postBody,
			$optParams = array() )

Updates an existing account.

(accounts.update)

Parameters

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

Return values

Google_Service_Dfareporting_Account

---

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

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