List
|
|||||
|
|
||||
Lists custom dimensions 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:
- View and manage your Google Analytics data
- View your Google Analytics data
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID for the custom dimensions to retrieve |
webPropertyId Required |
STRING |
Web property ID for the custom dimensions to retrieve |
max-results |
INTEGER |
The maximum number of custom dimensions to include in this response |
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
|
accountId STRING Required Account ID for the custom dimensions to retrieve |
|
webPropertyId STRING Required Web property ID for the custom dimensions to retrieve |
|
max-results INTEGER The maximum number of custom dimensions to include in this response |
|
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 22 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for Analytics Custom Dimension |
items[].accountId |
STRING |
Account ID |
items[].active |
BOOLEAN |
Boolean indicating whether the custom dimension is active |
items[].created |
DATE_TIME |
Time the custom dimension was created |
items[].id |
STRING |
Custom dimension ID |
items[].index |
INTEGER |
Index of the custom dimension |
items[].kind |
STRING |
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field |
items[].name |
STRING |
Name of the custom dimension |
items[].parentLink |
OBJECT |
Parent link for the custom dimension. Points to the property to which the custom dimension belongs |
items[].parentLink.href |
STRING |
Link to the property to which the custom dimension belongs |
items[].parentLink.type |
STRING |
Type of the parent link. Set to "analytics#webproperty" |
items[].scope |
STRING |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT |
items[].selfLink |
STRING |
Link for the custom dimension |
items[].updated |
DATE_TIME |
Time the custom dimension was last modified |
items[].webPropertyId |
STRING |
Property ID |
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 custom dimension collection |
previousLink |
STRING |
Link to previous page for this custom dimension 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 Analytics Custom Dimension |
|
items[].accountId STRING Account ID |
|
items[].active BOOLEAN Boolean indicating whether the custom dimension is active |
|
items[].created DATE_TIME Time the custom dimension was created |
|
items[].id STRING Custom dimension ID |
|
items[].index INTEGER Index of the custom dimension |
|
items[].kind STRING Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field |
|
items[].name STRING Name of the custom dimension |
|
items[].parentLink OBJECT Parent link for the custom dimension. Points to the property to which the custom dimension belongs |
|
items[].parentLink.href STRING Link to the property to which the custom dimension belongs |
|
items[].parentLink.type STRING Type of the parent link. Set to "analytics#webproperty" |
|
items[].scope STRING Scope of the custom dimension: HIT, SESSION, USER or PRODUCT |
|
items[].selfLink STRING Link for the custom dimension |
|
items[].updated DATE_TIME Time the custom dimension was last modified |
|
items[].webPropertyId STRING Property ID |
|
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 custom dimension collection |
|
previousLink STRING Link to previous page for this custom dimension 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 |