Documentation

Google_Service_Dfareporting_Resource_AccountUserProfiles extends Google_Service_Resource
in package

The "accountUserProfiles" collection of methods.

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

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.
get()  : Google_Service_Dfareporting_AccountUserProfile
Gets one account user profile by ID. (accountUserProfiles.get)
insert()  : Google_Service_Dfareporting_AccountUserProfile
Inserts a new account user profile. (accountUserProfiles.insert)
listAccountUserProfiles()  : Google_Service_Dfareporting_AccountUserProfilesListResponse
Retrieves a list of account user profiles, possibly filtered. This method supports paging. (accountUserProfiles.listAccountUserProfiles)
patch()  : Google_Service_Dfareporting_AccountUserProfile
Updates an existing account user profile. This method supports patch semantics. (accountUserProfiles.patch)
update()  : Google_Service_Dfareporting_AccountUserProfile
Updates an existing account user profile. (accountUserProfiles.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

insert()

Inserts a new account user profile. (accountUserProfiles.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AccountUserProfile —

listAccountUserProfiles()

Retrieves a list of account user profiles, possibly filtered. This method supports paging. (accountUserProfiles.listAccountUserProfiles)

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

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum number of results to return.

opt_param

string ids Select only user profiles with these IDs.

opt_param

string sortOrder Order of sorted results.

opt_param

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

opt_param

string searchString Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 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 "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

opt_param

string sortField Field by which to sort the list.

opt_param

string userRoleId Select only user profiles with the specified user role ID.

opt_param

string subaccountId Select only user profiles with the specified subaccount ID.

opt_param

bool active Select only active user profiles.

Return values
Google_Service_Dfareporting_AccountUserProfilesListResponse —

patch()

Updates an existing account user profile. This method supports patch semantics. (accountUserProfiles.patch)

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

User profile ID associated with this request.

$id : string

AccountUserProfile ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AccountUserProfile —

update()

Updates an existing account user profile. (accountUserProfiles.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_AccountUserProfile —

convertToArrayAndStripNulls()

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

Search results