Report

Stay organized with collections Save and categorize content based on your preferences.

The ID and description of a report that was used to generate report data. For example, "GCP Daily Spend", "Google Workspace License Activity", etc.

JSON representation
{
  "name": string,
  "displayName": string,
  "columns": [
    {
      object (Column)
    }
  ],
  "description": string
}
Fields
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}

displayName

string

A human-readable name for this report.

columns[]

object (Column)

The list of columns included in the report. This defines the schema of the report results.

description

string

A description of other aspects of the report, such as the products it supports.

Column

The definition of a report column. Specifies the data properties in the corresponding position of the report rows.

JSON representation
{
  "columnId": string,
  "displayName": string,
  "dataType": enum (DataType)
}
Fields
columnId

string

The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter. To see all reports and their columns, call CloudChannelReportsService.ListReports.

displayName

string

The column's display name.

dataType

enum (DataType)

The type of the values for this column.

DataType

Available data types for columns. Corresponds to the fields in the ReportValue oneof field.

Enums
DATA_TYPE_UNSPECIFIED Not used.
STRING ReportValues for this column will use stringValue.
INT ReportValues for this column will use intValue.
DECIMAL ReportValues for this column will use decimalValue.
MONEY ReportValues for this column will use moneyValue.
DATE ReportValues for this column will use dateValue.
DATE_TIME ReportValues for this column will use dateTimeValue.