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.
CheckCloudIdentityAccountsExistRequest
Request message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
CheckCloudIdentityAccountsExistResponse
Response message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
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.
CommitmentSettings
Commitment settings for commitment-based offers.
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]
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.
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.
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.
GetChannelPartnerLinkRequest
Request message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink].
GetCustomerRequest
Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].
GetEntitlementRequest
Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement].
ListChannelPartnerLinksRequest
Request message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]
ListChannelPartnerLinksResponse
Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].
ListCustomersRequest
Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]
ListCustomersResponse
Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].
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.
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.
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.
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.
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 Cloud 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]
UpdateCustomerRequest
Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer].
Value
Data type and value of a parameter.
Enums
ChannelPartnerLinkState
ChannelPartnerLinkState represents state of a channel partner link.
ChannelPartnerLinkView
The level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display.
CloudIdentityInfo.Types.CustomerType
CustomerType of the customer
CustomerEvent.Types.Type
Type of customer event.
CustomerName.ResourceNameType
The possible contents of CustomerName.
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.
EntitlementEvent.Types.Type
Type of entitlement event.
EntitlementName.ResourceNameType
The possible contents of EntitlementName.
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.
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.