Reports: get
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
輪詢要求狀態的意見調查。
立即試用。
回應會指出報表狀態:
- 如果報表已可供下載,回應中會包含
isReportReady: true
。此回應也會包含報表檔案數量等資訊。
- 如果報表仍在處理中,回應會包含
isReportReady: false
。
- 如果 DoubleClick Search 無法完成報表,回應會包含錯誤代碼 410 Gone 以及本文記錄的其中一個原因:
回應代碼。
要求
HTTP 要求
GET https://www.googleapis.com/doubleclicksearch/v2/reports/reportId
參數
參數名稱 |
值 |
說明 |
路徑參數 |
reportId |
string |
受輪詢的報表要求的 ID。
|
授權
此要求需要具有下列範圍的授權:
範圍 |
https://www.googleapis.com/auth/doubleclicksearch |
詳情請參閱「驗證與授權」網頁。
要求主體
請勿使用這個方法提供請求主體。
回應
如果成功,這個方法會在回應主體中傳回報表資源。
試試看!
使用下方的 APIs Explorer,針對即時資料呼叫這個方法,看看會有什麼結果。
您也可以改用
獨立式
Explorer。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-08-20 (世界標準時間)。
[null,null,["上次更新時間:2024-08-20 (世界標準時間)。"],[[["\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)."]]