List
|
|||||
|
|
||||
Lists views (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:
- View and manage your Google Analytics data
- Edit Google Analytics management entities
- View your Google Analytics data
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access |
webPropertyId Required |
STRING |
Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access |
max-results |
INTEGER |
The maximum number of views (profiles) 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 view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access |
|
webPropertyId STRING Required Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access |
|
max-results INTEGER The maximum number of views (profiles) 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 39 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics view (profile) |
items[].accountId |
STRING |
Account ID to which this view (profile) belongs |
items[].botFilteringEnabled |
BOOLEAN |
Indicates whether bot filtering is enabled for this view (profile) |
items[].childLink |
OBJECT |
Child link for this view (profile). Points to the list of goals for this view (profile) |
items[].childLink.href |
STRING |
Link to the list of goals for this view (profile) |
items[].childLink.type |
STRING |
Value is "analytics#goals" |
items[].created |
DATE_TIME |
Time this view (profile) was created |
items[].currency |
STRING |
The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
items[].defaultPage |
STRING |
Default page for this view (profile) |
items[].eCommerceTracking |
BOOLEAN |
Indicates whether ecommerce tracking is enabled for this view (profile) |
items[].enhancedECommerceTracking |
BOOLEAN |
Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled |
items[].excludeQueryParameters |
STRING |
The query parameters that are excluded from this view (profile) |
items[].id |
STRING |
View (Profile) ID |
items[].internalWebPropertyId |
STRING |
Internal ID for the web property to which this view (profile) belongs |
items[].kind |
STRING |
Resource type for Analytics view (profile) |
items[].name |
STRING |
Name of this view (profile) |
items[].parentLink |
OBJECT |
Parent link for this view (profile). Points to the web property to which this view (profile) belongs |
items[].parentLink.href |
STRING |
Link to the web property to which this view (profile) belongs |
items[].parentLink.type |
STRING |
Value is "analytics#webproperty" |
items[].permissions |
OBJECT |
Permissions the user has for this view (profile) |
items[].permissions.effective[] |
STRING |
|
items[].selfLink |
STRING |
Link for this view (profile) |
items[].siteSearchCategoryParameters |
STRING |
Site search category parameters for this view (profile) |
items[].siteSearchQueryParameters |
STRING |
The site search query parameters for this view (profile) |
items[].starred |
BOOLEAN |
Indicates whether this view (profile) is starred or not |
items[].stripSiteSearchCategoryParameters |
BOOLEAN |
Whether or not Analytics will strip search category parameters from the URLs in your reports |
items[].stripSiteSearchQueryParameters |
BOOLEAN |
Whether or not Analytics will strip search query parameters from the URLs in your reports |
items[].timezone |
STRING |
Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database |
items[].type |
STRING |
View (Profile) type. Supported types: WEB or APP |
items[].updated |
DATE_TIME |
Time this view (profile) was last modified |
items[].webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
items[].websiteUrl |
STRING |
Website URL for this view (profile) |
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 view (profile) collection |
previousLink |
STRING |
Link to previous page for this view (profile) 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 view (profile) |
|
items[].accountId STRING Account ID to which this view (profile) belongs |
|
items[].botFilteringEnabled BOOLEAN Indicates whether bot filtering is enabled for this view (profile) |
|
items[].childLink OBJECT Child link for this view (profile). Points to the list of goals for this view (profile) |
|
items[].childLink.href STRING Link to the list of goals for this view (profile) |
|
items[].childLink.type STRING Value is "analytics#goals" |
|
items[].created DATE_TIME Time this view (profile) was created |
|
items[].currency STRING The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
|
items[].defaultPage STRING Default page for this view (profile) |
|
items[].eCommerceTracking BOOLEAN Indicates whether ecommerce tracking is enabled for this view (profile) |
|
items[].enhancedECommerceTracking BOOLEAN Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled |
|
items[].excludeQueryParameters STRING The query parameters that are excluded from this view (profile) |
|
items[].id STRING View (Profile) ID |
|
items[].internalWebPropertyId STRING Internal ID for the web property to which this view (profile) belongs |
|
items[].kind STRING Resource type for Analytics view (profile) |
|
items[].name STRING Name of this view (profile) |
|
items[].parentLink OBJECT Parent link for this view (profile). Points to the web property to which this view (profile) belongs |
|
items[].parentLink.href STRING Link to the web property to which this view (profile) belongs |
|
items[].parentLink.type STRING Value is "analytics#webproperty" |
|
items[].permissions OBJECT Permissions the user has for this view (profile) |
|
items[].permissions.effective[] STRING |
|
items[].selfLink STRING Link for this view (profile) |
|
items[].siteSearchCategoryParameters STRING Site search category parameters for this view (profile) |
|
items[].siteSearchQueryParameters STRING The site search query parameters for this view (profile) |
|
items[].starred BOOLEAN Indicates whether this view (profile) is starred or not |
|
items[].stripSiteSearchCategoryParameters BOOLEAN Whether or not Analytics will strip search category parameters from the URLs in your reports |
|
items[].stripSiteSearchQueryParameters BOOLEAN Whether or not Analytics will strip search query parameters from the URLs in your reports |
|
items[].timezone STRING Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database |
|
items[].type STRING View (Profile) type. Supported types: WEB or APP |
|
items[].updated DATE_TIME Time this view (profile) was last modified |
|
items[].webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs |
|
items[].websiteUrl STRING Website URL for this view (profile) |
|
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 view (profile) collection |
|
previousLink STRING Link to previous page for this view (profile) 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 |