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][]. .. attribute:: name
Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
:type: str
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.
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. .. attribute:: customer_type
CustomerType indicates verification type needed for using services.
:type: google.cloud.channel_v1.types.CloudIdentityInfo.CustomerType
CommitmentSettings
Commitment settings for commitment-based offers. .. attribute:: start_time
Output only. Commitment start timestamp.
:type: google.protobuf.timestamp_pb2.Timestamp
Constraints
Represents the constraints for buying the Offer. .. attribute:: customer_constraints
Represents constraints required to purchase the Offer for a customer.
ContactInfo
Contact information for a customer account. .. attribute:: first_name
First name of the contact in the customer account.
:type: str
CreateChannelPartnerLinkRequest
Request message for CloudChannelService.CreateChannelPartnerLink
CreateCustomerRequest
Request message for CloudChannelService.CreateCustomer
CreateEntitlementRequest
Request message for CloudChannelService.CreateEntitlement
Customer
Entity representing a customer of a reseller or distributor. .. attribute:: name
Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
:type: str
CustomerConstraints
Represents constraints required to purchase the Offer for a customer.
CustomerEvent
Represents Pub/Sub message content describing customer update.
DeleteCustomerRequest
Request message for CloudChannelService.DeleteCustomer.
EduData
Required Edu Attributes .. attribute:: institute_type
Designated institute type of customer.
Entitlement
An entitlement is a representation of a customer's ability to use a service.
EntitlementEvent
Represents Pub/Sub message content describing entitlement update.
GetChannelPartnerLinkRequest
Request message for CloudChannelService.GetChannelPartnerLink.
GetCustomerRequest
Request message for CloudChannelService.GetCustomer.
GetEntitlementRequest
Request message for CloudChannelService.GetEntitlement.
ListChannelPartnerLinksRequest
Request message for CloudChannelService.ListChannelPartnerLinks
ListChannelPartnerLinksResponse
Response message for CloudChannelService.ListChannelPartnerLinks.
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. .. attribute:: parent
Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.
:type: str
ListOffersResponse
Response message for ListOffers. .. attribute:: offers
The list of Offers requested.
:type: Sequence[google.cloud.channel_v1.types.Offer]
ListProductsRequest
Request message for ListProducts. .. attribute:: account
Required. The resource name of the reseller account. Format: accounts/{account_id}.
:type: str
ListProductsResponse
Response message for ListProducts. .. attribute:: products
List of Products requested.
:type: Sequence[google.cloud.channel_v1.types.Product]
ListPurchasableOffersRequest
Request message for ListPurchasableOffers. .. attribute:: create_entitlement_purchase
List Offers for CreateEntitlement purchase.
:type: google.cloud.channel_v1.types.ListPurchasableOffersRequest.CreateEntitlementPurchase
ListPurchasableOffersResponse
Response message for ListPurchasableOffers. .. attribute:: purchasable_offers
The list of Offers requested.
:type: Sequence[google.cloud.channel_v1.types.PurchasableOffer]
ListPurchasableSkusRequest
Request message for ListPurchasableSkus. .. attribute:: create_entitlement_purchase
List SKUs for CreateEntitlement purchase.
:type: google.cloud.channel_v1.types.ListPurchasableSkusRequest.CreateEntitlementPurchase
ListPurchasableSkusResponse
Response message for ListPurchasableSkus. .. attribute:: purchasable_skus
The list of SKUs requested.
:type: Sequence[google.cloud.channel_v1.types.PurchasableSku]
ListSkusRequest
Request message for ListSkus. .. attribute:: 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.
:type: str
ListSkusResponse
Response message for ListSkus. .. attribute:: skus
The list of SKUs requested.
:type: Sequence[google.cloud.channel_v1.types.Sku]
ListSubscribersRequest
Request Message for ListSubscribers. .. attribute:: account
Required. Resource name of the account.
:type: str
ListSubscribersResponse
Response Message for ListSubscribers. .. attribute:: topic
Name of the topic registered with the reseller.
:type: str
ListTransferableOffersRequest
Request message for CloudChannelService.ListTransferableOffers
ListTransferableOffersResponse
Response message for CloudChannelService.ListTransferableOffers.
ListTransferableSkusRequest
Request message for CloudChannelService.ListTransferableSkus
ListTransferableSkusResponse
Response message for CloudChannelService.ListTransferableSkus.
MarketingInfo
Represents the marketing information for a Product, SKU or Offer.
Media
Represents media information. .. attribute:: title
Title of the media.
:type: str
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. .. attribute:: name
Name of the parameter.
:type: str
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.
Period
Represents period in days/months/years. .. attribute:: duration
Total duration of Period Type defined.
:type: int
PeriodType
Period Type.
Plan
The payment plan for the Offer. Describes how to make a payment.
Price
Represents the price of the Offer. .. attribute:: base_price
Base price.
:type: google.type.money_pb2.Money
PriceByResource
Represents price by resource type. .. attribute:: resource_type
Resource Type. Example: SEAT
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. .. attribute:: provisioning_id
Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.
:type: str
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. .. attribute:: account
Required. Resource name of the account.
:type: str
RegisterSubscriberResponse
Response Message for RegisterSubscriber. .. attribute:: topic
Name of the topic the subscriber will listen to.
:type: str
RenewalSettings
Renewal settings for renewable Offers. .. attribute:: enable_renewal
If false, the plan will be completed at the end date.
:type: bool
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.
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.
StartPaidServiceRequest
Request message for CloudChannelService.StartPaidService.
SubscriberEvent
Represents information which resellers will get as part of notification from Cloud Pub/Sub.
SuspendEntitlementRequest
Request message for CloudChannelService.SuspendEntitlement.
TransferEligibility
Specifies transfer eligibility of a SKU. .. attribute:: is_eligible
Whether reseller is eligible to transfer the SKU.
:type: bool
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. .. attribute:: trial
Determines if the entitlement is in a trial or not:
true- The entitlement is in trial.false- The entitlement is not in trial.:type: bool
UnregisterSubscriberRequest
Request Message for UnregisterSubscriber. .. attribute:: account
Required. Resource name of the account.
:type: str
UnregisterSubscriberResponse
Response Message for UnregisterSubscriber. .. attribute:: topic
Name of the topic the service account subscriber access was removed from.
:type: str
UpdateChannelPartnerLinkRequest
Request message for CloudChannelService.UpdateChannelPartnerLink
UpdateCustomerRequest
Request message for CloudChannelService.UpdateCustomer.
Value
Data type and value of a parameter. .. attribute:: int64_value
Represents an int64 value.
:type: int