List
|
|||||
|
|
||||
Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Edit Google Analytics management entities
- View your Google Analytics data
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
max-results |
INTEGER |
The maximum number of account summaries to include in this response, where the largest acceptable value is 1000 |
start-index |
INTEGER |
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
= Parameter name
= Format
|
max-results INTEGER The maximum number of account summaries to include in this response, where the largest acceptable value is 1000 |
|
start-index INTEGER An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 20 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles |
items[].id |
STRING |
Account ID |
items[].kind |
STRING |
Resource type for Analytics AccountSummary |
items[].name |
STRING |
Account name |
items[].starred |
BOOLEAN |
Indicates whether this account is starred or not |
items[].webProperties[] |
OBJECT |
JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property |
items[].webProperties[].id |
STRING |
Web property ID of the form UA-XXXXX-YY |
items[].webProperties[].internalWebPropertyId |
STRING |
Internal ID for this web property |
items[].webProperties[].kind |
STRING |
Resource type for Analytics WebPropertySummary |
items[].webProperties[].level |
STRING |
Level for this web property. Possible values are STANDARD or PREMIUM |
items[].webProperties[].name |
STRING |
Web property name |
items[].webProperties[].starred |
BOOLEAN |
Indicates whether this web property is starred or not |
items[].webProperties[].websiteUrl |
STRING |
Website url for this web property |
itemsPerPage |
INTEGER |
The maximum number of resources the response can contain, regardless of the actual number of resources 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 |
Link to next page for this AccountSummary collection |
previousLink |
STRING |
Link to previous page for this AccountSummary collection |
startIndex |
INTEGER |
The starting index of the resources, 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 |
username |
STRING |
Email ID of the authenticated user |
= Parameter name
= Format
|
items[] OBJECT JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles |
|
items[].id STRING Account ID |
|
items[].kind STRING Resource type for Analytics AccountSummary |
|
items[].name STRING Account name |
|
items[].starred BOOLEAN Indicates whether this account is starred or not |
|
items[].webProperties[] OBJECT JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property |
|
items[].webProperties[].id STRING Web property ID of the form UA-XXXXX-YY |
|
items[].webProperties[].internalWebPropertyId STRING Internal ID for this web property |
|
items[].webProperties[].kind STRING Resource type for Analytics WebPropertySummary |
|
items[].webProperties[].level STRING Level for this web property. Possible values are STANDARD or PREMIUM |
|
items[].webProperties[].name STRING Web property name |
|
items[].webProperties[].starred BOOLEAN Indicates whether this web property is starred or not |
|
items[].webProperties[].websiteUrl STRING Website url for this web property |
|
itemsPerPage INTEGER The maximum number of resources the response can contain, regardless of the actual number of resources 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 Link to next page for this AccountSummary collection |
|
previousLink STRING Link to previous page for this AccountSummary collection |
|
startIndex INTEGER The starting index of the resources, 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 |
|
username STRING Email ID of the authenticated user |