Method: accounts.reports.run

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
Try it!

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/v1alpha1/{name=accounts/*/reports/*}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` 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}

name

string

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:

JSON representation
{ "dateRange" : { object ( `DateRange` ) } , "filter" : string , "languageCode" : string }

Fields

Fields
`dateRange`	`object ( DateRange )` 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 >=) using `columnId` as 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".

dateRange

object ( DateRange )

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 >=) using columnId as 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 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 .