Google_Service_Dfareporting_UserRoles_Resource Class Reference

The "userRoles" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_UserRoles_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "userRoles" collection of methods.

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

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

Deletes an existing user role.

(userRoles.delete)

Parameters

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

get()

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

Gets one user role by ID.

(userRoles.get)

Parameters

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

Return values

Google_Service_Dfareporting_UserRole

insert()

Google_Service_Dfareporting_UserRoles_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_UserRole	$postBody,
			$optParams = array() )

Inserts a new user role.

(userRoles.insert)

Parameters

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

Return values

Google_Service_Dfareporting_UserRole

listUserRoles()

Google_Service_Dfareporting_UserRoles_Resource::listUserRoles	(		$profileId,
			$optParams = array() )

Retrieves a list of user roles, possibly filtered.

(userRoles.listUserRoles)

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, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 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 "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". @opt_param string subaccountId Select only user roles that belong to this subaccount. @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only user roles with the specified 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 accountUserRoleOnly Select only account level user roles not associated with any specific subaccount.

Return values

Google_Service_Dfareporting_UserRolesListResponse

patch()

Google_Service_Dfareporting_UserRoles_Resource::patch	(		$profileId,
			$id,
		Google_Service_Dfareporting_UserRole	$postBody,
			$optParams = array() )

Updates an existing user role.

This method supports patch semantics. (userRoles.patch)

Parameters

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

Return values

Google_Service_Dfareporting_UserRole

update()

Google_Service_Dfareporting_UserRoles_Resource::update	(		$profileId,
		Google_Service_Dfareporting_UserRole	$postBody,
			$optParams = array() )

Updates an existing user role.

(userRoles.update)

Parameters

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

Return values

Google_Service_Dfareporting_UserRole

---

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

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