Reports: get
Polls for the status of a report request.
Try it now.
The response indicates the status of the report:
- If the report is ready for download, the response contains
isReportReady: true. The response also contains information such as the number of report files.
- If the report is still being worked on, the response contains
isReportReady: false.
- If DoubleClick Search is unable to complete the report, the response contains the error code 410 Gone and one of the reasons documented in
Response Codes.
Request
HTTP request
GET https://www.googleapis.com/doubleclicksearch/v2/reports/reportId
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
reportId |
string |
ID of the report request being polled.
|
Authorization
This request requires authorization with the following scope:
| Scope |
|---|
https://www.googleapis.com/auth/doubleclicksearch |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Reports resource in the response body.
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-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["Polls for the status of a report request to determine if it's ready for download, still processing, or if an error occurred."],["The response includes an `isReportReady` flag indicating the report status and, if ready, provides details like the number of report files."],["Uses a GET request to the specified endpoint, including the report ID as a path parameter, to retrieve the report status."],["Requires authorization with the `https://www.googleapis.com/auth/doubleclicksearch` scope for access."],["A successful response returns a Reports resource containing information about the requested report."]]],["This outlines polling a report request's status via a GET request to `https://www.googleapis.com/doubleclicksearch/v2/reports/reportId`, requiring authorization. The `reportId` path parameter identifies the report. A successful response indicates `isReportReady: true` if ready, including file information, or `isReportReady: false` if in progress. A 410 Gone error code signifies report failure. The method returns a Reports resource and doesn't use a request body.\n"]]
