2023-10-05
▼ ▲ analyticsadmin.properties.userLinks.batchDelete
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/analytics.manage.users
HTTP Method : POST
Parameters :
parent
Pattern : ^properties/[^/]+$
Description : 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
Required : Yes
Type : string
Location : path
Flat Path : v1alpha/properties/{propertiesId}/userLinks:batchDelete
Description : Deletes information about multiple users' links to an account or property.
Path : v1alpha/{+parent}/userLinks:batchDelete
▼ ▲ analyticsadmin.properties.userLinks.list
Scopes :
Path : v1alpha/{+parent}/userLinks
Parameter Order : parent
Parameters :
pageSize
Format : int32
Location : query
Description : The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.
Type : integer
parent
Type : string
Required : Yes
Location : path
Pattern : ^properties/[^/]+$
Description : Required. Example format: accounts/1234
pageToken
Description : A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.
Location : query
Type : string
Description : Lists all user links on an account or property.
Flat Path : v1alpha/properties/{propertiesId}/userLinks
HTTP Method : GET
▼ ▲ analyticsadmin.properties.userLinks.delete
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Description : Deletes a user link on an account or property.
Flat Path : v1alpha/properties/{propertiesId}/userLinks/{userLinksId}
Parameters :
name
Pattern : ^properties/[^/]+/userLinks/[^/]+$
Required : Yes
Location : path
Description : Required. Example format: accounts/1234/userLinks/5678
Type : string
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ analyticsadmin.properties.userLinks.patch
Parameter Order : name
HTTP Method : PATCH
Flat Path : v1alpha/properties/{propertiesId}/userLinks/{userLinksId}
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Parameters :
name
Description : Output only. Example format: properties/1234/userLinks/5678
Pattern : ^properties/[^/]+/userLinks/[^/]+$
Required : Yes
Location : path
Type : string
Description : Updates a user link on an account or property.
Path : v1alpha/{+name}
▼ ▲ analyticsadmin.properties.userLinks.get
Parameters :
name
Location : path
Description : Required. Example format: accounts/1234/userLinks/5678
Required : Yes
Pattern : ^properties/[^/]+/userLinks/[^/]+$
Type : string
Scopes :
Parameter Order : name
HTTP Method : GET
Flat Path : v1alpha/properties/{propertiesId}/userLinks/{userLinksId}
Path : v1alpha/{+name}
Description : Gets information about a user's link to an account or property.
▼ ▲ analyticsadmin.properties.userLinks.batchGet
HTTP Method : GET
Path : v1alpha/{+parent}/userLinks:batchGet
Flat Path : v1alpha/properties/{propertiesId}/userLinks:batchGet
Description : Gets information about multiple users' links to an account or property.
Scopes :
Parameter Order : parent
Parameters :
names
Type : string
Description : Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}
Location : query
Repeated : Yes
parent
Pattern : ^properties/[^/]+$
Description : 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
Required : Yes
Location : path
Type : string
▼ ▲ analyticsadmin.properties.userLinks.audit
Description : 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.
Flat Path : v1alpha/properties/{propertiesId}/userLinks:audit
HTTP Method : POST
Parameter Order : parent
Scopes :
Path : v1alpha/{+parent}/userLinks:audit
Parameters :
parent
Type : string
Required : Yes
Description : Required. Example format: accounts/1234
Pattern : ^properties/[^/]+$
Location : path
▼ ▲ analyticsadmin.properties.userLinks.batchCreate
HTTP Method : POST
Parameters :
parent
Type : string
Description : 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
Location : path
Required : Yes
Pattern : ^properties/[^/]+$
Description : 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.
Flat Path : v1alpha/properties/{propertiesId}/userLinks:batchCreate
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Path : v1alpha/{+parent}/userLinks:batchCreate
Parameter Order : parent
▼ ▲ analyticsadmin.properties.userLinks.batchUpdate
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Flat Path : v1alpha/properties/{propertiesId}/userLinks:batchUpdate
Parameters :
parent
Type : string
Pattern : ^properties/[^/]+$
Location : path
Required : Yes
Description : 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
Description : Updates information about multiple users' links to an account or property.
Path : v1alpha/{+parent}/userLinks:batchUpdate
Parameter Order : parent
HTTP Method : POST
▼ ▲ analyticsadmin.properties.userLinks.create
Path : v1alpha/{+parent}/userLinks
Parameters :
notifyNewUser
Description : Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
Type : boolean
Location : query
parent
Location : path
Type : string
Pattern : ^properties/[^/]+$
Description : Required. Example format: accounts/1234
Required : Yes
Flat Path : v1alpha/properties/{propertiesId}/userLinks
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Description : 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.
HTTP Method : POST
Parameter Order : parent
▼ ▲ analyticsadmin.accounts.userLinks.delete
Flat Path : v1alpha/accounts/{accountsId}/userLinks/{userLinksId}
Description : Deletes a user link on an account or property.
Parameters :
name
Location : path
Description : Required. Example format: accounts/1234/userLinks/5678
Pattern : ^accounts/[^/]+/userLinks/[^/]+$
Type : string
Required : Yes
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/analytics.manage.users
▼ ▲ analyticsadmin.accounts.userLinks.list
Flat Path : v1alpha/accounts/{accountsId}/userLinks
Parameters :
pageToken
Type : string
Description : A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.
Location : query
pageSize
Format : int32
Type : integer
Location : query
Description : The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.
parent
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
Description : Required. Example format: accounts/1234
Location : path
Parameter Order : parent
Description : Lists all user links on an account or property.
Path : v1alpha/{+parent}/userLinks
Scopes :
HTTP Method : GET
▼ ▲ analyticsadmin.accounts.userLinks.batchDelete
Parameter Order : parent
Description : Deletes information about multiple users' links to an account or property.
Flat Path : v1alpha/accounts/{accountsId}/userLinks:batchDelete
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Path : v1alpha/{+parent}/userLinks:batchDelete
HTTP Method : POST
Parameters :
parent
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
Description : 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
Location : path
▼ ▲ analyticsadmin.accounts.userLinks.batchUpdate
HTTP Method : POST
Parameters :
parent
Location : path
Required : Yes
Description : 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
Pattern : ^accounts/[^/]+$
Type : string
Description : Updates information about multiple users' links to an account or property.
Flat Path : v1alpha/accounts/{accountsId}/userLinks:batchUpdate
Path : v1alpha/{+parent}/userLinks:batchUpdate
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Parameter Order : parent
▼ ▲ analyticsadmin.accounts.userLinks.create
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/analytics.manage.users
Description : 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.
Parameters :
parent
Description : Required. Example format: accounts/1234
Location : path
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
notifyNewUser
Description : Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
Type : boolean
Location : query
Flat Path : v1alpha/accounts/{accountsId}/userLinks
Path : v1alpha/{+parent}/userLinks
▼ ▲ analyticsadmin.accounts.userLinks.get
HTTP Method : GET
Parameter Order : name
Path : v1alpha/{+name}
Scopes :
Description : Gets information about a user's link to an account or property.
Parameters :
name
Type : string
Description : Required. Example format: accounts/1234/userLinks/5678
Location : path
Required : Yes
Pattern : ^accounts/[^/]+/userLinks/[^/]+$
Flat Path : v1alpha/accounts/{accountsId}/userLinks/{userLinksId}
▼ ▲ analyticsadmin.accounts.userLinks.batchCreate
Parameters :
parent
Required : Yes
Type : string
Pattern : ^accounts/[^/]+$
Description : 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
Location : path
Description : 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.
Flat Path : v1alpha/accounts/{accountsId}/userLinks:batchCreate
Parameter Order : parent
Path : v1alpha/{+parent}/userLinks:batchCreate
Scopes : https://www.googleapis.com/auth/analytics.manage.users
HTTP Method : POST
▼ ▲ analyticsadmin.accounts.userLinks.patch
Description : Updates a user link on an account or property.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/analytics.manage.users
HTTP Method : PATCH
Parameters :
name
Pattern : ^accounts/[^/]+/userLinks/[^/]+$
Required : Yes
Location : path
Type : string
Description : Output only. Example format: properties/1234/userLinks/5678
Parameter Order : name
Flat Path : v1alpha/accounts/{accountsId}/userLinks/{userLinksId}
▼ ▲ analyticsadmin.accounts.userLinks.batchGet
Scopes :
Flat Path : v1alpha/accounts/{accountsId}/userLinks:batchGet
Parameter Order : parent
Path : v1alpha/{+parent}/userLinks:batchGet
HTTP Method : GET
Parameters :
names
Type : string
Location : query
Description : Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}
Repeated : Yes
parent
Description : 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
Type : string
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Description : Gets information about multiple users' links to an account or property.
▼ ▲ analyticsadmin.accounts.userLinks.audit
Scopes :
Flat Path : v1alpha/accounts/{accountsId}/userLinks:audit
Parameters :
parent
Required : Yes
Location : path
Type : string
Description : Required. Example format: accounts/1234
Pattern : ^accounts/[^/]+$
Parameter Order : parent
HTTP Method : POST
Path : v1alpha/{+parent}/userLinks:audit
Description : 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.