List
|
|||||
|
|
||||
Lists profile-user links for a given view (profile)
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage Google Analytics Account users by email address
- View Google Analytics user permissions
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID which the given view (profile) belongs to |
webPropertyId Required |
STRING |
Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to |
profileId Required |
STRING |
View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to |
max-results |
INTEGER |
The maximum number of profile-user links to include in this response |
start-index |
INTEGER |
An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
= Parameter name
= Format
|
accountId STRING Required Account ID which the given view (profile) belongs to |
|
webPropertyId STRING Required Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to |
|
profileId STRING Required View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to |
|
max-results INTEGER The maximum number of profile-user links to include in this response |
|
start-index INTEGER An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 38 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity |
items[].entity |
OBJECT |
Entity for this link. It can be an account, a web property, or a view (profile) |
items[].entity.accountRef |
OBJECT |
JSON template for a linked account |
items[].entity.accountRef.href |
STRING |
Link for this account |
items[].entity.accountRef.id |
STRING |
Account ID |
items[].entity.accountRef.kind |
STRING |
Analytics account reference |
items[].entity.accountRef.name |
STRING |
Account name |
items[].entity.profileRef |
OBJECT |
JSON template for a linked view (profile) |
items[].entity.profileRef.accountId |
STRING |
Account ID to which this view (profile) belongs |
items[].entity.profileRef.href |
STRING |
Link for this view (profile) |
items[].entity.profileRef.id |
STRING |
View (Profile) ID |
items[].entity.profileRef.internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
items[].entity.profileRef.kind |
STRING |
Analytics view (profile) reference |
items[].entity.profileRef.name |
STRING |
Name of this view (profile) |
items[].entity.profileRef.webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
items[].entity.webPropertyRef |
OBJECT |
JSON template for a web property reference |
items[].entity.webPropertyRef.accountId |
STRING |
Account ID to which this web property belongs |
items[].entity.webPropertyRef.href |
STRING |
Link for this web property |
items[].entity.webPropertyRef.id |
STRING |
Web property ID of the form UA-XXXXX-YY |
items[].entity.webPropertyRef.internalWebPropertyId |
STRING |
Internal ID for this web property |
items[].entity.webPropertyRef.kind |
STRING |
Analytics web property reference |
items[].entity.webPropertyRef.name |
STRING |
Name of this web property |
items[].id |
STRING |
Entity user link ID |
items[].kind |
STRING |
Resource type for entity user link |
items[].permissions |
OBJECT |
Permissions the user has for this entity |
items[].permissions.effective[] |
STRING |
|
items[].permissions.local[] |
STRING |
|
items[].selfLink |
STRING |
Self link for this resource |
items[].userRef |
OBJECT |
JSON template for a user reference |
items[].userRef.email |
STRING |
Email ID of this user |
items[].userRef.id |
STRING |
User ID |
items[].userRef.kind |
STRING |
|
itemsPerPage |
INTEGER |
The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter |
kind |
STRING |
Collection type |
nextLink |
STRING |
Next link for this account collection |
previousLink |
STRING |
Previous link for this account collection |
startIndex |
INTEGER |
The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter |
totalResults |
INTEGER |
The total number of results for the query, regardless of the number of results in the response |
= Parameter name
= Format
|
items[] OBJECT JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity |
|
items[].entity OBJECT Entity for this link. It can be an account, a web property, or a view (profile) |
|
items[].entity.accountRef OBJECT JSON template for a linked account |
|
items[].entity.accountRef.href STRING Link for this account |
|
items[].entity.accountRef.id STRING Account ID |
|
items[].entity.accountRef.kind STRING Analytics account reference |
|
items[].entity.accountRef.name STRING Account name |
|
items[].entity.profileRef OBJECT JSON template for a linked view (profile) |
|
items[].entity.profileRef.accountId STRING Account ID to which this view (profile) belongs |
|
items[].entity.profileRef.href STRING Link for this view (profile) |
|
items[].entity.profileRef.id STRING View (Profile) ID |
|
items[].entity.profileRef.internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
|
items[].entity.profileRef.kind STRING Analytics view (profile) reference |
|
items[].entity.profileRef.name STRING Name of this view (profile) |
|
items[].entity.profileRef.webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
|
items[].entity.webPropertyRef OBJECT JSON template for a web property reference |
|
items[].entity.webPropertyRef.accountId STRING Account ID to which this web property belongs |
|
items[].entity.webPropertyRef.href STRING Link for this web property |
|
items[].entity.webPropertyRef.id STRING Web property ID of the form UA-XXXXX-YY |
|
items[].entity.webPropertyRef.internalWebPropertyId STRING Internal ID for this web property |
|
items[].entity.webPropertyRef.kind STRING Analytics web property reference |
|
items[].entity.webPropertyRef.name STRING Name of this web property |
|
items[].id STRING Entity user link ID |
|
items[].kind STRING Resource type for entity user link |
|
items[].permissions OBJECT Permissions the user has for this entity |
|
items[].permissions.effective[] STRING |
|
items[].permissions.local[] STRING |
|
items[].selfLink STRING Self link for this resource |
|
items[].userRef OBJECT JSON template for a user reference |
|
items[].userRef.email STRING Email ID of this user |
|
items[].userRef.id STRING User ID |
|
items[].userRef.kind STRING |
|
itemsPerPage INTEGER The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter |
|
kind STRING Collection type |
|
nextLink STRING Next link for this account collection |
|
previousLink STRING Previous link for this account collection |
|
startIndex INTEGER The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter |
|
totalResults INTEGER The total number of results for the query, regardless of the number of results in the response |