List
|
|||||
|
|
||||
Lists files for a report
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage DoubleClick for Advertisers reports
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
The DFA profile ID |
reportId Required |
INTEGER |
The ID of the parent report |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
The value of the nextToken from the previous result page |
sortField |
ENUMERATION |
The field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= Parameter name
= Format
|
profileId INTEGER Required The DFA profile ID |
|
reportId INTEGER Required The ID of the parent report |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING The value of the nextToken from the previous result page |
|
sortField ENUMERATION The field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 20 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
The eTag of this response for caching purposes |
items[] |
OBJECT |
Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE" |
items[].dateRange |
OBJECT |
Represents a date range |
items[].dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
items[].dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
items[].dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
items[].dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
items[].etag |
STRING |
The eTag of this response for caching purposes |
items[].fileName |
STRING |
The filename of the file |
items[].format |
ENUMERATION |
The output format of the report. Only available once the file is available |
items[].id |
INTEGER |
The unique ID of this report file |
items[].kind |
STRING |
The kind of resource this is, in this case dfareporting#file |
items[].lastModifiedTime |
INTEGER |
The timestamp in milliseconds since epoch when this file was last modified |
items[].reportId |
INTEGER |
The ID of the report this file was generated from |
items[].status |
ENUMERATION |
The status of the report file |
items[].urls |
OBJECT |
The URLs where the completed report file can be downloaded |
items[].urls.apiUrl |
STRING |
The URL for downloading the report data through the API |
items[].urls.browserUrl |
STRING |
The URL for downloading the report data through a browser |
kind |
STRING |
The kind of list this is, in this case dfareporting#fileList |
nextPageToken |
STRING |
Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted |
= Parameter name
= Format
|
etag STRING The eTag of this response for caching purposes |
|
items[] OBJECT Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE" |
|
items[].dateRange OBJECT Represents a date range |
|
items[].dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
items[].dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
|
items[].dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
|
items[].dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
|
items[].etag STRING The eTag of this response for caching purposes |
|
items[].fileName STRING The filename of the file |
|
items[].format ENUMERATION The output format of the report. Only available once the file is available |
|
items[].id INTEGER The unique ID of this report file |
|
items[].kind STRING The kind of resource this is, in this case dfareporting#file |
|
items[].lastModifiedTime INTEGER The timestamp in milliseconds since epoch when this file was last modified |
|
items[].reportId INTEGER The ID of the report this file was generated from |
|
items[].status ENUMERATION The status of the report file |
|
items[].urls OBJECT The URLs where the completed report file can be downloaded |
|
items[].urls.apiUrl STRING The URL for downloading the report data through the API |
|
items[].urls.browserUrl STRING The URL for downloading the report data through a browser |
|
kind STRING The kind of list this is, in this case dfareporting#fileList |
|
nextPageToken STRING Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted |