The Cloud Channel API lets you generate and view reports for the following datasets:
- Google Cloud billing: Covers Google Cloud and Google Maps billing data
for sub-billing accounts. This organization uses multiple dimensions,
including customer, channel partner (distributors only), service, or project.
- Google Voice expenses: Covers expenses accrued by Google Voice customers,
including appropriate taxes based on the origin or destination of calls and
the location of the customer.
Note: You should not use this data to bill customers. For billing
purposes, use the Google Voice invoices available on
your billing account.
- Google Workspace billing: Covers Google Workspace invoice data
for customer subscriptions. Dimensions include customer, service, and SKU.
These reports are only supported for Invoice date ranges. For more information,
see Report request date ranges.
Each dataset uses report types to provide different views of the available data.
You can view these report types and their associated columns with the
listReports
API.
The following list defines the available columns, including their column IDs and
the datasets they support.
Dimension columns
Customer and Channel Partner columns
| Column ID
|
Dataset
|
Description
|
| customer
|
All sets
|
The customer's resource name. Uses the format:
accounts/{account_id}/customers/{customer_id}
|
| customer_domain
|
All sets
|
The primary domain for the customer.
|
| customer_cloud_identity_id
|
All sets
|
The customer's Cloud Identity ID (if they have an account).
|
| customer_org_display_name
|
All sets
|
The name of the organization that customer represents.
|
| channel_partner_link
|
All sets
(Distributors only)
|
The channel partner's resource name. Uses the format:
accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
|
| channel_partner_primary_domain
|
All sets
(Distributors only)
|
The primary domain for the channel partner.
|
| channel_partner_cloud_identity_id
|
All sets
(Distributors only)
|
The channel partner's Cloud Identity ID (if they have an account).
|
Dates
| Column ID
|
Dataset
|
Description
|
| invoice_start_date
|
All sets
|
The earliest invoice month that the row covers.
|
| invoice_end_date
|
All sets
|
The latest invoice month that the row covers.
|
| usage_start_date_time
|
All sets
|
The earliest usage date and time that the row covers.
|
| usage_end_date_time
|
All sets
|
The earliest usage date and time that the row covers.
|
Data features
| Column ID
|
Dataset
|
Description
|
| entitlement
|
Voice
|
The entitlement's resource name. Uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
|
| service
|
All sets
|
The service's name (for example, "Compute Engine", "GOOGLE_VOICE").
|
| sku
|
All sets
|
The SKU's description (for example, "LICENSE_USAGE").
|
| currency_code
|
All sets
|
The currency of the cost-related columns. All costs in a single row share a single currency code.
|
| usage_type
|
All sets
|
The abbreviated format of the usage type (for example, GBy).
|
| usage_type_description
|
All sets
|
The full format of the usage type (for example, gigabyte).
|
| Column ID
|
Dataset
|
Description
|
| parent_billing_account
|
Google Cloud
|
The partner's Google Cloud billing account resource name. Uses the format:
billingAccounts/{billing_account_id}
|
| sub_billing_account
|
Google Cloud
|
The resource name for a sub-account that is associated with the parent billing account and is assigned to a customer. Uses the format:
billingAccounts/{billing_account_id}
|
| project_id
|
Google Cloud
|
The project's ID.
|
| project_display_name
|
Google Cloud
|
The project's display name.
|
| project_number
|
Google Cloud
|
The project's number (assigned by Google Cloud).
|
| business_entity_display_name
|
Google Cloud
|
The business entity's display name (for example, "Google Maps", "Google Cloud").
|
| business_entity
|
Google Cloud
|
The business entity's resource name (for example, "businessEntity/GEO", "businessEntity/CLOUD_PLATFORM").
|
Metric columns
| Column ID
|
Dataset
|
Description
|
| net_cost
|
All sets
|
The total usage-based costs for reseller charges. Includes the Google Reseller Program discount (Google Cloud only), negotiated savings, SUDs, CUDs, and spending-based discounts. Doesn't include offline credits or repricing.
|
| customer_cost
|
All sets
|
The usage-based cost expectation for resold customer charges. Doesn't include the Google Reseller Program discount (Google Cloud only), offline credits, or repricing.
|
| cost_at_list_price
|
All sets
|
The cost before any discounts, credits, and negotiated prices.
|
| reseller_program_discount
|
All sets
|
The Google Reseller Program discount credit applied to a sub-billing account. This value represents the reseller agreement you have with Google.
|
| gross_profit
|
All sets \
(Billing admin only)
|
The total profit, shown as the difference between customer and net costs. This is the same as the Google Cloud-only Reseller margin credit and does not include offline credits or repricing.
|
| usage_quantity
|
All sets
|
The usage amount. Any reports that provide a usage quantity will also include usage_type or usage_type_description.
|
