Classes
ActivateEntitlementRequest
Request message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement].
AdminUser
Information needed to create an Admin User for Google Workspace.
AssociationInfo
Association links that an entitlement has to other entitlements.
CancelEntitlementRequest
Request message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement].
ChangeOfferRequest
Request message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].
ChangeParametersRequest
Request message for [CloudChannelService.ChangeParametersRequest][].
ChangeRenewalSettingsRequest
Request message for [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings].
ChannelPartnerLink
Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
ChannelPartnerLinkName
Resource name for the ChannelPartnerLink
resource.
ChannelPartnerRepricingConfig
Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).
ChannelPartnerRepricingConfigName
Resource name for the ChannelPartnerRepricingConfig
resource.
CheckCloudIdentityAccountsExistRequest
Request message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
CheckCloudIdentityAccountsExistResponse
Response message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
CloudChannelReportsService
CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud Platform (GCP), Google Voice, and Google Workspace.)
CloudChannelReportsService.CloudChannelReportsServiceBase
Base class for server-side implementations of CloudChannelReportsService
CloudChannelReportsService.CloudChannelReportsServiceClient
Client for CloudChannelReportsService
CloudChannelReportsServiceClient
CloudChannelReportsService client wrapper, for convenient use.
CloudChannelReportsServiceClientBuilder
Builder class for CloudChannelReportsServiceClient to provide simple configuration of credentials, endpoint etc.
CloudChannelReportsServiceClientImpl
CloudChannelReportsService client wrapper implementation, for convenient use.
CloudChannelReportsServiceSettings
Settings for CloudChannelReportsServiceClient instances.
CloudChannelService
CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.
Using this service:
- Resellers and distributors can manage a customer entity.
- Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
- Resellers and distributors can manage customer entitlements.
CloudChannelService exposes the following resources:
[Customer][google.cloud.channel.v1.Customer]s: An entity-usually an enterprise-managed by a reseller or distributor.
[Entitlement][google.cloud.channel.v1.Entitlement]s: 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.
[ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between distributors and their indirect resellers in a channel.
CloudChannelService.CloudChannelServiceBase
Base class for server-side implementations of CloudChannelService
CloudChannelService.CloudChannelServiceClient
Client for CloudChannelService
CloudChannelServiceClient
CloudChannelService client wrapper, for convenient use.
CloudChannelServiceClientBuilder
Builder class for CloudChannelServiceClient to provide simple configuration of credentials, endpoint etc.
CloudChannelServiceClientImpl
CloudChannelService client wrapper implementation, for convenient use.
CloudChannelServiceSettings
Settings for CloudChannelServiceClient instances.
CloudIdentityCustomerAccount
Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.
CloudIdentityInfo
Cloud Identity information for the Cloud Channel Customer.
CloudIdentityInfo.Types
Container for nested types declared in the CloudIdentityInfo message type.
Column
The definition of a report column. Specifies the data properties in the corresponding position of the report rows.
Column.Types
Container for nested types declared in the Column message type.
CommitmentSettings
Commitment settings for commitment-based offers.
ConditionalOverride
Specifies the override to conditionally apply.
Constraints
Represents the constraints for buying the Offer.
ContactInfo
Contact information for a customer account.
CreateChannelPartnerLinkRequest
Request message for [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink]
CreateChannelPartnerRepricingConfigRequest
Request message for [CloudChannelService.CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig].
CreateCustomerRepricingConfigRequest
Request message for [CloudChannelService.CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig].
CreateCustomerRequest
Request message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.CloudChannelService.CreateCustomer]
CreateEntitlementRequest
Request message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement]
Customer
Entity representing a customer of a reseller or distributor.
CustomerConstraints
Represents constraints required to purchase the Offer for a customer.
CustomerEvent
Represents Pub/Sub message content describing customer update.
CustomerEvent.Types
Container for nested types declared in the CustomerEvent message type.
CustomerName
Resource name for the Customer
resource.
CustomerRepricingConfig
Configuration for how a reseller will reprice a Customer.
CustomerRepricingConfigName
Resource name for the CustomerRepricingConfig
resource.
DateRange
A representation of usage or invoice date ranges.
DeleteChannelPartnerRepricingConfigRequest
Request message for DeleteChannelPartnerRepricingConfig.
DeleteCustomerRepricingConfigRequest
Request message for [CloudChannelService.DeleteCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig].
DeleteCustomerRequest
Request message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer].
EduData
Required Edu Attributes
EduData.Types
Container for nested types declared in the EduData message type.
Entitlement
An entitlement is a representation of a customer's ability to use a service.
Entitlement.Types
Container for nested types declared in the Entitlement message type.
EntitlementChange
Change event entry for Entitlement order history
EntitlementChange.Types
Container for nested types declared in the EntitlementChange message type.
EntitlementEvent
Represents Pub/Sub message content describing entitlement update.
EntitlementEvent.Types
Container for nested types declared in the EntitlementEvent message type.
EntitlementName
Resource name for the Entitlement
resource.
FetchReportResultsRequest
Request message for [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
FetchReportResultsResponse
Response message for [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]. Contains a tabular representation of the report results.
GetChannelPartnerLinkRequest
Request message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink].
GetChannelPartnerRepricingConfigRequest
Request message for [CloudChannelService.GetChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig]
GetCustomerRepricingConfigRequest
Request message for [CloudChannelService.GetCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig].
GetCustomerRequest
Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].
GetEntitlementRequest
Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement].
ImportCustomerRequest
Request message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer]
ListChannelPartnerLinksRequest
Request message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]
ListChannelPartnerLinksResponse
Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].
ListChannelPartnerRepricingConfigsRequest
Request message for [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].
ListChannelPartnerRepricingConfigsResponse
Response message for [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].
ListCustomerRepricingConfigsRequest
Request message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].
ListCustomerRepricingConfigsResponse
Response message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].
ListCustomersRequest
Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]
ListCustomersResponse
Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].
ListEntitlementChangesRequest
Request message for [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]
ListEntitlementChangesResponse
Response message for [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]
ListEntitlementsRequest
Request message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]
ListEntitlementsResponse
Response message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements].
ListOffersRequest
Request message for ListOffers.
ListOffersResponse
Response message for ListOffers.
ListProductsRequest
Request message for ListProducts.
ListProductsResponse
Response message for ListProducts.
ListPurchasableOffersRequest
Request message for ListPurchasableOffers.
ListPurchasableOffersRequest.Types
Container for nested types declared in the ListPurchasableOffersRequest message type.
ListPurchasableOffersRequest.Types.ChangeOfferPurchase
List Offers for ChangeOffer purchase.
ListPurchasableOffersRequest.Types.CreateEntitlementPurchase
List Offers for CreateEntitlement purchase.
ListPurchasableOffersResponse
Response message for ListPurchasableOffers.
ListPurchasableSkusRequest
Request message for ListPurchasableSkus.
ListPurchasableSkusRequest.Types
Container for nested types declared in the ListPurchasableSkusRequest message type.
ListPurchasableSkusRequest.Types.ChangeOfferPurchase
List SKUs for upgrading or downgrading an entitlement. Make the purchase using [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].
ListPurchasableSkusRequest.Types.ChangeOfferPurchase.Types
Container for nested types declared in the ChangeOfferPurchase message type.
ListPurchasableSkusRequest.Types.CreateEntitlementPurchase
List SKUs for a new entitlement. Make the purchase using [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement].
ListPurchasableSkusResponse
Response message for ListPurchasableSkus.
ListReportsRequest
Request message for [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
ListReportsResponse
Response message for [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
ListSkusRequest
Request message for ListSkus.
ListSkusResponse
Response message for ListSkus.
ListSubscribersRequest
Request Message for ListSubscribers.
ListSubscribersResponse
Response Message for ListSubscribers.
ListTransferableOffersRequest
Request message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]
ListTransferableOffersResponse
Response message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers].
ListTransferableSkusRequest
Request message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]
ListTransferableSkusResponse
Response message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus].
LookupOfferRequest
Request message for LookupOffer.
MarketingInfo
Represents the marketing information for a Product, SKU or Offer.
Media
Represents media information.
Offer
Represents an offer made to resellers for purchase. An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan for payment, a price, and defines the constraints for buying.
OfferName
Resource name for the Offer
resource.
OperationMetadata
Provides contextual information about a [google.longrunning.Operation][google.longrunning.Operation].
OperationMetadata.Types
Container for nested types declared in the OperationMetadata message type.
Parameter
Definition for extended entitlement parameters.
ParameterDefinition
Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
ParameterDefinition.Types
Container for nested types declared in the ParameterDefinition message type.
PercentageAdjustment
An adjustment that applies a flat markup or markdown to an entire bill.
Period
Represents period in days/months/years.
Plan
The payment plan for the Offer. Describes how to make a payment.
Price
Represents the price of the Offer.
PriceByResource
Represents price by resource type.
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.
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.
Product
A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.
ProductName
Resource name for the Product
resource.
ProvisionCloudIdentityRequest
Request message for [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity]
ProvisionedService
Service provisioned for an entitlement.
PurchasableOffer
Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.
PurchasableSku
SKU that you can purchase. This is used in ListPurchasableSku API response.
RegisterSubscriberRequest
Request Message for RegisterSubscriber.
RegisterSubscriberResponse
Response Message for RegisterSubscriber.
RenewalSettings
Renewal settings for renewable Offers.
Report
The ID and description of a report that was used to generate report data. For example, "GCP Daily Spend", "Google Workspace License Activity", etc.
ReportJob
The result of a [RunReportJob][] operation. Contains the name to use in [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job] and the status of the operation.
ReportJobName
Resource name for the ReportJob
resource.
ReportName
Resource name for the Report
resource.
ReportResultsMetadata
The features describing the data. Returned by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob] and [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
ReportStatus
Status of a report generation process.
ReportStatus.Types
Container for nested types declared in the ReportStatus message type.
ReportValue
A single report value.
RepricingAdjustment
A type that represents the various adjustments you can apply to a bill.
RepricingCondition
Represents the various repricing conditions you can use for a conditional override.
RepricingConfig
Configuration for repricing a Google bill over a period of time.
RepricingConfig.Types
Container for nested types declared in the RepricingConfig message type.
RepricingConfig.Types.ChannelPartnerGranularity
Applies the repricing configuration at the channel partner level. The channel partner value is derived from the resource name. Takes an empty json object.
RepricingConfig.Types.EntitlementGranularity
Applies the repricing configuration at the entitlement level.
Row
A row of report values.
RunReportJobRequest
Request message for [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
RunReportJobResponse
Response message for [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
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.
SkuGroupCondition
A condition that applies the override if a line item SKU is found in the SKU group.
SkuName
Resource name for the Sku
resource.
StartPaidServiceRequest
Request message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.CloudChannelService.StartPaidService].
SubscriberEvent
Represents information which resellers will get as part of notification from Pub/Sub.
SuspendEntitlementRequest
Request message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement].
TransferableOffer
TransferableOffer represents an Offer that can be used in Transfer. Read-only.
TransferableSku
TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.
TransferEligibility
Specifies transfer eligibility of a SKU.
TransferEligibility.Types
Container for nested types declared in the TransferEligibility message type.
TransferEntitlementsRequest
Request message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].
TransferEntitlementsResponse
Response message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. This is put in the response field of google.longrunning.Operation.
TransferEntitlementsToGoogleRequest
Request message for [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle].
TrialSettings
Settings for trial offers.
UnregisterSubscriberRequest
Request Message for UnregisterSubscriber.
UnregisterSubscriberResponse
Response Message for UnregisterSubscriber.
UpdateChannelPartnerLinkRequest
Request message for [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink]
UpdateChannelPartnerRepricingConfigRequest
Request message for [CloudChannelService.UpdateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig].
UpdateCustomerRepricingConfigRequest
Request message for [CloudChannelService.UpdateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig].
UpdateCustomerRequest
Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer].
Value
Data type and value of a parameter.
Enums
ChannelPartnerLinkName.ResourceNameType
The possible contents of ChannelPartnerLinkName.
ChannelPartnerLinkState
ChannelPartnerLinkState represents state of a channel partner link.
ChannelPartnerLinkView
The level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display.
ChannelPartnerRepricingConfigName.ResourceNameType
The possible contents of ChannelPartnerRepricingConfigName.
CloudIdentityInfo.Types.CustomerType
CustomerType of the customer
Column.Types.DataType
Available data types for columns. Corresponds to the fields in the
ReportValue oneof
field.
CustomerEvent.Types.Type
Type of customer event.
CustomerName.ResourceNameType
The possible contents of CustomerName.
CustomerRepricingConfigName.ResourceNameType
The possible contents of CustomerRepricingConfigName.
EduData.Types.InstituteSize
Number of students and staff the institute has.
EduData.Types.InstituteType
Enum to specify the institute type.
Entitlement.Types.ProvisioningState
Indicates the current provisioning state of the entitlement.
Entitlement.Types.SuspensionReason
Suspension reason for an entitlement if [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] = SUSPENDED.
EntitlementChange.ChangeReasonOneofCase
Enum of possible cases for the "change_reason" oneof.
EntitlementChange.Types.ActivationReason
The Entitlement's activation reason
EntitlementChange.Types.CancellationReason
Cancellation reason for the entitlement
EntitlementChange.Types.ChangeType
Specifies the type of change action
EntitlementChange.Types.OperatorType
Specifies the type of operator responsible for the change
EntitlementEvent.Types.Type
Type of entitlement event.
EntitlementName.ResourceNameType
The possible contents of EntitlementName.
ImportCustomerRequest.CustomerIdentityOneofCase
Enum of possible cases for the "customer_identity" oneof.
ListPurchasableOffersRequest.PurchaseOptionOneofCase
Enum of possible cases for the "purchase_option" oneof.
ListPurchasableSkusRequest.PurchaseOptionOneofCase
Enum of possible cases for the "purchase_option" oneof.
ListPurchasableSkusRequest.Types.ChangeOfferPurchase.Types.ChangeType
Change Type enum.
ListTransferableOffersRequest.TransferredCustomerIdentityOneofCase
Enum of possible cases for the "transferred_customer_identity" oneof.
ListTransferableSkusRequest.TransferredCustomerIdentityOneofCase
Enum of possible cases for the "transferred_customer_identity" oneof.
MediaType
Type of media used.
OfferName.ResourceNameType
The possible contents of OfferName.
OperationMetadata.Types.OperationType
RPCs that return a Long Running Operation.
ParameterDefinition.Types.ParameterType
Data type of the parameter.
PaymentPlan
Describes how the reseller will be billed.
PaymentType
Specifies when the payment needs to happen.
PeriodType
Period Type.
ProductName.ResourceNameType
The possible contents of ProductName.
PromotionalOrderType
Constraints type for Promotional offers.
RebillingBasis
Specifies the different costs that the modified bill can be based on.
ReportJobName.ResourceNameType
The possible contents of ReportJobName.
ReportName.ResourceNameType
The possible contents of ReportName.
ReportStatus.Types.State
Available states of report generation.
ReportValue.ValueOneofCase
Enum of possible cases for the "value" oneof.
RepricingAdjustment.AdjustmentOneofCase
Enum of possible cases for the "adjustment" oneof.
RepricingCondition.ConditionOneofCase
Enum of possible cases for the "condition" oneof.
RepricingConfig.GranularityOneofCase
Enum of possible cases for the "granularity" oneof.
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.
SkuName.ResourceNameType
The possible contents of SkuName.
SubscriberEvent.EventOneofCase
Enum of possible cases for the "event" oneof.
TransferEligibility.Types.Reason
Reason of ineligibility.
Value.KindOneofCase
Enum of possible cases for the "kind" oneof.