Documentation

Google_Service_GoogleAnalyticsAdmin_Resource_AccountsUserLinks extends Google_Service_Resource
in package

Application

The "userLinks" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
audit() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAuditUserLinksResponse: Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs. (userLinks.audit)
batchCreate() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse: Creates information about multiple users' links to an account or property.
batchDelete() : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty: Deletes information about multiple users' links to an account or property.
batchGet() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse: Gets information about multiple users' links to an account or property.
batchUpdate() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse: Updates information about multiple users' links to an account or property.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink: Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink. (userLinks.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty: Deletes a user link on an account or property. (userLinks.delete)
get() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink: Gets information about a user's link to an account or property.
listAccountsUserLinks() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListUserLinksResponse: Lists all user links on an account or property.
patch() : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink: Updates a user link on an account or property. (userLinks.patch)
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 —

audit()

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs. (userLinks.audit)


    public
                audit(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAuditUserLinksRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAuditUserLinksResponse

Parameters

$parent : string: Required. Example format: accounts/1234
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAuditUserLinksRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaAuditUserLinksResponse —

batchCreate()

Creates information about multiple users' links to an account or property.


    public
                batchCreate(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse

This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created. (userLinks.batchCreate)

Parameters

$parent : string: Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse —

batchDelete()

Deletes information about multiple users' links to an account or property.


    public
                batchDelete(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty

(userLinks.batchDelete)

Parameters

$parent : string: Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty —

batchGet()

Gets information about multiple users' links to an account or property.


    public
                batchGet(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse

(userLinks.batchGet)

Parameters

$parent : string: Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse —

batchUpdate()

Updates information about multiple users' links to an account or property.


    public
                batchUpdate(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse

(userLinks.batchUpdate)

Parameters

$parent : string: Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse —

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 —

create()

Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink. (userLinks.create)


    public
                create(string $parent, Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink

Parameters

$parent : string: Required. Example format: accounts/1234
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink —

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

Deletes a user link on an account or property. (userLinks.delete)


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

Parameters

$name : string: Required. Example format: accounts/1234/userLinks/5678
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleProtobufEmpty —

get()

Gets information about a user's link to an account or property.


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

(userLinks.get)

Parameters

$name : string: Required. Example format: accounts/1234/userLinks/5678
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink —

listAccountsUserLinks()

Lists all user links on an account or property.


    public
                listAccountsUserLinks(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListUserLinksResponse

(userLinks.listAccountsUserLinks)

Parameters

$parent : string: Required. Example format: accounts/1234
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaListUserLinksResponse —

patch()

Updates a user link on an account or property. (userLinks.patch)


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

Parameters

$name : string: Example format: properties/1234/userLinks/5678
$postBody : Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GoogleAnalyticsAdmin_GoogleAnalyticsAdminV1alphaUserLink —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —