File
Stay organized with collections
Save and categorize content based on your preferences.
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"
.
| JSON representation |
{
"id": string,
"reportId": string,
"etag": string,
"status": enum (Status),
"fileName": string,
"kind": string,
"dateRange": {
object (DateRange)
},
"format": enum (Format),
"lastModifiedTime": string,
"urls": {
"browserUrl": string,
"apiUrl": string
}
} |
| Fields |
id |
string (int64 format)
The unique ID of this report file.
|
reportId |
string (int64 format)
The ID of the report this file was generated from.
|
etag |
string
Etag of this resource.
|
status |
enum (Status)
The status of the report file.
|
fileName |
string
The filename of the file.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#file"
.
|
dateRange |
object (DateRange)
The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
|
format |
enum (Format)
The output format of the report. Only available once the file is available.
|
lastModifiedTime |
string (int64 format)
The timestamp in milliseconds since epoch when this file was last modified.
|
urls |
object
The URLs where the completed report file can be downloaded.
|
urls.browserUrl |
string
The URL for downloading the report data through a browser.
|
urls.apiUrl |
string
The URL for downloading the report data through the API.
|
Status
| Enums |
PROCESSING |
|
REPORT_AVAILABLE |
|
FAILED |
|
CANCELLED |
|
QUEUED |
|
DateRange
| JSON representation |
{
"startDate": string,
"endDate": string,
"relativeDateRange": enum (RelativeDateRange),
"kind": string
} |
| Fields |
startDate |
string
The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
endDate |
string
The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
|
relativeDateRange |
enum (RelativeDateRange)
The date range relative to the date of when the report is run.
|
kind |
string
The kind of resource this is, in this case
dfareporting#dateRange
.
|
RelativeDateRange
| Enums |
TODAY |
|
YESTERDAY |
|
WEEK_TO_DATE |
|
MONTH_TO_DATE |
|
QUARTER_TO_DATE |
|
YEAR_TO_DATE |
|
PREVIOUS_WEEK |
|
PREVIOUS_MONTH |
|
PREVIOUS_QUARTER |
|
PREVIOUS_YEAR |
|
LAST_7_DAYS |
|
LAST_30_DAYS |
|
LAST_90_DAYS |
|
LAST_365_DAYS |
|
LAST_24_MONTHS |
|
LAST_14_DAYS |
|
LAST_60_DAYS |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eA File resource represents metadata for a report run, including its status and URLs to the generated data if available.\u003c/p\u003e\n"],["\u003cp\u003eThe file includes details like ID, report ID, status, filename, date range, format, and last modified time.\u003c/p\u003e\n"],["\u003cp\u003eThe status of a report file can be PROCESSING, REPORT_AVAILABLE, FAILED, CANCELLED or QUEUED.\u003c/p\u003e\n"],["\u003cp\u003eA DateRange within the file specifies the report's absolute start and end dates, or a relative date range.\u003c/p\u003e\n"],["\u003cp\u003eReport data can be outputted in CSV or EXCEL format, accessible through provided URLs upon completion.\u003c/p\u003e\n"]]],[],null,["# File\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Status](#Status)\n- [DateRange](#DateRange)\n - [JSON representation](#DateRange.SCHEMA_REPRESENTATION)\n- [RelativeDateRange](#RelativeDateRange)\n- [Format](#Format)\n\nRepresents 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\n\n`\"REPORT_AVAILABLE\"`\n\n.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"reportId\": string, \"etag\": string, \"status\": enum (/doubleclick-advertisers/rest/v4/File#Status), \"fileName\": string, \"kind\": string, \"dateRange\": { object (/doubleclick-advertisers/rest/v4/File#DateRange) }, \"format\": enum (/doubleclick-advertisers/rest/v4/File#Format), \"lastModifiedTime\": string, \"urls\": { \"browserUrl\": string, \"apiUrl\": string } } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The unique ID of this report file. |\n| `report``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the report this file was generated from. |\n| `etag` | `string` Etag of this resource. |\n| `status` | `enum (`[Status](/doubleclick-advertisers/rest/v4/File#Status)`)` The status of the report file. |\n| `file``Name` | `string` The filename of the file. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#file\"` . |\n| `date``Range` | `object (`[DateRange](/doubleclick-advertisers/rest/v4/File#DateRange)`)` The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. |\n| `format` | `enum (`[Format](/doubleclick-advertisers/rest/v4/File#Format)`)` The output format of the report. Only available once the file is available. |\n| `last``Modified``Time` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The timestamp in milliseconds since epoch when this file was last modified. |\n| `urls` | `object` The URLs where the completed report file can be downloaded. |\n| `urls.``browser``Url` | `string` The URL for downloading the report data through a browser. |\n| `urls.``api``Url` | `string` The URL for downloading the report data through the API. |\n\nStatus\n------\n\n| Enums ||\n|--------------------|---|\n| `PROCESSING` | |\n| `REPORT_AVAILABLE` | |\n| `FAILED` | |\n| `CANCELLED` | |\n| `QUEUED` | |\n\nDateRange\n---------\n\nRepresents a date range.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"startDate\": string, \"endDate\": string, \"relativeDateRange\": enum (/doubleclick-advertisers/rest/v4/File#RelativeDateRange), \"kind\": string } ``` |\n\n| Fields ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `start``Date` | `string` The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\". |\n| `end``Date` | `string` The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\". |\n| `relative``Date``Range` | `enum (`[RelativeDateRange](/doubleclick-advertisers/rest/v4/File#RelativeDateRange)`)` The date range relative to the date of when the report is run. |\n| `kind` | `string` The kind of resource this is, in this case `dfareporting#dateRange` . |\n\nRelativeDateRange\n-----------------\n\n| Enums ||\n|--------------------|---|\n| `TODAY` | |\n| `YESTERDAY` | |\n| `WEEK_TO_DATE` | |\n| `MONTH_TO_DATE` | |\n| `QUARTER_TO_DATE` | |\n| `YEAR_TO_DATE` | |\n| `PREVIOUS_WEEK` | |\n| `PREVIOUS_MONTH` | |\n| `PREVIOUS_QUARTER` | |\n| `PREVIOUS_YEAR` | |\n| `LAST_7_DAYS` | |\n| `LAST_30_DAYS` | |\n| `LAST_90_DAYS` | |\n| `LAST_365_DAYS` | |\n| `LAST_24_MONTHS` | |\n| `LAST_14_DAYS` | |\n| `LAST_60_DAYS` | |\n\nFormat\n------\n\n| Enums ||\n|---------|---|\n| `CSV` | |\n| `EXCEL` | |"]]
