Method: accounts.reports.list

Lists the reports that reports.run can run. These reports include an ID, a description, and the list of columns that will be in the result.

HTTP request

GET https://cloudchannel.googleapis.com/v1alpha1/{parent=accounts/*}/reports

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}

Query parameters

Parameters
pageSize

integer

Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.

pageToken

string

Optional. A token that specifies a page of results beyond the first page. Obtained through ListReportsResponse.next_page_token of the previous CloudChannelReportsService.ListReports call.

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".

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for CloudChannelReportsService.ListReports.

JSON representation
{
  "reports": [
    {
      object (Report)
    }
  ],
  "nextPageToken": string
}
Fields
reports[]

object (Report)

The reports available to the partner.

nextPageToken

string

Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.reports.usage.readonly

For more information, see the Authentication Overview.