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 of OperationMetadata
.
To get the results of report generation, call CloudChannelReportsService.FetchReportResults
with the RunReportJobResponse.report_job
.
Deprecated: Please use Export Channel Services data to BigQuery instead.
HTTP request
POST https://cloudchannel.googleapis.com/v1/{name=accounts/*/reports/*}:run
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
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, |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"dateRange": {
object ( |
Fields | |
---|---|
date |
Optional. The range of usage or invoice dates to include in the result. |
filter |
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 >=) using For example: |
language |
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 of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/apps.reports.usage.readonly
For more information, see the Authentication Overview.