Get
|
|||||
|
|
||||
Get a custom dimension 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 3 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID for the custom dimension to retrieve |
webPropertyId Required |
STRING |
Web property ID for the custom dimension to retrieve |
customDimensionId Required |
STRING |
The ID of the custom dimension to retrieve |
= Parameter name
= Format
|
accountId STRING Required Account ID for the custom dimension to retrieve |
|
webPropertyId STRING Required Web property ID for the custom dimension to retrieve |
|
customDimensionId STRING Required The ID of the custom dimension to retrieve |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
STRING |
Account ID |
active |
BOOLEAN |
Boolean indicating whether the custom dimension is active |
created |
DATE_TIME |
Time the custom dimension was created |
id |
STRING |
Custom dimension ID |
index |
INTEGER |
Index of the custom dimension |
kind |
STRING |
Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field |
name |
STRING |
Name of the custom dimension |
parentLink |
OBJECT |
Parent link for the custom dimension. Points to the property to which the custom dimension belongs |
parentLink.href |
STRING |
Link to the property to which the custom dimension belongs |
parentLink.type |
STRING |
Type of the parent link. Set to "analytics#webproperty" |
scope |
STRING |
Scope of the custom dimension: HIT, SESSION, USER or PRODUCT |
selfLink |
STRING |
Link for the custom dimension |
updated |
DATE_TIME |
Time the custom dimension was last modified |
webPropertyId |
STRING |
Property ID |
= Parameter name
= Format
|
accountId STRING Account ID |
|
active BOOLEAN Boolean indicating whether the custom dimension is active |
|
created DATE_TIME Time the custom dimension was created |
|
id STRING Custom dimension ID |
|
index INTEGER Index of the custom dimension |
|
kind STRING Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field |
|
name STRING Name of the custom dimension |
|
parentLink OBJECT Parent link for the custom dimension. Points to the property to which the custom dimension belongs |
|
parentLink.href STRING Link to the property to which the custom dimension belongs |
|
parentLink.type STRING Type of the parent link. Set to "analytics#webproperty" |
|
scope STRING Scope of the custom dimension: HIT, SESSION, USER or PRODUCT |
|
selfLink STRING Link for the custom dimension |
|
updated DATE_TIME Time the custom dimension was last modified |
|
webPropertyId STRING Property ID |