# REST Resource: queries.reports

- [Resource: Report](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#Report)
  - [JSON representation](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#Report.SCHEMA_REPRESENTATION)
- [ReportKey](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportKey)
  - [JSON representation](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportKey.SCHEMA_REPRESENTATION)
- [ReportMetadata](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportMetadata)
  - [JSON representation](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportMetadata.SCHEMA_REPRESENTATION)
- [ReportStatus](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus)
  - [JSON representation](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus.SCHEMA_REPRESENTATION)
- [State](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#State)
- [Methods](https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#METHODS_SUMMARY)

## Resource: Report

A single report generated by its parent report.

| JSON representation |
|---|
| ``` { "key": { object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportKey`) }, "metadata": { object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportMetadata`) }, "params": { object (`https://developers.google.com/bid-manager/reference/rest/v2/Parameters`) } } ``` |

| Fields ||
|---|---|
| `key` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportKey`)`` The key information identifying the report. |
| `metadata` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportMetadata`)`` The metadata of the report. |
| `params` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/Parameters`)`` The parameters of the report. |

## ReportKey

Identifying information of a report.

| JSON representation |
|---|
| ``` { "queryId": string, "reportId": string } ``` |

| Fields ||
|---|---|
| `queryId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique ID of the query that generated the report. |
| `reportId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique ID of the report. |

## ReportMetadata

The metadata of a report.

| JSON representation |
|---|
| ``` { "status": { object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus`) }, "reportDataStartDate": { object (`https://developers.google.com/bid-manager/reference/rest/v2/Date`) }, "reportDataEndDate": { object (`https://developers.google.com/bid-manager/reference/rest/v2/Date`) }, "googleCloudStoragePath": string } ``` |

| Fields ||
|---|---|
| `status` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus`)`` The status of the report. |
| `reportDataStartDate` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/Date`)`` The start date of the report data date range. |
| `reportDataEndDate` | ``object (`https://developers.google.com/bid-manager/reference/rest/v2/Date`)`` The end date of the report data date range. |
| `googleCloudStoragePath` | `string` Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if `https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus.FIELDS.state` is not `DONE`. |

## ReportStatus

The status of a report.

| JSON representation |
|---|
| ``` { "state": enum (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#State`), "finishTime": string, "format": enum (`https://developers.google.com/bid-manager/reference/rest/v2/Format`) } ``` |

| Fields ||
|---|---|
| `state` | ``enum (`https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#State`)`` Output only. The state of the report generation. |
| `finishTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless `https://developers.google.com/bid-manager/reference/rest/v2/queries.reports#ReportStatus.FIELDS.state` is `DONE` or `FAILED`. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `format` | ``enum (`https://developers.google.com/bid-manager/reference/rest/v2/Format`)`` The format of the generated report file. |

## State

Possible states of report generation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value when state is not specified or is unknown in this version. |
| `QUEUED` | The report is queued to run. |
| `RUNNING` | The report is currently running. |
| `DONE` | The report has finished running successfully. |
| `FAILED` | The report has finished running in failure. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/bid-manager/reference/rest/v2/queries.reports/get` | Retrieves a report. |
| ### `https://developers.google.com/bid-manager/reference/rest/v2/queries.reports/list` | Lists reports generated by the provided query. |