API documentation for channel_v1.types package.
Classes
ActivateEntitlementRequest
Request message for 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.
ChangeOfferRequest
Request message for CloudChannelService.ChangeOffer.
ChangeParametersRequest
Request message for [CloudChannelService.ChangeParametersRequest][].
ChangeRenewalSettingsRequest
Request message for CloudChannelService.ChangeRenewalSettings.
ChannelPartnerLink
Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
ChannelPartnerLinkState
ChannelPartnerLinkState represents state of a channel partner link.
ChannelPartnerLinkView
The level of granularity the ChannelPartnerLink will display.
ChannelPartnerRepricingConfig
Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).
CheckCloudIdentityAccountsExistRequest
Request message for CloudChannelService.CheckCloudIdentityAccountsExist.
CheckCloudIdentityAccountsExistResponse
Response message for CloudChannelService.CheckCloudIdentityAccountsExist.
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.
Column
The definition of a report column. Specifies the data properties in the corresponding position of the report rows.
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
CreateChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.CreateChannelPartnerRepricingConfig.
CreateCustomerRepricingConfigRequest
Request message for CloudChannelService.CreateCustomerRepricingConfig.
CreateCustomerRequest
Request message for CloudChannelService.CreateCustomer
CreateEntitlementRequest
Request message for 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.
CustomerRepricingConfig
Configuration for how a reseller will reprice a Customer.
DateRange
A representation of usage or invoice date ranges.
DeleteChannelPartnerRepricingConfigRequest
Request message for DeleteChannelPartnerRepricingConfig.
DeleteCustomerRepricingConfigRequest
Request message for CloudChannelService.DeleteCustomerRepricingConfig.
DeleteCustomerRequest
Request message for CloudChannelService.DeleteCustomer.
EduData
Required Edu Attributes
Entitlement
An entitlement is a representation of a customer's ability to use a service.
EntitlementEvent
Represents Pub/Sub message content describing entitlement update.
FetchReportResultsRequest
Request message for CloudChannelReportsService.FetchReportResults.
FetchReportResultsResponse
Response message for CloudChannelReportsService.FetchReportResults. Contains a tabular representation of the report results.
GetChannelPartnerLinkRequest
Request message for CloudChannelService.GetChannelPartnerLink.
GetChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.GetChannelPartnerRepricingConfig
GetCustomerRepricingConfigRequest
Request message for CloudChannelService.GetCustomerRepricingConfig.
GetCustomerRequest
Request message for CloudChannelService.GetCustomer.
GetEntitlementRequest
Request message for CloudChannelService.GetEntitlement.
ImportCustomerRequest
Request message for CloudChannelService.ImportCustomer
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListChannelPartnerLinksRequest
Request message for CloudChannelService.ListChannelPartnerLinks
ListChannelPartnerLinksResponse
Response message for CloudChannelService.ListChannelPartnerLinks.
ListChannelPartnerRepricingConfigsRequest
Request message for CloudChannelService.ListChannelPartnerRepricingConfigs.
ListChannelPartnerRepricingConfigsResponse
Response message for CloudChannelService.ListChannelPartnerRepricingConfigs.
ListCustomerRepricingConfigsRequest
Request message for CloudChannelService.ListCustomerRepricingConfigs.
ListCustomerRepricingConfigsResponse
Response message for CloudChannelService.ListCustomerRepricingConfigs.
ListCustomersRequest
Request message for CloudChannelService.ListCustomers
ListCustomersResponse
Response message for CloudChannelService.ListCustomers.
ListEntitlementsRequest
Request message for CloudChannelService.ListEntitlements
ListEntitlementsResponse
Response message for 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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListPurchasableOffersResponse
Response message for ListPurchasableOffers.
ListPurchasableSkusRequest
Request message for ListPurchasableSkus.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListPurchasableSkusResponse
Response message for ListPurchasableSkus.
ListReportsRequest
Request message for CloudChannelReportsService.ListReports.
ListReportsResponse
Response message for 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
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListTransferableOffersResponse
Response message for CloudChannelService.ListTransferableOffers.
ListTransferableSkusRequest
Request message for CloudChannelService.ListTransferableSkus
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListTransferableSkusResponse
Response message for CloudChannelService.ListTransferableSkus.
LookupOfferRequest
Request message for LookupOffer.
MarketingInfo
Represents the marketing information for a Product, SKU or Offer.
Media
Represents media information.
MediaType
Type of media used.
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.
OperationMetadata
Provides contextual information about a
google.longrunning.Operation][google.longrunning.Operation].
Parameter
Definition for extended entitlement parameters.
ParameterDefinition
Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
PaymentPlan
Describes how the reseller will be billed.
PaymentType
Specifies when the payment needs to happen.
PercentageAdjustment
An adjustment that applies a flat markup or markdown to an entire bill.
Period
Represents period in days/months/years.
PeriodType
Period Type.
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.
PromotionalOrderType
Constraints type for Promotional offers.
ProvisionCloudIdentityRequest
Request message for 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.
RebillingBasis
Specifies the different costs that the modified bill can be based on.
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 and the status of the operation.
ReportResultsMetadata
The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.
ReportStatus
Status of a report generation process.
ReportValue
A single report value.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RepricingAdjustment
A type that represents the various adjustments you can apply to a bill.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RepricingCondition
Represents the various repricing conditions you can use for a conditional override.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RepricingConfig
Configuration for repricing a Google bill over a period of time.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
Row
A row of report values.
RunReportJobRequest
Request message for CloudChannelReportsService.RunReportJob.
RunReportJobResponse
Response message for 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.
StartPaidServiceRequest
Request message for CloudChannelService.StartPaidService.
SubscriberEvent
Represents information which resellers will get as part of notification from Pub/Sub.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SuspendEntitlementRequest
Request message for CloudChannelService.SuspendEntitlement.
TransferEligibility
Specifies transfer eligibility of a SKU.
TransferEntitlementsRequest
Request message for CloudChannelService.TransferEntitlements.
TransferEntitlementsResponse
Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.
TransferEntitlementsToGoogleRequest
Request message for CloudChannelService.TransferEntitlementsToGoogle.
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.
TrialSettings
Settings for trial offers.
UnregisterSubscriberRequest
Request Message for UnregisterSubscriber.
UnregisterSubscriberResponse
Response Message for UnregisterSubscriber.
UpdateChannelPartnerLinkRequest
Request message for CloudChannelService.UpdateChannelPartnerLink
UpdateChannelPartnerRepricingConfigRequest
Request message for CloudChannelService.UpdateChannelPartnerRepricingConfig.
UpdateCustomerRepricingConfigRequest
Request message for CloudChannelService.UpdateCustomerRepricingConfig.
UpdateCustomerRequest
Request message for CloudChannelService.UpdateCustomer.
Value
Data type and value of a parameter.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields