List
|
|||||
|
|
||||
Lists web properties 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 3 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to |
max-results |
INTEGER |
The maximum number of web properties 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 to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to |
|
max-results INTEGER The maximum number of web properties 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 32 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics web property |
items[].accountId |
STRING |
Account ID to which this web property belongs |
items[].childLink |
OBJECT |
Child link for this web property. Points to the list of views (profiles) for this web property |
items[].childLink.href |
STRING |
Link to the list of views (profiles) for this web property |
items[].childLink.type |
STRING |
Type of the parent link. Its value is "analytics#profiles" |
items[].created |
DATE_TIME |
Time this web property was created |
items[].dataRetentionResetOnNewActivity |
BOOLEAN |
Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert |
items[].dataRetentionTtl |
STRING |
The length of time for which user and event data is retained. This property cannot be set on insert |
items[].defaultProfileId |
INTEGER |
Default view (profile) ID |
items[].id |
STRING |
Web property ID of the form UA-XXXXX-YY |
items[].industryVertical |
STRING |
The industry vertical/category selected for this web property |
items[].internalWebPropertyId |
STRING |
Internal ID for this web property |
items[].kind |
STRING |
Resource type for Analytics WebProperty |
items[].level |
STRING |
Level for this web property. Possible values are STANDARD or PREMIUM |
items[].name |
STRING |
Name of this web property |
items[].parentLink |
OBJECT |
Parent link for this web property. Points to the account to which this web property belongs |
items[].parentLink.href |
STRING |
Link to the account for this web property |
items[].parentLink.type |
STRING |
Type of the parent link. Its value is "analytics#account" |
items[].permissions |
OBJECT |
Permissions the user has for this web property |
items[].permissions.effective[] |
STRING |
|
items[].profileCount |
INTEGER |
View (Profile) count for this web property |
items[].selfLink |
STRING |
Link for this web property |
items[].starred |
BOOLEAN |
Indicates whether this web property is starred or not |
items[].updated |
DATE_TIME |
Time this web property was last modified |
items[].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 web property collection |
previousLink |
STRING |
Link to previous page for this web property 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 web property |
|
items[].accountId STRING Account ID to which this web property belongs |
|
items[].childLink OBJECT Child link for this web property. Points to the list of views (profiles) for this web property |
|
items[].childLink.href STRING Link to the list of views (profiles) for this web property |
|
items[].childLink.type STRING Type of the parent link. Its value is "analytics#profiles" |
|
items[].created DATE_TIME Time this web property was created |
|
items[].dataRetentionResetOnNewActivity BOOLEAN Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert |
|
items[].dataRetentionTtl STRING The length of time for which user and event data is retained. This property cannot be set on insert |
|
items[].defaultProfileId INTEGER Default view (profile) ID |
|
items[].id STRING Web property ID of the form UA-XXXXX-YY |
|
items[].industryVertical STRING The industry vertical/category selected for this web property |
|
items[].internalWebPropertyId STRING Internal ID for this web property |
|
items[].kind STRING Resource type for Analytics WebProperty |
|
items[].level STRING Level for this web property. Possible values are STANDARD or PREMIUM |
|
items[].name STRING Name of this web property |
|
items[].parentLink OBJECT Parent link for this web property. Points to the account to which this web property belongs |
|
items[].parentLink.href STRING Link to the account for this web property |
|
items[].parentLink.type STRING Type of the parent link. Its value is "analytics#account" |
|
items[].permissions OBJECT Permissions the user has for this web property |
|
items[].permissions.effective[] STRING |
|
items[].profileCount INTEGER View (Profile) count for this web property |
|
items[].selfLink STRING Link for this web property |
|
items[].starred BOOLEAN Indicates whether this web property is starred or not |
|
items[].updated DATE_TIME Time this web property was last modified |
|
items[].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 web property collection |
|
previousLink STRING Link to previous page for this web property 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 |