Documentation

Google_Service_AdExchangeBuyerII_Resource_AccountsClientsUsers extends Google_Service_Resource
in package

The "users" collection of methods.

Typical usage is: $adexchangebuyer2Service = new Google_Service_AdExchangeBuyerII(...); $users = $adexchangebuyer2Service->users;

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_AdExchangeBuyerII_ClientUser
Retrieves an existing client user. (users.get)
listAccountsClientsUsers()  : Google_Service_AdExchangeBuyerII_ListClientUsersResponse
Lists all the known client users for a specified sponsor buyer account ID.
update()  : Google_Service_AdExchangeBuyerII_ClientUser
Updates an existing client user. Only the user status can be changed on update. (users.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

get()

Retrieves an existing client user. (users.get)

public get(string $accountId, string $clientAccountId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ClientUser
Parameters
$accountId : string

Numerical account ID of the client's sponsor buyer. (required)

$clientAccountId : string

Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

$userId : string

Numerical identifier of the user to retrieve. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_ClientUser —

listAccountsClientsUsers()

Lists all the known client users for a specified sponsor buyer account ID.

public listAccountsClientsUsers(string $accountId, string $clientAccountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ListClientUsersResponse

(users.listAccountsClientsUsers)

Parameters
$accountId : string

Numerical account ID of the sponsor buyer of the client to list users for. (required)

$clientAccountId : string

The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the - character to list all the client users for all the clients of a given sponsor buyer.

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

Optional parameters.

Tags
opt_param

int pageSize Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

Return values
Google_Service_AdExchangeBuyerII_ListClientUsersResponse —

update()

Updates an existing client user. Only the user status can be changed on update. (users.update)

public update(string $accountId, string $clientAccountId, string $userId, Google_Service_AdExchangeBuyerII_ClientUser $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ClientUser
Parameters
$accountId : string

Numerical account ID of the client's sponsor buyer. (required)

$clientAccountId : string

Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

$userId : string

Numerical identifier of the user to retrieve. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_ClientUser —

convertToArrayAndStripNulls()

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

Search results