1. class
  2. Google
  3. \
  4. Service
  5. \
  6. GoogleAnalyticsAdmin
  7. \
  8. Resource
  9. \
  10. PropertiesUserLinks

PropertiesUserLinks

class PropertiesUserLinks extends Resource (View source)

The "userLinks" collection of methods.

Typical usage is:

 $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
 $userLinks = $analyticsadminService->userLinks;

Methods

GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
audit(string $parent, GoogleAnalyticsAdminV1alphaAuditUserLinksRequest $postBody, array $optParams = [])

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)

GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
batchCreate(string $parent, GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest $postBody, array $optParams = [])

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

GoogleProtobufEmpty
batchDelete(string $parent, GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest $postBody, array $optParams = [])

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

GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
batchGet(string $parent, array $optParams = [])

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

GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
batchUpdate(string $parent, GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest $postBody, array $optParams = [])

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

GoogleAnalyticsAdminV1alphaUserLink
create(string $parent, GoogleAnalyticsAdminV1alphaUserLink $postBody, array $optParams = [])

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)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

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

GoogleAnalyticsAdminV1alphaUserLink
get(string $name, array $optParams = [])

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

GoogleAnalyticsAdminV1alphaListUserLinksResponse
listPropertiesUserLinks(string $parent, array $optParams = [])

Lists all user links on an account or property.

GoogleAnalyticsAdminV1alphaUserLink
patch(string $name, GoogleAnalyticsAdminV1alphaUserLink $postBody, array $optParams = [])

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

Details

at line 56
GoogleAnalyticsAdminV1alphaAuditUserLinksResponse audit(string $parent, GoogleAnalyticsAdminV1alphaAuditUserLinksRequest $postBody, array $optParams = [])

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)

Parameters

string $parent

Required. Example format: accounts/1234
GoogleAnalyticsAdminV1alphaAuditUserLinksRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaAuditUserLinksResponse

at line 75
GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse batchCreate(string $parent, GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest $postBody, array $optParams = [])

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

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

Parameters

string $parent

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
GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse

at line 92
GoogleProtobufEmpty batchDelete(string $parent, GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest $postBody, array $optParams = [])

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

(userLinks.batchDelete)

Parameters

string $parent

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
GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

at line 112
GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse batchGet(string $parent, array $optParams = [])

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

(userLinks.batchGet)

Parameters

string $parent

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
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse

at line 130
GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse batchUpdate(string $parent, GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest $postBody, array $optParams = [])

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

(userLinks.batchUpdate)

Parameters

string $parent

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
GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse

at line 150
GoogleAnalyticsAdminV1alphaUserLink create(string $parent, GoogleAnalyticsAdminV1alphaUserLink $postBody, array $optParams = [])

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)

Parameters

string $parent

Required. Example format: accounts/1234
GoogleAnalyticsAdminV1alphaUserLink $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaUserLink

at line 163
GoogleProtobufEmpty delete(string $name, array $optParams = [])

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

Parameters

string $name

Required. Example format: accounts/1234/userLinks/5678
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

at line 177
GoogleAnalyticsAdminV1alphaUserLink get(string $name, array $optParams = [])

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

(userLinks.get)

Parameters

string $name

Required. Example format: accounts/1234/userLinks/5678
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaUserLink

Lists all user links on an account or property.

(userLinks.listPropertiesUserLinks)

Parameters

string $parent

Required. Example format: accounts/1234
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaListUserLinksResponse

at line 215
GoogleAnalyticsAdminV1alphaUserLink patch(string $name, GoogleAnalyticsAdminV1alphaUserLink $postBody, array $optParams = [])

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

Parameters

string $name

Output only. Example format: properties/1234/userLinks/5678
GoogleAnalyticsAdminV1alphaUserLink $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1alphaUserLink