List
|
|||||
|
|
||||
List custom data sources 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 custom data sources to retrieve |
webPropertyId Required |
STRING |
Web property Id for the custom data sources to retrieve |
max-results |
INTEGER |
The maximum number of custom data sources to include in this response |
start-index |
INTEGER |
A 1-based index of the first custom data source 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 data sources to retrieve |
|
webPropertyId STRING Required Web property Id for the custom data sources to retrieve |
|
max-results INTEGER The maximum number of custom data sources to include in this response |
|
start-index INTEGER A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 28 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template for an Analytics custom data source |
items[].accountId |
STRING |
Account ID to which this custom data source belongs |
items[].childLink |
OBJECT |
|
items[].childLink.href |
STRING |
Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source |
items[].childLink.type |
STRING |
Value is "analytics#dailyUploads". Value is "analytics#uploads" |
items[].created |
DATE_TIME |
Time this custom data source was created |
items[].description |
STRING |
Description of custom data source |
items[].id |
STRING |
Custom data source ID |
items[].importBehavior |
STRING |
|
items[].kind |
STRING |
Resource type for Analytics custom data source |
items[].name |
STRING |
Name of this custom data source |
items[].parentLink |
OBJECT |
Parent link for this custom data source. Points to the web property to which this custom data source belongs |
items[].parentLink.href |
STRING |
Link to the web property to which this custom data source belongs |
items[].parentLink.type |
STRING |
Value is "analytics#webproperty" |
items[].profilesLinked[] |
STRING |
|
items[].schema[] |
STRING |
|
items[].selfLink |
STRING |
Link for this Analytics custom data source |
items[].type |
STRING |
Type of the custom data source |
items[].updated |
DATE_TIME |
Time this custom data source was last modified |
items[].uploadType |
STRING |
Upload type of the custom data source |
items[].webPropertyId |
STRING |
Web property ID of the form UA-XXXXX-YY to which this custom data source belongs |
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 data source collection |
previousLink |
STRING |
Link to previous page for this custom data source 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 custom data source |
|
items[].accountId STRING Account ID to which this custom data source belongs |
|
items[].childLink OBJECT |
|
items[].childLink.href STRING Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source |
|
items[].childLink.type STRING Value is "analytics#dailyUploads". Value is "analytics#uploads" |
|
items[].created DATE_TIME Time this custom data source was created |
|
items[].description STRING Description of custom data source |
|
items[].id STRING Custom data source ID |
|
items[].importBehavior STRING |
|
items[].kind STRING Resource type for Analytics custom data source |
|
items[].name STRING Name of this custom data source |
|
items[].parentLink OBJECT Parent link for this custom data source. Points to the web property to which this custom data source belongs |
|
items[].parentLink.href STRING Link to the web property to which this custom data source belongs |
|
items[].parentLink.type STRING Value is "analytics#webproperty" |
|
items[].profilesLinked[] STRING |
|
items[].schema[] STRING |
|
items[].selfLink STRING Link for this Analytics custom data source |
|
items[].type STRING Type of the custom data source |
|
items[].updated DATE_TIME Time this custom data source was last modified |
|
items[].uploadType STRING Upload type of the custom data source |
|
items[].webPropertyId STRING Web property ID of the form UA-XXXXX-YY to which this custom data source belongs |
|
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 data source collection |
|
previousLink STRING Link to previous page for this custom data source 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 |