Documentation

Google_Service_GoogleAnalyticsAdmin_Resource_Accounts extends Google_Service_Resource
in package

Application

The "accounts" collection of methods.

Typical usage is: $analyticsadminService = new Google_Service_GoogleAnalyticsAdmin(...); $accounts = $analyticsadminService->accounts;

$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.
delete() : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty: Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged.
get() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount: Lookup for a single Account. Throws "Target not found" if no such account found, or if caller does not have permissions to access it. (accounts.get)
getDataSharingSettings() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaDataSharingSettings: Get data sharing settings on an account. Data sharing settings are singletons. (accounts.getDataSharingSettings)
listAccounts() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListAccountsResponse: Returns all accounts accessible by the caller. Note that these accounts might not currently have App+Web properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. (accounts.listAccounts)
patch() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount: Updates an account. (accounts.patch)
provisionAccountTicket() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse: Requests a ticket for creating an account. (accounts.provisionAccountTicket)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

delete()

Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty

https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. (accounts.delete)

Parameters

$name : string: Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty —

get()

Lookup for a single Account. Throws "Target not found" if no such account found, or if caller does not have permissions to access it. (accounts.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount

Parameters

$name : string: Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount —

getDataSharingSettings()

Get data sharing settings on an account. Data sharing settings are singletons. (accounts.getDataSharingSettings)


    public
                getDataSharingSettings(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaDataSharingSettings

Parameters

$name : string: Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaDataSharingSettings —

listAccounts()

Returns all accounts accessible by the caller. Note that these accounts might not currently have App+Web properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. (accounts.listAccounts)


    public
                listAccounts([array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListAccountsResponse

Parameters

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

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListAccountsResponse —

patch()

Updates an account. (accounts.patch)


    public
                patch(string $name, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount

Parameters

$name : string: Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAccount —

provisionAccountTicket()

Requests a ticket for creating an account. (accounts.provisionAccountTicket)


    public
                provisionAccountTicket(Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse

Parameters

$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —