Method: accounts.reportJobs.fetchReportResults

Retrieves data generated by CloudChannelReportsService.RunReportJob.

HTTP request

POST https://cloudchannel.googleapis.com/v1alpha1/{reportJob=accounts/*/reportJobs/*}:fetchReportResults

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
reportJob

string

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

Request body

The request body contains data with the following structure:

JSON representation
{
  "pageSize": integer,
  "pageToken": string
}
Fields
pageSize

integer

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

pageToken

string

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

Response body

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

Response message for CloudChannelReportsService.FetchReportResults. Contains a tabular representation of the report results.

JSON representation
{
  "reportMetadata": {
    object (ReportResultsMetadata)
  },
  "rows": [
    {
      object (Row)
    }
  ],
  "nextPageToken": string
}
Fields
reportMetadata

object (ReportResultsMetadata)

The metadata for the report results (display name, columns, row count, and date ranges).

rows[]

object (Row)

The report's lists of values. Each row follows the settings and ordering of the columns from reportMetadata.

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.

ReportResultsMetadata

The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.

JSON representation
{
  "report": {
    object (Report)
  },
  "rowCount": string,
  "dateRange": {
    object (DateRange)
  },
  "precedingDateRange": {
    object (DateRange)
  }
}
Fields
report

object (Report)

Details of the completed report.

rowCount

string (int64 format)

The total number of rows of data in the final report.

dateRange

object (DateRange)

The date range of reported usage.

precedingDateRange

object (DateRange)

The usage dates immediately preceding dateRange with the same duration. Use this to calculate trending usage and costs. This is only populated if you request trending data.

For example, if dateRange is July 1-15, precedingDateRange will be June 16-30.

Row

A row of report values.

JSON representation
{
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Fields
values[]

object (ReportValue)

The list of values in the row.

ReportValue

A single report value.

JSON representation
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "intValue": string,
  "decimalValue": {
    object (Decimal)
  },
  "moneyValue": {
    object (Money)
  },
  "dateValue": {
    object (Date)
  },
  "dateTimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
Fields
Union field value. A single report value. value can be only one of the following:
stringValue

string

A value of type string.

intValue

string (int64 format)

A value of type int.

decimalValue

object (Decimal)

A value of type google.type.Decimal, representing non-integer numeric values.

moneyValue

object (Money)

A value of type google.type.Money (currency code, whole units, decimal units).

dateValue

object (Date)

A value of type google.type.Date (year, month, day).

dateTimeValue

object (DateTime)

A value of type google.type.DateTime (year, month, day, hour, minute, second, and UTC offset or timezone.)