Method: networks.reports.run
Stay organized with collections
Save and categorize content based on your preferences.
Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation
. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse
in its response field containing a reportResult that can be passed to the FetchReportResultRows
method to retrieve the report data.
HTTP request
POST https://admanager.googleapis.com/v1/{name}:run
Path parameters
Parameters |
name |
string
Required. The report to run. Format: networks/{networkCode}/reports/{reportId}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admanager
For more information, see the OAuth 2.0 Overview.
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 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eStarts the execution of a saved report and allows retrieval of the results asynchronously through polling.\u003c/p\u003e\n"],["\u003cp\u003eReport data can be accessed using \u003ccode\u003eOperationsService.GetOperation\u003c/code\u003e and \u003ccode\u003eFetchReportResultRows\u003c/code\u003e once the report generation is finished.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/admanager\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe report to run is specified via the \u003ccode\u003ename\u003c/code\u003e path parameter with the format \u003ccode\u003enetworks/{networkCode}/reports/{reportId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is required for initiating the report execution.\u003c/p\u003e\n"]]],["This content outlines the process of asynchronously running a report via a POST request to `https://admanager.googleapis.com/v1/{name}:run`. The request requires a path parameter, `name`, specifying the report. The request body must be empty. Upon success, an `Operation` instance is returned, which can be polled via `OperationsService.GetOperation` every 5 seconds to monitor the report's completion. A completed report will have a `RunReportResponse`, which is used to retrieve data with `FetchReportResultRows`. Authorization requires the `https://www.googleapis.com/auth/admanager` OAuth scope.\n"],null,["# Method: networks.reports.run\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nInitiates the execution of an existing report asynchronously. Users can get the report by polling this operation via `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a reportResult that can be passed to the `FetchReportResultRows` method to retrieve the report data.\n\n### HTTP request\n\n`POST https://admanager.googleapis.com/v1/{name}:run`\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The report to run. Format: `networks/{networkCode}/reports/{reportId}` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/ad-manager/api/beta/reference/rest/v1/networks.operations.reports.runs#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]