Begins generation of data for a given report. The report identifier is a UID (for example,613bf59q).
Possible error codes:
PERMISSION_DENIED: The user doesn't have access to this report.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The report identifier was not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the operations.get method of CloudChannelOperationsService. The Operation metadata contains an instance ofOperationMetadata.
Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example,613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}
Request body
The request body contains data with the following structure:
Optional. The range of usage or invoice dates to include in the result.
filter
string
Optional. A structured string that defines conditions on dimension columns to restrict the report output.
Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) usingcolumnIdas keys.
For example:(customer:"accounts/C123abc/customers/S456def" OR
customer:"accounts/C123abc/customers/S789ghi") AND
invoiceStartDate.year >= 2022
languageCode
string
Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".
Response body
If successful, the response body contains an instance ofOperation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["\u003cp\u003eThis document outlines how to initiate the generation of a report using a specified report identifier (UID), and the method is now deprecated in favor of exporting Channel Services data to BigQuery.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to run a report is a \u003ccode\u003ePOST\u003c/code\u003e request to a URL that includes the account and report identifiers, following a specific \u003ccode\u003egRPC Transcoding\u003c/code\u003e syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request body accepts parameters such as \u003ccode\u003edateRange\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003elanguageCode\u003c/code\u003e, which are used to specify the time period, filter criteria, and localization for the report data respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe call's response includes a long-running \u003ccode\u003eOperation\u003c/code\u003e ID, for which the results are retrieved through the \u003ccode\u003eoperations.get\u003c/code\u003e method, or alternatively by using \u003ccode\u003eCloudChannelReportsService.FetchReportResults\u003c/code\u003e, and it requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/apps.reports.usage.readonly\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors, such as \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e, \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e, \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eINTERNAL\u003c/code\u003e, and \u003ccode\u003eUNKNOWN\u003c/code\u003e, may occur during report generation, and troubleshooting information is provided for error resolution.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.reports.run\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\n| This item is deprecated!\nBegins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`).\n\nPossible error codes:\n\n- PERMISSION_DENIED: The user doesn't have access to this report.\n- INVALID_ARGUMENT: Required request parameters are missing or invalid.\n- NOT_FOUND: The report identifier was not found.\n- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.\n- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.\n\nReturn value: The ID of a long-running operation.\n\nTo get the results of the operation, call the operations.get method of CloudChannelOperationsService. The Operation metadata contains an instance of `OperationMetadata`.\n\nTo get the results of report generation, call [CloudChannelReportsService.FetchReportResults](/channel/docs/reference/rest/v1/accounts.reportJobs/fetchReportResults#google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults) with the `RunReportJobResponse.report_job`.\n\nDeprecated: Please use [Export Channel Services data to BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.\n\n### HTTP request\n\n`POST https://cloudchannel.googleapis.com/v1/{name=accounts/*/reports/*}:run`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/channel/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.reports.usage.readonly`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
