Documentation

Google_Service_Dfareporting_Resource_UserRoles extends Google_Service_Resource
in package

The "userRoles" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes an existing user role. (userRoles.delete)
get()  : Google_Service_Dfareporting_UserRole
Gets one user role by ID. (userRoles.get)
insert()  : Google_Service_Dfareporting_UserRole
Inserts a new user role. (userRoles.insert)
listUserRoles()  : Google_Service_Dfareporting_UserRolesListResponse
Retrieves a list of user roles, possibly filtered. This method supports paging. (userRoles.listUserRoles)
patch()  : Google_Service_Dfareporting_UserRole
Updates an existing user role. This method supports patch semantics.
update()  : Google_Service_Dfareporting_UserRole
Updates an existing user role. (userRoles.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes an existing user role. (userRoles.delete)

public delete(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

User role ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

get()

Gets one user role by ID. (userRoles.get)

public get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_UserRole
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

User role ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_UserRole —

listUserRoles()

Retrieves a list of user roles, possibly filtered. This method supports paging. (userRoles.listUserRoles)

public listUserRoles(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_UserRolesListResponse
Parameters
$profileId : string

User profile ID associated with this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string sortOrder Order of sorted results.

opt_param

int maxResults Maximum number of results to return.

opt_param

string subaccountId Select only user roles that belong to this subaccount.

opt_param

bool accountUserRoleOnly Select only account level user roles not associated with any specific subaccount.

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "userrole2015" 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 ids Select only user roles with the specified IDs.

opt_param

string sortField Field by which to sort the list.

Return values
Google_Service_Dfareporting_UserRolesListResponse —

patch()

Updates an existing user role. This method supports patch semantics.

public patch(string $profileId, string $id, Google_Service_Dfareporting_UserRole $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_UserRole

(userRoles.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

UserRole ID.

$postBody : Google_Service_Dfareporting_UserRole
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_UserRole —

update()

Updates an existing user role. (userRoles.update)

public update(string $profileId, Google_Service_Dfareporting_UserRole $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_UserRole
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_UserRole
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_UserRole —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results