Reports: get
Stay organized with collections
Save and categorize content based on your preferences.
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.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Alternatively, try the
standalone
Explorer.
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."],[[["\u003cp\u003ePolls for the status of a report request to determine if it's ready for download, still processing, or if an error occurred.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an \u003ccode\u003eisReportReady\u003c/code\u003e flag indicating the report status and, if ready, provides details like the number of report files.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to the specified endpoint, including the report ID as a path parameter, to retrieve the report status.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclicksearch\u003c/code\u003e scope for access.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns a Reports resource containing information about the requested report.\u003c/p\u003e\n"]]],["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"],null,["# Reports: get\n\n| **Note:** Requires [authorization](#auth).\n\nPolls for the status of a report request.\n[Try it now](#try-it).\n\nThe response indicates the status of the report:\n\n- If the report is ready for download, the response contains `isReportReady: true`. The response also contains information such as the number of report files.\n- If the report is still being worked on, the response contains `isReportReady: false`.\n- 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](/search-ads/v2/response-codes).\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/doubleclicksearch/v2/reports/reportId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|----------------------------------------|\n| **Path parameters** |||\n| `reportId` | `string` | ID of the report request being polled. |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/doubleclicksearch` |\n\nFor more information, see the [authentication and authorization](/search-ads/v2/authorizing) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [Reports resource](/search-ads/v2/reference/reports#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response.\nAlternatively, try the\n[standalone\nExplorer](https://developers.google.com/apis-explorer/#p/doubleclicksearch/v2/doubleclicksearch.reports.get)."]]
