Index
CloudChannelReportsService(interface) (deprecated)CloudChannelService(interface)ActivateEntitlementRequest(message)AdminUser(message)AssociationInfo(message)BillableSku(message)BillingAccount(message)BillingAccountPurchaseInfo(message)CancelEntitlementRequest(message)ChangeOfferRequest(message)ChangeParametersRequest(message)ChangeRenewalSettingsRequest(message)ChannelPartnerLink(message)ChannelPartnerLinkState(enum)ChannelPartnerLinkView(enum)ChannelPartnerRepricingConfig(message)CheckCloudIdentityAccountsExistRequest(message)CheckCloudIdentityAccountsExistResponse(message)CloudIdentityCustomerAccount(message)CloudIdentityInfo(message)CloudIdentityInfo.CustomerType(enum)Column(message) (deprecated)Column.DataType(enum)CommitmentSettings(message)ConditionalOverride(message)Constraints(message)ContactInfo(message)CreateChannelPartnerLinkRequest(message)CreateChannelPartnerRepricingConfigRequest(message)CreateCustomerRepricingConfigRequest(message)CreateCustomerRequest(message)CreateEntitlementRequest(message)Customer(message)CustomerConstraints(message)CustomerEvent(message)CustomerEvent.Type(enum)CustomerRepricingConfig(message)DateRange(message) (deprecated)DeleteChannelPartnerRepricingConfigRequest(message)DeleteCustomerRepricingConfigRequest(message)DeleteCustomerRequest(message)EduData(message)EduData.InstituteSize(enum)EduData.InstituteType(enum)Entitlement(message)Entitlement.ProvisioningState(enum)Entitlement.SuspensionReason(enum)EntitlementChange(message)EntitlementChange.ActivationReason(enum)EntitlementChange.CancellationReason(enum)EntitlementChange.ChangeType(enum)EntitlementChange.OperatorType(enum)EntitlementEvent(message)EntitlementEvent.Type(enum)FetchReportResultsRequest(message) (deprecated)FetchReportResultsResponse(message) (deprecated)GetChannelPartnerLinkRequest(message)GetChannelPartnerRepricingConfigRequest(message)GetCustomerRepricingConfigRequest(message)GetCustomerRequest(message)GetEntitlementRequest(message)ImportCustomerRequest(message)ListChannelPartnerLinksRequest(message)ListChannelPartnerLinksResponse(message)ListChannelPartnerRepricingConfigsRequest(message)ListChannelPartnerRepricingConfigsResponse(message)ListCustomerRepricingConfigsRequest(message)ListCustomerRepricingConfigsResponse(message)ListCustomersRequest(message)ListCustomersResponse(message)ListEntitlementChangesRequest(message)ListEntitlementChangesResponse(message)ListEntitlementsRequest(message)ListEntitlementsResponse(message)ListOffersRequest(message)ListOffersResponse(message)ListProductsRequest(message)ListProductsResponse(message)ListPurchasableOffersRequest(message)ListPurchasableOffersRequest.ChangeOfferPurchase(message)ListPurchasableOffersRequest.CreateEntitlementPurchase(message)ListPurchasableOffersResponse(message)ListPurchasableSkusRequest(message)ListPurchasableSkusRequest.ChangeOfferPurchase(message)ListPurchasableSkusRequest.ChangeOfferPurchase.ChangeType(enum)ListPurchasableSkusRequest.CreateEntitlementPurchase(message)ListPurchasableSkusResponse(message)ListReportsRequest(message) (deprecated)ListReportsResponse(message) (deprecated)ListSkuGroupBillableSkusRequest(message)ListSkuGroupBillableSkusResponse(message)ListSkuGroupsRequest(message)ListSkuGroupsResponse(message)ListSkusRequest(message)ListSkusResponse(message)ListSubscribersRequest(message)ListSubscribersResponse(message)ListTransferableOffersRequest(message)ListTransferableOffersResponse(message)ListTransferableSkusRequest(message)ListTransferableSkusResponse(message)LookupOfferRequest(message)MarketingInfo(message)Media(message)MediaType(enum)Offer(message)OperationMetadata(message)OperationMetadata.OperationType(enum)Parameter(message)ParameterDefinition(message)ParameterDefinition.ParameterType(enum)PaymentPlan(enum)PaymentType(enum)PercentageAdjustment(message)Period(message)PeriodType(enum)Plan(message)Price(message)PriceByResource(message)PricePhase(message)PriceTier(message)Product(message)PromotionalOrderType(enum)ProvisionCloudIdentityRequest(message)ProvisionedService(message)PurchasableOffer(message)PurchasableSku(message)QueryEligibleBillingAccountsRequest(message)QueryEligibleBillingAccountsResponse(message)RebillingBasis(enum)RegisterSubscriberRequest(message)RegisterSubscriberResponse(message)RenewalSettings(message)Report(message) (deprecated)ReportJob(message) (deprecated)ReportResultsMetadata(message) (deprecated)ReportStatus(message) (deprecated)ReportStatus.State(enum)ReportValue(message) (deprecated)RepricingAdjustment(message)RepricingCondition(message)RepricingConfig(message)RepricingConfig.ChannelPartnerGranularity(message) (deprecated)RepricingConfig.EntitlementGranularity(message)ResourceType(enum)Row(message) (deprecated)RunReportJobRequest(message) (deprecated)RunReportJobResponse(message) (deprecated)Sku(message)SkuGroup(message)SkuGroupCondition(message)SkuPurchaseGroup(message)StartPaidServiceRequest(message)SubscriberEvent(message)SuspendEntitlementRequest(message)TransferEligibility(message)TransferEligibility.Reason(enum)TransferEntitlementsRequest(message)TransferEntitlementsResponse(message)TransferEntitlementsToGoogleRequest(message)TransferableOffer(message)TransferableSku(message)TrialSettings(message)UnregisterSubscriberRequest(message)UnregisterSubscriberResponse(message)UpdateChannelPartnerLinkRequest(message)UpdateChannelPartnerRepricingConfigRequest(message)UpdateCustomerRepricingConfigRequest(message)UpdateCustomerRequest(message)Value(message)
CloudChannelReportsService
CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud, Google Voice, and Google Workspace.)
Deprecated: This service is being deprecated. Please use Export Channel Services data to BigQuery instead.
| FetchReportResults |
|---|
|
Retrieves data generated by Deprecated: Please use Export Channel Services data to BigQuery instead.
|
| ListReports |
|---|
|
Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result. Deprecated: Please use Export Channel Services data to BigQuery instead.
|
| RunReportJob |
|---|
|
Begins generation of data for a given report. The report identifier is a UID (for example, Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of To get the results of report generation, call Deprecated: Please use Export Channel Services data to BigQuery instead.
|
CloudChannelService
CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.
Using this service: 1. Resellers and distributors can manage a customer entity. 2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access. 3. Resellers and distributors can manage customer entitlements.
CloudChannelService exposes the following resources: - Customers: An entity-usually an enterprise-managed by a reseller or distributor.
Entitlements: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.ChannelPartnerLinks: An entity that identifies links between distributors and their indirect resellers in a channel.
| ActivateEntitlement |
|---|
|
Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| CancelEntitlement |
|---|
|
Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of
|
| ChangeOffer |
|---|
|
Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| ChangeParameters |
|---|
|
Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| ChangeRenewalSettings |
|---|
|
Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| CheckCloudIdentityAccountsExist |
|---|
|
Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes:
Return value: A list of Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no
|
| CreateChannelPartnerLink |
|---|
|
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes:
Return value: The new
|
| CreateChannelPartnerRepricingConfig |
|---|
|
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the When creating a config for a future month, make sure there are no existing configs for that The following restrictions are for creating configs in the current month.
Possible Error Codes:
Return Value: If successful, the updated
|
| CreateCustomer |
|---|
|
Creates a new Possible error codes:
Return value: The newly created
|
| CreateCustomerRepricingConfig |
|---|
|
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the When creating a config for a future month, make sure there are no existing configs for that The following restrictions are for creating configs in the current month.
Possible Error Codes:
Return Value: If successful, the updated
|
| CreateEntitlement |
|---|
|
Creates an entitlement for a customer. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| DeleteChannelPartnerRepricingConfig |
|---|
|
Deletes the given Possible error codes:
|
| DeleteCustomer |
|---|
|
Deletes the given Possible error codes:
|
| DeleteCustomerRepricingConfig |
|---|
|
Deletes the given Possible error codes:
|
| GetChannelPartnerLink |
|---|
|
Returns the requested Possible error codes:
Return value: The
|
| GetChannelPartnerRepricingConfig |
|---|
|
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes:
Return Value: If successful, the
|
| GetCustomer |
|---|
|
Returns the requested Possible error codes:
Return value: The
|
| GetCustomerRepricingConfig |
|---|
|
Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes:
Return Value: If successful, the
|
| GetEntitlement |
|---|
|
Returns the requested Possible error codes:
Return value: The requested
|
| ImportCustomer |
|---|
|
Imports a Possible error codes:
Return value: The
|
| ListChannelPartnerLinks |
|---|
|
List Possible error codes:
Return value: The list of the distributor account's
|
| ListChannelPartnerRepricingConfigs |
|---|
|
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes:
Return Value: If successful, the
If unsuccessful, returns an error.
|
| ListCustomerRepricingConfigs |
|---|
|
Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes:
Return Value: If successful, the
If unsuccessful, returns an error.
|
| ListCustomers |
|---|
|
List Possible error codes:
Return value: List of
|
| ListEntitlementChanges |
|---|
|
List entitlement history. Possible error codes:
Return value: List of
|
| ListEntitlements |
|---|
|
Lists Possible error codes:
Return value: A list of the customer's
|
| ListOffers |
|---|
|
Lists the Offers the reseller can sell. Possible error codes:
|
| ListProducts |
|---|
|
Lists the Products the reseller is authorized to sell. Possible error codes:
|
| ListPurchasableOffers |
|---|
|
Lists the following:
Possible error codes:
|
| ListPurchasableSkus |
|---|
|
Lists the following:
Possible error codes:
|
| ListSkuGroupBillableSkus |
|---|
|
Lists the Billable SKUs in a given SKU group. Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support. Return Value: If successful, the If unsuccessful, returns an error.
|
| ListSkuGroups |
|---|
|
Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups Possible Error Codes:
Return Value: If successful, the If unsuccessful, returns an error.
|
| ListSkus |
|---|
|
Lists the SKUs for a product the reseller is authorized to sell. Possible error codes:
|
| ListSubscribers |
|---|
|
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes:
Return value: A list of service email addresses.
|
| ListTransferableOffers |
|---|
|
List Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes:
Return value: List of
|
| ListTransferableSkus |
|---|
|
List Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes:
Return value: A list of the customer's
|
| LookupOffer |
|---|
|
Returns the requested Possible error codes:
Return value: The
|
| ProvisionCloudIdentity |
|---|
|
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of
|
| QueryEligibleBillingAccounts |
|---|
|
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes:
Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
|
| RegisterSubscriber |
|---|
|
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through Possible error codes:
Return value: The topic name with the registered service email address.
|
| StartPaidService |
|---|
|
Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| SuspendEntitlement |
|---|
|
Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| TransferEntitlements |
|---|
|
Transfers customer entitlements to new reseller. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of
|
| TransferEntitlementsToGoogle |
|---|
|
Transfers customer entitlements from their current reseller to Google. Possible error codes:
Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of
|
| UnregisterSubscriber |
|---|
|
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes:
Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
|
| UpdateChannelPartnerLink |
|---|
|
Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes:
Return value: The updated
|
| UpdateChannelPartnerRepricingConfig |
|---|
|
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the When updating a config in the future:
Possible Error Codes:
Return Value: If successful, the updated
|
| UpdateCustomer |
|---|
|
Updates an existing Possible error codes:
Return value: The updated
|
| UpdateCustomerRepricingConfig |
|---|
|
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the When updating a config in the future:
Possible Error Codes:
Return Value: If successful, the updated
|
ActivateEntitlementRequest
Request message for CloudChannelService.ActivateEntitlement.
| Fields | |
|---|---|
name |
Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
AdminUser
Information needed to create an Admin User for Google Workspace.
| Fields | |
|---|---|
email |
Primary email of the admin user. |
given_ |
Given name of the admin user. |
family_ |
Family name of the admin user. |
AssociationInfo
Association links that an entitlement has to other entitlements.
| Fields | |
|---|---|
base_ |
The name of the base entitlement, for which this entitlement is an add-on. |
BillableSku
Represents the Billable SKU information.
| Fields | |
|---|---|
sku |
Resource name of Billable SKU. Format: billableSkus/{sku}. Example: billableSkus/6E1B-6634-470F". |
sku_ |
Unique human readable name for the SKU. |
service |
Resource name of Service which contains Repricing SKU. Format: services/{service}. Example: "services/B7D9-FDCB-15D8". |
service_ |
Unique human readable name for the Service. |
BillingAccount
Represents a billing account.
| Fields | |
|---|---|
name |
Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. |
display_ |
Display name of the billing account. |
create_ |
Output only. The time when this billing account was created. |
currency_ |
Output only. The 3-letter currency code defined in ISO 4217. |
region_ |
Output only. The CLDR region code. |
BillingAccountPurchaseInfo
Represents a billing account that can be used to make a purchase.
| Fields | |
|---|---|
billing_ |
The billing account resource. |
CancelEntitlementRequest
Request message for CloudChannelService.CancelEntitlement.
| Fields | |
|---|---|
name |
Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
ChangeOfferRequest
Request message for CloudChannelService.ChangeOffer.
| Fields | |
|---|---|
name |
Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
offer |
Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}. |
parameters[] |
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the |
purchase_ |
Optional. Purchase order id provided by the reseller. |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
billing_ |
Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts. |
price_ |
Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if populated in a request, this field isn't evaluated in the API. |
ChangeParametersRequest
Request message for CloudChannelService.ChangeParameters.
| Fields | |
|---|---|
name |
Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
parameters[] |
Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
purchase_ |
Optional. Purchase order ID provided by the reseller. |
ChangeRenewalSettingsRequest
Request message for CloudChannelService.ChangeRenewalSettings.
| Fields | |
|---|---|
name |
Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
renewal_ |
Required. New renewal settings. |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
ChannelPartnerLink
Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
| Fields | |
|---|---|
name |
Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. |
reseller_ |
Required. Cloud Identity ID of the linked reseller. |
link_ |
Required. State of the channel partner link. |
invite_ |
Output only. URI of the web page where partner accepts the link invitation. |
create_ |
Output only. Timestamp of when the channel partner link is created. |
update_ |
Output only. Timestamp of when the channel partner link is updated. |
public_ |
Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. |
channel_ |
Output only. Cloud Identity info of the channel partner (IR). |
ChannelPartnerLinkState
ChannelPartnerLinkState represents state of a channel partner link.
| Enums | |
|---|---|
CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED |
Not used. |
INVITED |
An invitation has been sent to the reseller to create a channel partner link. |
ACTIVE |
Status when the reseller is active. |
REVOKED |
Status when the reseller has been revoked by the distributor. |
SUSPENDED |
Status when the reseller is suspended by Google or distributor. |
ChannelPartnerLinkView
The level of granularity the ChannelPartnerLink will display.
| Enums | |
|---|---|
UNSPECIFIED |
The default / unset value. The API will default to the BASIC view. |
BASIC |
Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info. |
FULL |
Includes all fields. |
ChannelPartnerRepricingConfig
Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).
| Fields | |
|---|---|
name |
Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}. |
repricing_ |
Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner. |
update_ |
Output only. Timestamp of an update to the repricing rule. If |
CheckCloudIdentityAccountsExistRequest
Request message for CloudChannelService.CheckCloudIdentityAccountsExist.
| Fields | |
|---|---|
parent |
Required. The reseller account's resource name. Parent uses the format: accounts/{account_id} |
domain |
Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails. |
primary_ |
Optional. Primary admin email to fetch for Cloud Identity account team customer. |
CheckCloudIdentityAccountsExistResponse
Response message for CloudChannelService.CheckCloudIdentityAccountsExist.
| Fields | |
|---|---|
cloud_ |
The Cloud Identity accounts associated with the domain. |
CloudIdentityCustomerAccount
Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.
| Fields | |
|---|---|
existing |
Returns true if a Cloud Identity account exists for a specific domain. |
owned |
Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner (with active subscriptions or purchase consents). |
customer_ |
If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id}/customers/{customer_id} |
customer_ |
If existing = true, the Cloud Identity ID of the customer. |
customer_ |
If existing = true, the type of the customer. |
channel_ |
If existing = true, and is 2-tier customer, the channel partner of the customer. |
CloudIdentityInfo
Cloud Identity information for the Cloud Channel Customer.
| Fields | |
|---|---|
customer_ |
CustomerType indicates verification type needed for using services. |
primary_ |
Output only. The primary domain name. |
is_ |
Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. |
alternate_ |
The alternate email. |
phone_ |
Phone number associated with the Cloud Identity. |
language_ |
Language code. |
admin_ |
Output only. URI of Customer's Admin console dashboard. |
edu_ |
Edu information about the customer. |
CustomerType
CustomerType of the customer
| Enums | |
|---|---|
CUSTOMER_TYPE_UNSPECIFIED |
Not used. |
DOMAIN |
Domain-owning customer which needs domain verification to use services. |
TEAM |
Team customer which needs email verification to use services. |
Column
The definition of a report column. Specifies the data properties in the corresponding position of the report rows.
| Fields | |
|---|---|
column_ |
The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in |
display_ |
The column's display name. |
data_ |
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 string_value. |
INT |
ReportValues for this column will use int_value. |
DECIMAL |
ReportValues for this column will use decimal_value. |
MONEY |
ReportValues for this column will use money_value. |
DATE |
ReportValues for this column will use date_value. |
DATE_TIME |
ReportValues for this column will use date_time_value. |
CommitmentSettings
Commitment settings for commitment-based offers.
| Fields | |
|---|---|
start_ |
Output only. Commitment start timestamp. |
end_ |
Output only. Commitment end timestamp. |
renewal_ |
Optional. Renewal settings applicable for a commitment-based Offer. |
ConditionalOverride
Specifies the override to conditionally apply.
| Fields | |
|---|---|
adjustment |
Required. Information about the applied override's adjustment. |
rebilling_ |
Required. The |
repricing_ |
Required. Specifies the condition which, if met, will apply the override. |
Constraints
Represents the constraints for buying the Offer.
| Fields | |
|---|---|
customer_ |
Represents constraints required to purchase the Offer for a customer. |
ContactInfo
Contact information for a customer account.
| Fields | |
|---|---|
first_ |
The customer account contact's first name. Optional for Team customers. |
last_ |
The customer account contact's last name. Optional for Team customers. |
display_ |
Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. |
email |
The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers. |
title |
Optional. The customer account contact's job title. |
phone |
The customer account's contact phone number. |
CreateChannelPartnerLinkRequest
Request message for CloudChannelService.CreateChannelPartnerLink
| Fields | |
|---|---|
parent |
Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id} |
channel_ |
Required. The channel partner link to create. Either channel_partner_link.reseller_cloud_identity_id or domain can be used to create a link. |
CreateChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.CreateChannelPartnerRepricingConfig.
| Fields | |
|---|---|
parent |
Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id} |
channel_ |
Required. The ChannelPartnerRepricingConfig object to update. |
CreateCustomerRepricingConfigRequest
Request message for CloudChannelService.CreateCustomerRepricingConfig.
| Fields | |
|---|---|
parent |
Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id} |
customer_ |
Required. The CustomerRepricingConfig object to update. |
CreateCustomerRequest
Request message for CloudChannelService.CreateCustomer
| Fields | |
|---|---|
parent |
Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id} |
customer |
Required. The customer to create. |
CreateEntitlementRequest
Request message for CloudChannelService.CreateEntitlement
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_id} |
entitlement |
Required. The entitlement to create. |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
Customer
Entity representing a customer of a reseller or distributor.
| Fields | |
|---|---|
name |
Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} |
org_ |
Required. Name of the organization that the customer entity represents. |
org_ |
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region, postal code, and address lines. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. |
primary_ |
Primary contact info. |
alternate_ |
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers. |
domain |
Required. The customer's primary domain. Must match the primary contact email's domain. |
create_ |
Output only. Time when the customer was created. |
update_ |
Output only. Time when the customer was updated. |
cloud_ |
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. |
language_ |
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
cloud_ |
Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. |
channel_ |
Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. |
correlation_ |
Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer. |
CustomerConstraints
Represents constraints required to purchase the Offer for a customer.
| Fields | |
|---|---|
allowed_ |
Allowed geographical regions of the customer. |
allowed_ |
Allowed Customer Type. |
promotional_ |
Allowed Promotional Order Type. Present for Promotional offers. |
CustomerEvent
Represents Pub/Sub message content describing customer update.
| Fields | |
|---|---|
customer |
Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} |
event_ |
Type of event which happened for the customer. |
Type
Type of customer event.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Not used. |
PRIMARY_DOMAIN_CHANGED |
Primary domain for customer was changed. |
PRIMARY_DOMAIN_VERIFIED |
Primary domain of the customer has been verified. |
CustomerRepricingConfig
Configuration for how a reseller will reprice a Customer.
| Fields | |
|---|---|
name |
Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. |
repricing_ |
Required. The configuration for bill modifications made by a reseller before sending it to customers. |
update_ |
Output only. Timestamp of an update to the repricing rule. If |
DateRange
A representation of usage or invoice date ranges.
| Fields | |
|---|---|
usage_ |
The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass |
usage_ |
The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass |
invoice_ |
The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month. |
invoice_ |
The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month. |
DeleteChannelPartnerRepricingConfigRequest
Request message for DeleteChannelPartnerRepricingConfig.
| Fields | |
|---|---|
name |
Required. The resource name of the channel partner repricing config rule to delete. |
DeleteCustomerRepricingConfigRequest
Request message for CloudChannelService.DeleteCustomerRepricingConfig.
| Fields | |
|---|---|
name |
Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. |
DeleteCustomerRequest
Request message for CloudChannelService.DeleteCustomer.
| Fields | |
|---|---|
name |
Required. The resource name of the customer to delete. |
EduData
Required Edu Attributes
| Fields | |
|---|---|
institute_ |
Designated institute type of customer. |
institute_ |
Size of the institute. |
website |
Web address for the edu customer's institution. |
InstituteSize
Number of students and staff the institute has.
| Enums | |
|---|---|
INSTITUTE_SIZE_UNSPECIFIED |
Not used. |
SIZE_1_100 |
1 - 100 |
SIZE_101_500 |
101 - 500 |
SIZE_501_1000 |
501 - 1,000 |
SIZE_1001_2000 |
1,001 - 2,000 |
SIZE_2001_5000 |
2,001 - 5,000 |
SIZE_5001_10000 |
5,001 - 10,000 |
SIZE_10001_OR_MORE |
10,001 + |
InstituteType
Enum to specify the institute type.
| Enums | |
|---|---|
INSTITUTE_TYPE_UNSPECIFIED |
Not used. |
K12 |
Elementary/Secondary Schools & Districts |
UNIVERSITY |
Higher Education Universities & Colleges |
Entitlement
An entitlement is a representation of a customer's ability to use a service.
| Fields | |
|---|---|
name |
Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. |
create_ |
Output only. The time at which the entitlement is created. |
update_ |
Output only. The time at which the entitlement is updated. |
offer |
Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. |
commitment_ |
Commitment settings for a commitment-based Offer. Required for commitment based offers. |
provisioning_ |
Output only. Current provisioning state of the entitlement. |
provisioned_ |
Output only. Service provisioning details for the entitlement. |
suspension_ |
Output only. Enumerable of all current suspension reasons for an entitlement. |
purchase_ |
Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements. |
trial_ |
Output only. Settings for trial offers. |
association_ |
Association information to other entitlements. |
parameters[] |
Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the For Google Workspace, the following Parameters may be accepted as input:
OR
The response may additionally include the following output-only Parameters:
For Google Cloud billing subaccounts, the following Parameter may be accepted as input:
|
billing_ |
Optional. The billing account resource name that is used to pay for this entitlement. |
price_ |
Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API. |
ProvisioningState
Indicates the current provisioning state of the entitlement.
| Enums | |
|---|---|
PROVISIONING_STATE_UNSPECIFIED |
Not used. |
ACTIVE |
The entitlement is currently active. |
SUSPENDED |
The entitlement is currently suspended. |
SuspensionReason
Suspension reason for an entitlement if provisioning_state = SUSPENDED.
| Enums | |
|---|---|
SUSPENSION_REASON_UNSPECIFIED |
Not used. |
RESELLER_INITIATED |
Entitlement was manually suspended by the Reseller. |
TRIAL_ENDED |
Trial ended. |
RENEWAL_WITH_TYPE_CANCEL |
Entitlement renewal was canceled. |
PENDING_TOS_ACCEPTANCE |
Entitlement was automatically suspended on creation for pending ToS acceptance on customer. |
OTHER |
Other reasons (internal reasons, abuse, etc.). |
EntitlementChange
Change event entry for Entitlement order history
| Fields | |
|---|---|
entitlement |
Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
offer |
Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}. |
provisioned_ |
Service provisioned for an Entitlement. |
change_ |
The change action type. |
create_ |
The submitted time of the change. |
operator_ |
Operator type responsible for the change. |
parameters[] |
Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc. |
operator |
Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty. |
Union field change_reason. The reason the change was made change_reason can be only one of the following: |
|
suspension_ |
Suspension reason for the Entitlement. |
cancellation_ |
Cancellation reason for the Entitlement. |
activation_ |
The Entitlement's activation reason |
other_ |
e.g. purchase_number change reason, entered by CRS. |
ActivationReason
The Entitlement's activation reason
| Enums | |
|---|---|
ACTIVATION_REASON_UNSPECIFIED |
Not used. |
RESELLER_REVOKED_SUSPENSION |
Reseller reactivated a suspended Entitlement. |
CUSTOMER_ACCEPTED_PENDING_TOS |
Customer accepted pending terms of service. |
RENEWAL_SETTINGS_CHANGED |
Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement. |
OTHER_ACTIVATION_REASON |
Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.) |
CancellationReason
Cancellation reason for the entitlement
| Enums | |
|---|---|
CANCELLATION_REASON_UNSPECIFIED |
Not used. |
SERVICE_TERMINATED |
Reseller triggered a cancellation of the service. |
RELATIONSHIP_ENDED |
Relationship between the reseller and customer has ended due to a transfer. |
PARTIAL_TRANSFER |
Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller. |
ChangeType
Specifies the type of change action
| Enums | |
|---|---|
CHANGE_TYPE_UNSPECIFIED |
Not used. |
CREATED |
New Entitlement was created. |
PRICE_PLAN_SWITCHED |
Price plan associated with an Entitlement was changed. |
COMMITMENT_CHANGED |
Number of seats committed for a commitment Entitlement was changed. |
RENEWED |
An annual Entitlement was renewed. |
SUSPENDED |
Entitlement was suspended. |
ACTIVATED |
Entitlement was activated. |
CANCELLED |
Entitlement was cancelled. |
SKU_CHANGED |
Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus. |
RENEWAL_SETTING_CHANGED |
The settings for renewal of an Entitlement have changed. |
PAID_SUBSCRIPTION_STARTED |
Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created. |
LICENSE_CAP_CHANGED |
License cap was changed for the entitlement. |
SUSPENSION_DETAILS_CHANGED |
The suspension details have changed (but it is still suspended). |
TRIAL_END_DATE_EXTENDED |
The trial end date was extended. |
TRIAL_STARTED |
Entitlement started trial. |
OperatorType
Specifies the type of operator responsible for the change
| Enums | |
|---|---|
OPERATOR_TYPE_UNSPECIFIED |
Not used. |
CUSTOMER_SERVICE_REPRESENTATIVE |
Customer service representative. |
SYSTEM |
System auto job. |
CUSTOMER |
Customer user. |
RESELLER |
Reseller user. |
EntitlementEvent
Represents Pub/Sub message content describing entitlement update.
| Fields | |
|---|---|
entitlement |
Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
event_ |
Type of event which happened for the entitlement. |
Type
Type of entitlement event.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Not used. |
CREATED |
A new entitlement was created. |
PRICE_PLAN_SWITCHED |
The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal. |
COMMITMENT_CHANGED |
Annual commitment for a commit plan was changed. |
RENEWED |
An annual entitlement was renewed. |
SUSPENDED |
Entitlement was suspended. |
ACTIVATED |
Entitlement was unsuspended. |
CANCELLED |
Entitlement was cancelled. |
SKU_CHANGED |
Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus). |
RENEWAL_SETTING_CHANGED |
The renewal settings of an entitlement has changed. |
PAID_SERVICE_STARTED |
Paid service has started on trial entitlement. |
LICENSE_ASSIGNMENT_CHANGED |
License was assigned to or revoked from a user. |
LICENSE_CAP_CHANGED |
License cap was changed for the entitlement. |
FetchReportResultsRequest
Request message for CloudChannelReportsService.FetchReportResults.
| Fields | |
|---|---|
report_ |
Required. The report job created by |
page_ |
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. |
page_ |
Optional. A token that specifies a page of results beyond the first page. Obtained through |
partition_ |
Optional. List of keys specifying which report partitions to return. If empty, returns all partitions. |
FetchReportResultsResponse
Response message for CloudChannelReportsService.FetchReportResults. Contains a tabular representation of the report results.
| Fields | |
|---|---|
report_ |
The metadata for the report results (display name, columns, row count, and date ranges). |
rows[] |
The report's lists of values. Each row follows the settings and ordering of the columns from |
next_ |
Pass this token to |
GetChannelPartnerLinkRequest
Request message for CloudChannelService.GetChannelPartnerLink.
| Fields | |
|---|---|
name |
Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. |
view |
Optional. The level of granularity the ChannelPartnerLink will display. |
GetChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.GetChannelPartnerRepricingConfig
| Fields | |
|---|---|
name |
Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}. |
GetCustomerRepricingConfigRequest
Request message for CloudChannelService.GetCustomerRepricingConfig.
| Fields | |
|---|---|
name |
Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. |
GetCustomerRequest
Request message for CloudChannelService.GetCustomer.
| Fields | |
|---|---|
name |
Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id} |
GetEntitlementRequest
Request message for CloudChannelService.GetEntitlement.
| Fields | |
|---|---|
name |
Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
ImportCustomerRequest
Request message for CloudChannelService.ImportCustomer
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id} |
auth_ |
Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details. |
overwrite_ |
Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain. |
channel_ |
Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well. |
customer |
Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id} |
Union field customer_identity. Specifies the identity of the transfer customer. A customer's cloud_identity_id or domain is required to look up the customer's Cloud Identity. For Team customers, only the cloud_identity_id option is valid. customer_identity can be only one of the following: |
|
domain |
Required. Customer domain. |
cloud_ |
Required. Customer's Cloud Identity ID |
primary_ |
Required. Customer's primary admin email. |
ListChannelPartnerLinksRequest
Request message for CloudChannelService.ListChannelPartnerLinks
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id} |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200. |
page_ |
Optional. A token for a page of results other than the first page. Obtained using |
view |
Optional. The level of granularity the ChannelPartnerLink will display. |
ListChannelPartnerLinksResponse
Response message for CloudChannelService.ListChannelPartnerLinks.
| Fields | |
|---|---|
channel_ |
The Channel partner links for a reseller. |
next_ |
A token to retrieve the next page of results. Pass to |
ListChannelPartnerRepricingConfigsRequest
Request message for CloudChannelService.ListChannelPartnerRepricingConfigs.
| Fields | |
|---|---|
parent |
Required. The resource name of the account's |
page_ |
Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100. |
page_ |
Optional. A token identifying a page of results beyond the first page. Obtained through |
filter |
Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] results (channel_partner_link only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set Example: |
ListChannelPartnerRepricingConfigsResponse
Response message for CloudChannelService.ListChannelPartnerRepricingConfigs.
| Fields | |
|---|---|
channel_ |
The repricing configs for this channel partner. |
next_ |
A token to retrieve the next page of results. Pass to |
ListCustomerRepricingConfigsRequest
Request message for CloudChannelService.ListCustomerRepricingConfigs.
| Fields | |
|---|---|
parent |
Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers. |
page_ |
Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100. |
page_ |
Optional. A token identifying a page of results beyond the first page. Obtained through |
filter |
Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] results (customer only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set Example: customer = accounts/account_id/customers/c1 OR customer = accounts/account_id/customers/c2. |
ListCustomerRepricingConfigsResponse
Response message for CloudChannelService.ListCustomerRepricingConfigs.
| Fields | |
|---|---|
customer_ |
The repricing configs for this channel partner. |
next_ |
A token to retrieve the next page of results. Pass to |
ListCustomersRequest
Request message for CloudChannelService.ListCustomers
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}. |
page_ |
Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50. |
page_ |
Optional. A token identifying a page of results other than the first page. Obtained through |
filter |
Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information. |
ListCustomersResponse
Response message for CloudChannelService.ListCustomers.
| Fields | |
|---|---|
customers[] |
The customers belonging to a reseller or distributor. |
next_ |
A token to retrieve the next page of results. Pass to |
ListEntitlementChangesRequest
Request message for CloudChannelService.ListEntitlementChanges
| Fields | |
|---|---|
parent |
Required. The resource name of the entitlement for which to list entitlement changes. The
|
page_ |
Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50. |
page_ |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
filter |
Optional. Filters applied to the list results. |
ListEntitlementChangesResponse
Response message for CloudChannelService.ListEntitlementChanges
| Fields | |
|---|---|
entitlement_ |
The list of entitlement changes. |
next_ |
A token to list the next page of results. |
ListEntitlementsRequest
Request message for CloudChannelService.ListEntitlements
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id} |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100. |
page_ |
Optional. A token for a page of results other than the first page. Obtained using |
ListEntitlementsResponse
Response message for CloudChannelService.ListEntitlements.
| Fields | |
|---|---|
entitlements[] |
The reseller customer's entitlements. |
next_ |
A token to list the next page of results. Pass to |
ListOffersRequest
Request message for ListOffers.
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}. |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A token for a page of results other than the first page. |
filter |
Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1 |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
show_ |
Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now. |
ListOffersResponse
Response message for ListOffers.
| Fields | |
|---|---|
offers[] |
The list of Offers requested. |
next_ |
A token to retrieve the next page of results. |
ListProductsRequest
Request message for ListProducts.
| Fields | |
|---|---|
account |
Required. The resource name of the reseller account. Format: accounts/{account_id}. |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A token for a page of results other than the first page. |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
ListProductsResponse
Response message for ListProducts.
| Fields | |
|---|---|
products[] |
List of Products requested. |
next_ |
A token to retrieve the next page of results. |
ListPurchasableOffersRequest
Request message for ListPurchasableOffers.
| Fields | |
|---|---|
customer |
Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}. |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Offers. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A token for a page of results other than the first page. |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
Union field purchase_option. Defines the intended purchase. purchase_option can be only one of the following: |
|
create_ |
List Offers for CreateEntitlement purchase. |
change_ |
List Offers for ChangeOffer purchase. |
ChangeOfferPurchase
List Offers for ChangeOffer purchase.
| Fields | |
|---|---|
entitlement |
Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
new_ |
Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id} |
billing_ |
Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts. |
CreateEntitlementPurchase
List Offers for CreateEntitlement purchase.
| Fields | |
|---|---|
sku |
Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}. |
billing_ |
Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. |
ListPurchasableOffersResponse
Response message for ListPurchasableOffers.
| Fields | |
|---|---|
purchasable_ |
The list of Offers requested. |
next_ |
A token to retrieve the next page of results. |
ListPurchasableSkusRequest
Request message for ListPurchasableSkus.
| Fields | |
|---|---|
customer |
Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}. |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A token for a page of results other than the first page. |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
Union field purchase_option. Defines the intended purchase. purchase_option can be only one of the following: |
|
create_ |
List SKUs for CreateEntitlement purchase. |
change_ |
List SKUs for ChangeOffer purchase with a new SKU. |
ChangeOfferPurchase
List SKUs for upgrading or downgrading an entitlement. Make the purchase using CloudChannelService.ChangeOffer.
| Fields | |
|---|---|
entitlement |
Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
change_ |
Required. Change Type for the entitlement. |
ChangeType
Change Type enum.
| Enums | |
|---|---|
CHANGE_TYPE_UNSPECIFIED |
Not used. |
UPGRADE |
SKU is an upgrade on the current entitlement. |
DOWNGRADE |
SKU is a downgrade on the current entitlement. |
CreateEntitlementPurchase
List SKUs for a new entitlement. Make the purchase using CloudChannelService.CreateEntitlement.
| Fields | |
|---|---|
product |
Required. List SKUs belonging to this Product. Format: products/{product_id}. Supports products/- to retrieve SKUs for all products. |
ListPurchasableSkusResponse
Response message for ListPurchasableSkus.
| Fields | |
|---|---|
purchasable_ |
The list of SKUs requested. |
next_ |
A token to retrieve the next page of results. |
ListReportsRequest
Request message for CloudChannelReportsService.ListReports.
| Fields | |
|---|---|
parent |
Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id} |
page_ |
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. |
page_ |
Optional. A token that specifies a page of results beyond the first page. Obtained through |
language_ |
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". |
ListReportsResponse
Response message for CloudChannelReportsService.ListReports.
| Fields | |
|---|---|
reports[] |
The reports available to the partner. |
next_ |
Pass this token to |
ListSkuGroupBillableSkusRequest
Request message for ListSkuGroupBillableSkus.
| Fields | |
|---|---|
parent |
Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}. |
page_ |
Optional. The maximum number of SKUs to return. The service may return fewer than this value. If unspecified, returns a maximum of 100000 SKUs. The maximum value is 100000; values above 100000 will be coerced to 100000. |
page_ |
Optional. A token identifying a page of results beyond the first page. Obtained through |
ListSkuGroupBillableSkusResponse
Response message for ListSkuGroupBillableSkus.
| Fields | |
|---|---|
billable_ |
The list of billable SKUs in the requested SKU group. |
next_ |
A token to retrieve the next page of results. Pass to |
ListSkuGroupsRequest
Request message for ListSkuGroups.
| Fields | |
|---|---|
parent |
Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}. |
page_ |
Optional. The maximum number of SKU groups to return. The service may return fewer than this value. If unspecified, returns a maximum of 1000 SKU groups. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_ |
Optional. A token identifying a page of results beyond the first page. Obtained through |
ListSkuGroupsResponse
Response message for ListSkuGroups.
| Fields | |
|---|---|
sku_ |
The list of SKU groups requested. |
next_ |
A token to retrieve the next page of results. Pass to |
ListSkusRequest
Request message for ListSkus.
| Fields | |
|---|---|
parent |
Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id}. Supports products/- to retrieve SKUs for all products. |
account |
Required. Resource name of the reseller. Format: accounts/{account_id}. |
page_ |
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A token for a page of results other than the first page. Optional. |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
ListSkusResponse
Response message for ListSkus.
| Fields | |
|---|---|
skus[] |
The list of SKUs requested. |
next_ |
A token to retrieve the next page of results. |
ListSubscribersRequest
Request Message for ListSubscribers.
| Fields | |
|---|---|
account |
Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. |
page_ |
Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
integrator |
Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. |
ListSubscribersResponse
Response Message for ListSubscribers.
| Fields | |
|---|---|
topic |
Name of the topic registered with the reseller. |
service_ |
List of service accounts which have subscriber access to the topic. |
next_ |
A token that can be sent as |
ListTransferableOffersRequest
Request message for CloudChannelService.ListTransferableOffers
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's account. |
page_ |
Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 offers. The maximum value is 1000; the server will coerce values above 1000. |
page_ |
A token for a page of results other than the first page. Obtained using |
sku |
Required. The SKU to look up Offers for. |
language_ |
Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". |
billing_ |
Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts. |
Union field transferred_customer_identity. Specifies the identity of transferred customer. Either a cloud_identity_id of the customer or the customer name is required to look up transferrable Offers. transferred_customer_identity can be only one of the following: |
|
cloud_ |
Customer's Cloud Identity ID |
customer_ |
A reseller should create a customer and use the resource name of that customer here. |
ListTransferableOffersResponse
Response message for CloudChannelService.ListTransferableOffers.
| Fields | |
|---|---|
transferable_ |
Information about Offers for a customer that can be used for transfer. |
next_ |
A token to retrieve the next page of results. Pass to |
ListTransferableSkusRequest
Request message for CloudChannelService.ListTransferableSkus
| Fields | |
|---|---|
parent |
Required. The reseller account's resource name. Parent uses the format: accounts/{account_id} |
page_ |
The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional. |
page_ |
A token for a page of results other than the first page. Obtained using |
auth_ |
Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details. |
language_ |
The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". Optional. |
Union field transferred_customer_identity. Specifies the identity of transferred customer. Either a cloud_identity_id of the customer or the customer name is required to look up transferable SKUs. transferred_customer_identity can be only one of the following: |
|
cloud_ |
Customer's Cloud Identity ID |
customer_ |
A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id}/customers/{customer_id} |
ListTransferableSkusResponse
Response message for CloudChannelService.ListTransferableSkus.
| Fields | |
|---|---|
transferable_ |
Information about existing SKUs for a customer that needs a transfer. |
next_ |
A token to retrieve the next page of results. Pass to |
LookupOfferRequest
Request message for LookupOffer.
| Fields | |
|---|---|
entitlement |
Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
MarketingInfo
Represents the marketing information for a Product, SKU or Offer.
| Fields | |
|---|---|
display_ |
Human readable name. |
description |
Human readable description. Description can contain HTML. |
default_ |
Default logo. |
Media
Represents media information.
| Fields | |
|---|---|
title |
Title of the media. |
content |
URL of the media. |
type |
Type of the media. |
MediaType
Type of media used.
| Enums | |
|---|---|
MEDIA_TYPE_UNSPECIFIED |
Not used. |
MEDIA_TYPE_IMAGE |
Type of image. |
Offer
Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.
| Fields | |
|---|---|
name |
Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id} |
marketing_ |
Marketing information for the Offer. |
sku |
SKU the offer is associated with. |
plan |
Describes the payment plan for the Offer. |
constraints |
Constraints on transacting the Offer. |
price_ |
Price for each monetizable resource type. |
start_ |
Start of the Offer validity time. |
end_ |
Output only. End of the Offer validity time. |
parameter_ |
Parameters required to use current Offer to purchase. |
deal_ |
The deal code of the offer to get a special promotion or discount. |
OperationMetadata
Provides contextual information about a google.longrunning.Operation.
| Fields | |
|---|---|
operation_ |
The RPC that initiated this Long Running Operation. |
OperationType
RPCs that return a Long Running Operation.
| Enums | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
Not used. |
CREATE_ENTITLEMENT |
Long Running Operation was triggered by CreateEntitlement. |
CHANGE_RENEWAL_SETTINGS |
Long Running Operation was triggered by ChangeRenewalSettings. |
START_PAID_SERVICE |
Long Running Operation was triggered by StartPaidService. |
ACTIVATE_ENTITLEMENT |
Long Running Operation was triggered by ActivateEntitlement. |
SUSPEND_ENTITLEMENT |
Long Running Operation was triggered by SuspendEntitlement. |
CANCEL_ENTITLEMENT |
Long Running Operation was triggered by CancelEntitlement. |
TRANSFER_ENTITLEMENTS |
Long Running Operation was triggered by TransferEntitlements. |
TRANSFER_ENTITLEMENTS_TO_GOOGLE |
Long Running Operation was triggered by TransferEntitlementsToGoogle. |
CHANGE_OFFER |
Long Running Operation was triggered by ChangeOffer. |
CHANGE_PARAMETERS |
Long Running Operation was triggered by ChangeParameters. |
PROVISION_CLOUD_IDENTITY |
Long Running Operation was triggered by ProvisionCloudIdentity. |
Parameter
Definition for extended entitlement parameters.
| Fields | |
|---|---|
name |
Name of the parameter. |
value |
Value of the parameter. |
editable |
Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. |
ParameterDefinition
Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
| Fields | |
|---|---|
name |
Name of the parameter. |
parameter_ |
Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here. |
min_ |
Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types. |
max_ |
Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types. |
allowed_ |
If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type. |
optional |
If set to true, parameter is optional to purchase this Offer. |
ParameterType
Data type of the parameter.
| Enums | |
|---|---|
PARAMETER_TYPE_UNSPECIFIED |
Not used. |
INT64 |
Int64 type. |
STRING |
String type. |
DOUBLE |
Double type. |
BOOLEAN |
Boolean type. |
PaymentPlan
Describes how the reseller will be billed.
| Enums | |
|---|---|
PAYMENT_PLAN_UNSPECIFIED |
Not used. |
COMMITMENT |
Commitment. |
FLEXIBLE |
No commitment. |
FREE |
Free. |
TRIAL |
Trial. |
OFFLINE |
Price and ordering not available through API. |
PaymentType
Specifies when the payment needs to happen.
| Enums | |
|---|---|
PAYMENT_TYPE_UNSPECIFIED |
Not used. |
PREPAY |
Prepay. Amount has to be paid before service is rendered. |
POSTPAY |
Postpay. Reseller is charged at the end of the Payment cycle. |
PercentageAdjustment
An adjustment that applies a flat markup or markdown to an entire bill.
| Fields | |
|---|---|
percentage |
The percentage of the bill to adjust. For example: Mark down by 1% => "-1.00" Mark up by 1% => "1.00" Pass-Through => "0.00" |
Period
Represents period in days/months/years.
| Fields | |
|---|---|
duration |
Total duration of Period Type defined. |
period_ |
Period Type. |
PeriodType
Period Type.
| Enums | |
|---|---|
PERIOD_TYPE_UNSPECIFIED |
Not used. |
DAY |
Day. |
MONTH |
Month. |
YEAR |
Year. |
Plan
The payment plan for the Offer. Describes how to make a payment.
| Fields | |
|---|---|
payment_ |
Describes how a reseller will be billed. |
payment_ |
Specifies when the payment needs to happen. |
payment_ |
Describes how frequently the reseller will be billed, such as once per month. |
trial_ |
Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period. |
billing_ |
Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. |
Price
Represents the price of the Offer.
| Fields | |
|---|---|
base_ |
Base price. |
discount |
Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. |
effective_ |
Effective Price after applying the discounts. |
external_ |
Link to external price list, such as link to Google Voice rate card. |
PriceByResource
Represents price by resource type.
| Fields | |
|---|---|
resource_ |
Resource Type. Example: SEAT |
price |
Price of the Offer. Present if there are no price phases. |
price_ |
Specifies the price by time range. |
PricePhase
Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.
| Fields | |
|---|---|
period_ |
Defines the phase period type. |
first_ |
Defines first period for the phase. |
last_ |
Defines first period for the phase. |
price |
Price of the phase. Present if there are no price tiers. |
price_ |
Price by the resource tiers. |
PriceTier
Defines price at resource tier level. For example, an offer with following definition :
- Tier 1: Provide 25% discount for all seats between 1 and 25.
- Tier 2: Provide 10% discount for all seats between 26 and 100.
- Tier 3: Provide flat 15% discount for all seats above 100.
Each of these tiers is represented as a PriceTier.
| Fields | |
|---|---|
first_ |
First resource for which the tier price applies. |
last_ |
Last resource for which the tier price applies. |
price |
Price of the tier. |
Product
A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.
| Fields | |
|---|---|
name |
Resource Name of the Product. Format: products/{product_id} |
marketing_ |
Marketing information for the product. |
PromotionalOrderType
Constraints type for Promotional offers.
| Enums | |
|---|---|
PROMOTIONAL_TYPE_UNSPECIFIED |
Not used. |
NEW_UPGRADE |
Order used for new customers, trial conversions and upgrades. |
TRANSFER |
All orders for transferring an existing customer. |
PROMOTION_SWITCH |
Orders for modifying an existing customer's promotion on the same SKU. |
ProvisionCloudIdentityRequest
Request message for CloudChannelService.ProvisionCloudIdentity
| Fields | |
|---|---|
customer |
Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} |
cloud_ |
CloudIdentity-specific customer information. |
user |
Admin user information. |
validate_ |
Validate the request and preview the review, but do not post it. |
ProvisionedService
Service provisioned for an entitlement.
| Fields | |
|---|---|
provisioning_ |
Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. |
product_ |
Output only. The product pertaining to the provisioning resource as specified in the Offer. |
sku_ |
Output only. The SKU pertaining to the provisioning resource as specified in the Offer. |
PurchasableOffer
Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.
| Fields | |
|---|---|
offer |
Offer. |
price_ |
Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. |
PurchasableSku
SKU that you can purchase. This is used in ListPurchasableSku API response.
| Fields | |
|---|---|
sku |
SKU |
QueryEligibleBillingAccountsRequest
Request message for QueryEligibleBillingAccounts.
| Fields | |
|---|---|
customer |
Required. The resource name of the customer to list eligible billing accounts for. Format: accounts/{account_id}/customers/{customer_id}. |
skus[] |
Required. List of SKUs to list eligible billing accounts for. At least one SKU is required. Format: products/{product_id}/skus/{sku_id}. |
QueryEligibleBillingAccountsResponse
Response message for QueryEligibleBillingAccounts.
| Fields | |
|---|---|
sku_ |
List of SKU purchase groups where each group represents a set of SKUs that must be purchased using the same billing account. Each SKU from [QueryEligibleBillingAccountsRequest.skus] will appear in exactly one SKU group. |
RebillingBasis
Specifies the different costs that the modified bill can be based on.
| Enums | |
|---|---|
REBILLING_BASIS_UNSPECIFIED |
Not used. |
COST_AT_LIST |
Use the list cost, also known as the MSRP. |
DIRECT_CUSTOMER_COST |
Pass through all discounts except the Reseller Program Discount. If this is the default cost base and no adjustments are specified, the output cost will be exactly what the customer would see if they viewed the bill in the Google Cloud Console. |
RegisterSubscriberRequest
Request Message for RegisterSubscriber.
| Fields | |
|---|---|
account |
Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. |
service_ |
Required. Service account that provides subscriber access to the registered topic. |
integrator |
Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. |
RegisterSubscriberResponse
Response Message for RegisterSubscriber.
| Fields | |
|---|---|
topic |
Name of the topic the subscriber will listen to. |
RenewalSettings
Renewal settings for renewable Offers.
| Fields | |
|---|---|
enable_ |
If false, the plan will be completed at the end date. |
resize_ |
If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time. |
payment_ |
Describes how a reseller will be billed. |
payment_ |
Describes how frequently the reseller will be billed, such as once per month. |
Report
The ID and description of a report that was used to generate report data. For example, "Google Cloud Daily Spend", "Google Workspace License Activity", etc.
| Fields | |
|---|---|
name |
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, Name uses the format: accounts/{account_id}/reports/{report_id} |
display_ |
A human-readable name for this report. |
columns[] |
The list of columns included in the report. This defines the schema of the report results. |
description |
A description of other aspects of the report, such as the products it supports. |
ReportJob
The result of a [RunReportJob][] operation. Contains the name to use in FetchReportResultsRequest.report_job and the status of the operation.
| Fields | |
|---|---|
name |
Required. The resource name of a report job. Name uses the format: |
report_ |
The current status of report generation. |
ReportResultsMetadata
The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.
| Fields | |
|---|---|
report |
Details of the completed report. |
row_ |
The total number of rows of data in the final report. |
date_ |
The date range of reported usage. |
preceding_ |
The usage dates immediately preceding For example, if |
ReportStatus
Status of a report generation process.
| Fields | |
|---|---|
state |
The current state of the report generation process. |
start_ |
The report generation's start time. |
end_ |
The report generation's completion time. |
State
Available states of report generation.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Not used. |
STARTED |
Report processing started. |
WRITING |
Data generated from the report is being staged. |
AVAILABLE |
Report data is available for access. |
FAILED |
Report failed. |
ReportValue
A single report value.
| Fields | |
|---|---|
Union field value. A single report value. value can be only one of the following: |
|
string_ |
A value of type |
int_ |
A value of type |
decimal_ |
A value of type |
money_ |
A value of type |
date_ |
A value of type |
date_ |
A value of type |
RepricingAdjustment
A type that represents the various adjustments you can apply to a bill.
| Fields | |
|---|---|
Union field adjustment. A oneof that represents the different types for this adjustment. adjustment can be only one of the following: |
|
percentage_ |
Flat markup or markdown on an entire bill. |
RepricingCondition
Represents the various repricing conditions you can use for a conditional override.
| Fields | |
|---|---|
Union field condition. Represents the types of existing conditional statements. condition can be only one of the following: |
|
sku_ |
SKU Group condition for override. |
RepricingConfig
Configuration for repricing a Google bill over a period of time.
| Fields | |
|---|---|
effective_ |
Required. The YearMonth when these adjustments activate. The Day field needs to be "0" since we only accept YearMonth repricing boundaries. |
adjustment |
Required. Information about the adjustment. |
rebilling_ |
Required. The |
conditional_ |
The conditional overrides to apply for this configuration. If you list multiple overrides, only the first valid override is used. If you don't list any overrides, the API uses the normal adjustment and rebilling basis. |
Union field granularity. Required. Defines the granularity for repricing. granularity can be only one of the following: |
|
entitlement_ |
Applies the repricing configuration at the entitlement level. Note: If a |
channel_partner_granularity |
Applies the repricing configuration at the channel partner level. Only |
ChannelPartnerGranularity
This type has no fields.
Applies the repricing configuration at the channel partner level. The channel partner value is derived from the resource name. Takes an empty json object. Deprecated: This is no longer supported. Use RepricingConfig.EntitlementGranularity instead.
EntitlementGranularity
Applies the repricing configuration at the entitlement level.
| Fields | |
|---|---|
entitlement |
Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
ResourceType
Represents the type for a monetizable resource(any entity on which billing happens). For example, this could be MINUTES for Google Voice and GB for Google Drive. One SKU can map to multiple monetizable resources.
| Enums | |
|---|---|
RESOURCE_TYPE_UNSPECIFIED |
Not used. |
SEAT |
Seat. |
MAU |
Monthly active user. |
GB |
GB (used for storage SKUs). |
LICENSED_USER |
Active licensed users(for Voice SKUs). |
MINUTES |
Voice usage. |
IAAS_USAGE |
For IaaS SKUs like Google Cloud, monetization is based on usage accrued on your billing account irrespective of the type of monetizable resource. This enum represents an aggregated resource/container for all usage SKUs on a billing account. Currently, only applicable to Google Cloud. |
SUBSCRIPTION |
For Google Cloud subscriptions like Anthos or SAP. |
Row
A row of report values.
| Fields | |
|---|---|
values[] |
The list of values in the row. |
partition_ |
The key for the partition this row belongs to. This field is empty if the report is not partitioned. |
RunReportJobRequest
Request message for CloudChannelReportsService.RunReportJob.
| Fields | |
|---|---|
name |
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, |
date_ |
Optional. The range of usage or invoice dates to include in the result. |
filter |
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 For example: |
language_ |
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". |
RunReportJobResponse
Response message for CloudChannelReportsService.RunReportJob.
| Fields | |
|---|---|
report_ |
Pass |
report_ |
The metadata for the report's results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data. |
Sku
Represents a product's purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs.
| Fields | |
|---|---|
name |
Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id} |
marketing_ |
Marketing information for the SKU. |
product |
Product the SKU is associated with. |
SkuGroup
Represents the SKU group information.
| Fields | |
|---|---|
name |
Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041". |
display_ |
Unique human readable identifier for the SKU group. |
SkuGroupCondition
A condition that applies the override if a line item SKU is found in the SKU group.
| Fields | |
|---|---|
sku_ |
Specifies a SKU group (https://cloud.google.com/skus/sku-groups). Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041". |
SkuPurchaseGroup
Represents a set of SKUs that must be purchased using the same billing account.
| Fields | |
|---|---|
skus[] |
Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}. |
billing_ |
List of billing accounts that are eligible to purhcase these SKUs. |
StartPaidServiceRequest
Request message for CloudChannelService.StartPaidService.
| Fields | |
|---|---|
name |
Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
SubscriberEvent
Represents information which resellers will get as part of notification from Pub/Sub.
| Fields | |
|---|---|
Union field event. Specifies the Pub/Sub event provided to the partners. This is a required field. event can be only one of the following: |
|
customer_ |
Customer event sent as part of Pub/Sub event to partners. |
entitlement_ |
Entitlement event sent as part of Pub/Sub event to partners. |
SuspendEntitlementRequest
Request message for CloudChannelService.SuspendEntitlement.
| Fields | |
|---|---|
name |
Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
TransferEligibility
Specifies transfer eligibility of a SKU.
| Fields | |
|---|---|
is_ |
Whether reseller is eligible to transfer the SKU. |
description |
Localized description if reseller is not eligible to transfer the SKU. |
ineligibility_ |
Specified the reason for ineligibility. |
Reason
Reason of ineligibility.
| Enums | |
|---|---|
REASON_UNSPECIFIED |
Not used. |
PENDING_TOS_ACCEPTANCE |
Reseller needs to accept TOS before transferring the SKU. |
SKU_NOT_ELIGIBLE |
Reseller not eligible to sell the SKU. |
SKU_SUSPENDED |
SKU subscription is suspended |
CHANNEL_PARTNER_NOT_AUTHORIZED_FOR_SKU |
The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 |
TransferEntitlementsRequest
Request message for CloudChannelService.TransferEntitlements.
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id} |
entitlements[] |
Required. The new entitlements to create or transfer. |
auth_ |
The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details. |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
TransferEntitlementsResponse
Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.
| Fields | |
|---|---|
entitlements[] |
The transferred entitlements. |
TransferEntitlementsToGoogleRequest
Request message for CloudChannelService.TransferEntitlementsToGoogle.
| Fields | |
|---|---|
parent |
Required. The resource name of the reseller's customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id}/customers/{customer_id} |
entitlements[] |
Required. The entitlements to transfer to Google. |
request_ |
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
TransferableOffer
TransferableOffer represents an Offer that can be used in Transfer. Read-only.
| Fields | |
|---|---|
offer |
Offer with parameter constraints updated to allow the Transfer. |
price_ |
Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. |
TransferableSku
TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.
| Fields | |
|---|---|
transfer_ |
Describes the transfer eligibility of a SKU. |
sku |
The SKU pertaining to the provisioning resource as specified in the Offer. |
legacy_ |
Optional. The customer to transfer has an entitlement with the populated legacy SKU. |
TrialSettings
Settings for trial offers.
| Fields | |
|---|---|
trial |
Determines if the entitlement is in a trial or not:
|
end_ |
Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter. |
UnregisterSubscriberRequest
Request Message for UnregisterSubscriber.
| Fields | |
|---|---|
account |
Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. |
service_ |
Required. Service account to unregister from subscriber access to the topic. |
integrator |
Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. |
UnregisterSubscriberResponse
Response Message for UnregisterSubscriber.
| Fields | |
|---|---|
topic |
Name of the topic the service account subscriber access was removed from. |
UpdateChannelPartnerLinkRequest
Request message for CloudChannelService.UpdateChannelPartnerLink
| Fields | |
|---|---|
name |
Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. |
channel_ |
Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates. |
update_ |
Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state. |
UpdateChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.UpdateChannelPartnerRepricingConfig.
| Fields | |
|---|---|
channel_ |
Required. The ChannelPartnerRepricingConfig object to update. |
UpdateCustomerRepricingConfigRequest
Request message for CloudChannelService.UpdateCustomerRepricingConfig.
| Fields | |
|---|---|
customer_ |
Required. The CustomerRepricingConfig object to update. |
UpdateCustomerRequest
Request message for CloudChannelService.UpdateCustomer.
| Fields | |
|---|---|
customer |
Required. New contents of the customer. |
update_ |
The update mask that applies to the resource. Optional. |
Value
Data type and value of a parameter.
| Fields | |
|---|---|
Union field kind. The kind of value. kind can be only one of the following: |
|
int64_ |
Represents an int64 value. |
string_ |
Represents a string value. |
double_ |
Represents a double value. |
proto_ |
Represents an 'Any' proto value. |
bool_ |
Represents a boolean value. |