Documentation

Google_Service_AdExchangeBuyerII_Resource_AccountsClients extends Google_Service_Resource
in package

The "clients" collection of methods.

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

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_Client
Creates a new client buyer. (clients.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AdExchangeBuyerII_Client
Gets a client buyer with a given client account ID. (clients.get)
listAccountsClients()  : Google_Service_AdExchangeBuyerII_ListClientsResponse
Lists all the clients for the current sponsor buyer.
update()  : Google_Service_AdExchangeBuyerII_Client
Updates an existing client buyer. (clients.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 —

create()

Creates a new client buyer. (clients.create)

public create(string $accountId, Google_Service_AdExchangeBuyerII_Client $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Client
Parameters
$accountId : string

Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Client —

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()

Gets a client buyer with a given client account ID. (clients.get)

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

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

$clientAccountId : string

Numerical account ID of the client buyer to retrieve. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Client —

listAccountsClients()

Lists all the clients for the current sponsor buyer.

public listAccountsClients(string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ListClientsResponse

(clients.listAccountsClients)

Parameters
$accountId : string

Unique numerical account ID of the sponsor buyer to list the clients for.

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

Optional parameters.

Tags
opt_param

string partnerClientId Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.

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 ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.

Return values
Google_Service_AdExchangeBuyerII_ListClientsResponse —

update()

Updates an existing client buyer. (clients.update)

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

Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)

$clientAccountId : string

Unique numerical account ID of the client to update. (required)

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Client —

convertToArrayAndStripNulls()

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

Search results