Documentation

Google_Service_Dfareporting_Resource_Subaccounts extends Google_Service_Resource
in package

The "subaccounts" collection of methods.

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

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_Subaccount
Gets one subaccount by ID. (subaccounts.get)
insert()  : Google_Service_Dfareporting_Subaccount
Inserts a new subaccount. (subaccounts.insert)
listSubaccounts()  : Google_Service_Dfareporting_SubaccountsListResponse
Gets a list of subaccounts, possibly filtered. This method supports paging.
patch()  : Google_Service_Dfareporting_Subaccount
Updates an existing subaccount. This method supports patch semantics.
update()  : Google_Service_Dfareporting_Subaccount
Updates an existing subaccount. (subaccounts.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 subaccount. (subaccounts.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Subaccount —

listSubaccounts()

Gets a list of subaccounts, possibly filtered. This method supports paging.

public listSubaccounts(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_SubaccountsListResponse

(subaccounts.listSubaccounts)

Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

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

opt_param

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

opt_param

int maxResults Maximum number of results to return.

opt_param

string sortField Field by which to sort the list.

opt_param

string ids Select only subaccounts with these IDs.

opt_param

string sortOrder Order of sorted results.

Return values
Google_Service_Dfareporting_SubaccountsListResponse —

patch()

Updates an existing subaccount. This method supports patch semantics.

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

(subaccounts.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Subaccount ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Subaccount —

update()

Updates an existing subaccount. (subaccounts.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_Subaccount —

convertToArrayAndStripNulls()

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

Search results