Documentation

Google_Service_AdExchangeBuyerII_Resource_AccountsClientsInvitations extends Google_Service_Resource
in package

The "invitations" collection of methods.

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

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.
create()  : Google_Service_AdExchangeBuyerII_ClientUserInvitation
Creates and sends out an email invitation to access an Ad Exchange client buyer account. (invitations.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AdExchangeBuyerII_ClientUserInvitation
Retrieves an existing client user invitation. (invitations.get)
listAccountsClientsInvitations()  : Google_Service_AdExchangeBuyerII_ListClientUserInvitationsResponse
Lists all the client users invitations for a client with a given account ID.
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 —

create()

Creates and sends out an email invitation to access an Ad Exchange client buyer account. (invitations.create)

public create(string $accountId, string $clientAccountId, Google_Service_AdExchangeBuyerII_ClientUserInvitation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ClientUserInvitation
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 should be associated with. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_ClientUserInvitation —

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 invitation. (invitations.get)

public get(string $accountId, string $clientAccountId, string $invitationId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ClientUserInvitation
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 invitation to be retrieved is associated with. (required)

$invitationId : string

Numerical identifier of the user invitation to retrieve. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_ClientUserInvitation —

listAccountsClientsInvitations()

Lists all the client users invitations for a client with a given account ID.

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

(invitations.listAccountsClientsInvitations)

Parameters
$accountId : string

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

$clientAccountId : string

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

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

Optional parameters.

Tags
opt_param

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

opt_param

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

Return values
Google_Service_AdExchangeBuyerII_ListClientUserInvitationsResponse —

convertToArrayAndStripNulls()

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

Search results