List
|
|||||
|
|
||||
List uploads 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 5 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account Id for the uploads to retrieve |
webPropertyId Required |
STRING |
Web property Id for the uploads to retrieve |
customDataSourceId Required |
STRING |
Custom data source Id for uploads to retrieve |
max-results |
INTEGER |
The maximum number of uploads to include in this response |
start-index |
INTEGER |
A 1-based index of the first upload 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 uploads to retrieve |
|
webPropertyId STRING Required Web property Id for the uploads to retrieve |
|
customDataSourceId STRING Required Custom data source Id for uploads to retrieve |
|
max-results INTEGER The maximum number of uploads to include in this response |
|
start-index INTEGER A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
Metadata returned for an upload operation |
items[].accountId |
INTEGER |
Account Id to which this upload belongs |
items[].customDataSourceId |
STRING |
Custom data source Id to which this data import belongs |
items[].errors[] |
STRING |
|
items[].id |
STRING |
A unique ID for this upload |
items[].kind |
STRING |
Resource type for Analytics upload |
items[].status |
STRING |
Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED |
items[].uploadTime |
DATE_TIME |
Time this file is uploaded |
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 upload collection |
previousLink |
STRING |
Link to previous page for this upload 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 resources in the result |
= Parameter name
= Format
|
items[] OBJECT Metadata returned for an upload operation |
|
items[].accountId INTEGER Account Id to which this upload belongs |
|
items[].customDataSourceId STRING Custom data source Id to which this data import belongs |
|
items[].errors[] STRING |
|
items[].id STRING A unique ID for this upload |
|
items[].kind STRING Resource type for Analytics upload |
|
items[].status STRING Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED |
|
items[].uploadTime DATE_TIME Time this file is uploaded |
|
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 upload collection |
|
previousLink STRING Link to previous page for this upload 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 resources in the result |