Get
|
|||||
|
|
Retrieves a report file by its report ID and file ID. This method supports media download
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 2 input parameters
Name | Format | Description |
---|---|---|
reportId Required |
INTEGER |
The ID of the report |
fileId Required |
INTEGER |
The ID of the report file |
= Parameter name
= Format
reportId INTEGER Required The ID of the report |
fileId INTEGER Required The ID of the report file |
Output
This building block provides 16 output parameters
Name | Format | Description |
---|---|---|
dateRange |
OBJECT |
Represents a date range |
dateRange.endDate |
DATE |
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
dateRange.kind |
STRING |
The kind of resource this is, in this case dfareporting#dateRange |
dateRange.relativeDateRange |
ENUMERATION |
The date range relative to the date of when the report is run |
dateRange.startDate |
DATE |
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
etag |
STRING |
The eTag of this response for caching purposes |
fileName |
STRING |
The filename of the file |
format |
ENUMERATION |
The output format of the report. Only available once the file is available |
id |
INTEGER |
The unique ID of this report file |
kind |
STRING |
The kind of resource this is, in this case dfareporting#file |
lastModifiedTime |
INTEGER |
The timestamp in milliseconds since epoch when this file was last modified |
reportId |
INTEGER |
The ID of the report this file was generated from |
status |
ENUMERATION |
The status of the report file |
urls |
OBJECT |
The URLs where the completed report file can be downloaded |
urls.apiUrl |
STRING |
The URL for downloading the report data through the API |
urls.browserUrl |
STRING |
The URL for downloading the report data through a browser |
= Parameter name
= Format
dateRange OBJECT Represents a date range |
dateRange.endDate DATE The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
dateRange.kind STRING The kind of resource this is, in this case dfareporting#dateRange |
dateRange.relativeDateRange ENUMERATION The date range relative to the date of when the report is run |
dateRange.startDate DATE The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd" |
etag STRING The eTag of this response for caching purposes |
fileName STRING The filename of the file |
format ENUMERATION The output format of the report. Only available once the file is available |
id INTEGER The unique ID of this report file |
kind STRING The kind of resource this is, in this case dfareporting#file |
lastModifiedTime INTEGER The timestamp in milliseconds since epoch when this file was last modified |
reportId INTEGER The ID of the report this file was generated from |
status ENUMERATION The status of the report file |
urls OBJECT The URLs where the completed report file can be downloaded |
urls.apiUrl STRING The URL for downloading the report data through the API |
urls.browserUrl STRING The URL for downloading the report data through a browser |