As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Channel v1 API

class google.cloud.channel_v1.types.ActivateEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement].

name

Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.AdminUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Information needed to create an Admin User for Google Workspace.

email

Primary email of the admin user.

Type

str

given_name

Given name of the admin user.

Type

str

family_name

Family name of the admin user.

Type

str

class google.cloud.channel_v1.types.AssociationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Association links that an entitlement has to other entitlements.

base_entitlement

The name of the base entitlement, for which this entitlement is an add-on.

Type

str

class google.cloud.channel_v1.types.CancelEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement].

name

Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.ChangeOfferRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].

name

Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

offer

Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}.

Type

str

parameters

Optional. Parameters needed to purchase the Offer.

Type

Sequence[google.cloud.channel_v1.types.Parameter]

purchase_order_id

Optional. Purchase order id provided by the reseller.

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.ChangeParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ChangeParametersRequest][].

name

Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

parameters

Required. Entitlement parameters to update. You can only change editable parameters.

Type

Sequence[google.cloud.channel_v1.types.Parameter]

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

purchase_order_id

Optional. Purchase order ID provided by the reseller.

Type

str

class google.cloud.channel_v1.types.ChangeRenewalSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings].

name

Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

renewal_settings

Required. New renewal settings.

Type

google.cloud.channel_v1.types.RenewalSettings

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

Bases: proto.message.Message

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

name

Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.

Type

str

reseller_cloud_identity_id

Required. Cloud Identity ID of the linked reseller.

Type

str

Required. State of the channel partner link.

Type

google.cloud.channel_v1.types.ChannelPartnerLinkState

Output only. URI of the web page where partner accepts the link invitation.

Type

str

create_time

Output only. Timestamp of when the channel partner link is created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Timestamp of when the channel partner link is updated.

Type

google.protobuf.timestamp_pb2.Timestamp

public_id

Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.

Type

str

channel_partner_cloud_identity_info

Output only. Cloud Identity info of the channel partner (IR).

Type

google.cloud.channel_v1.types.CloudIdentityInfo

class google.cloud.channel_v1.types.ChannelPartnerLinkState(value)[source]

Bases: proto.enums.Enum

ChannelPartnerLinkState represents state of a channel partner link.

ACTIVE = 2
INVITED = 1
REVOKED = 3
SUSPENDED = 4
class google.cloud.channel_v1.types.ChannelPartnerLinkView(value)[source]

Bases: proto.enums.Enum

The level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display.

BASIC = 1
FULL = 2
UNSPECIFIED = 0
class google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].

parent

Required. The reseller account’s resource name. Parent uses the format: accounts/{account_id}

Type

str

domain

Required. Domain to fetch for Cloud Identity account customer.

Type

str

class google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].

cloud_identity_accounts

The Cloud Identity accounts associated with the domain.

Type

Sequence[google.cloud.channel_v1.types.CloudIdentityCustomerAccount]

class google.cloud.channel_v1.types.CloudIdentityCustomerAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.

existing

Returns true if a Cloud Identity account exists for a specific domain.

Type

bool

owned

Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner.

Type

bool

customer_name

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}

Type

str

customer_cloud_identity_id

If existing = true, the Cloud Identity ID of the customer.

Type

str

class google.cloud.channel_v1.types.CloudIdentityInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Cloud Identity information for the Cloud Channel Customer.

customer_type

CustomerType indicates verification type needed for using services.

Type

google.cloud.channel_v1.types.CloudIdentityInfo.CustomerType

primary_domain

Output only. The primary domain name.

Type

str

is_domain_verified

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.

Type

bool

alternate_email

The alternate email.

Type

str

phone_number

Phone number associated with the Cloud Identity.

Type

str

language_code

Language code.

Type

str

admin_console_uri

Output only. URI of Customer’s Admin console dashboard.

Type

str

edu_data

Edu information about the customer.

Type

google.cloud.channel_v1.types.EduData

class CustomerType(value)[source]

Bases: proto.enums.Enum

CustomerType of the customer

CUSTOMER_TYPE_UNSPECIFIED = 0
DOMAIN = 1
TEAM = 2
class google.cloud.channel_v1.types.CommitmentSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Commitment settings for commitment-based offers.

start_time

Output only. Commitment start timestamp.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Commitment end timestamp.

Type

google.protobuf.timestamp_pb2.Timestamp

renewal_settings

Optional. Renewal settings applicable for a commitment-based Offer.

Type

google.cloud.channel_v1.types.RenewalSettings

class google.cloud.channel_v1.types.Constraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the constraints for buying the Offer.

customer_constraints

Represents constraints required to purchase the Offer for a customer.

Type

google.cloud.channel_v1.types.CustomerConstraints

class google.cloud.channel_v1.types.ContactInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Contact information for a customer account.

first_name

The customer account contact’s first name. Optional for Team customers.

Type

str

last_name

The customer account contact’s last name. Optional for Team customers.

Type

str

display_name

Output only. The customer account contact’s display name, formatted as a combination of the customer’s first and last name.

Type

str

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.

Type

str

title

Optional. The customer account contact’s job title.

Type

str

phone

The customer account’s contact phone number.

Type

str

class google.cloud.channel_v1.types.CreateChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink]

parent

Required. Create a channel partner link for the provided reseller account’s resource name. Parent uses the format: accounts/{account_id}

Type

str

Required. The channel partner link to create. Either channel_partner_link.reseller_cloud_identity_id or domain can be used to create a link.

Type

google.cloud.channel_v1.types.ChannelPartnerLink

class google.cloud.channel_v1.types.CreateCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.CloudChannelService.CreateCustomer]

parent

Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}

Type

str

customer

Required. The customer to create.

Type

google.cloud.channel_v1.types.Customer

class google.cloud.channel_v1.types.CreateEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement]

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}

Type

str

entitlement

Required. The entitlement to create.

Type

google.cloud.channel_v1.types.Entitlement

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.Customer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Entity representing a customer of a reseller or distributor.

name

Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

Type

str

org_display_name

Required. Name of the organization that the customer entity represents.

Type

str

org_postal_address

Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer’s language, use the Customer-level language code.

Type

google.type.postal_address_pb2.PostalAddress

primary_contact_info

Primary contact info.

Type

google.cloud.channel_v1.types.ContactInfo

alternate_email

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.

Type

str

domain

Required. The customer’s primary domain. Must match the primary contact email’s domain.

Type

str

create_time

Output only. Time when the customer was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Time when the customer was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

cloud_identity_id

Output only. The customer’s Cloud Identity ID if the customer has a Cloud Identity resource.

Type

str

language_code

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.

Type

str

cloud_identity_info

Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

Type

google.cloud.channel_v1.types.CloudIdentityInfo

channel_partner_id

Cloud Identity ID of the customer’s channel partner. Populated only if a channel partner exists for this customer.

Type

str

class google.cloud.channel_v1.types.CustomerConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents constraints required to purchase the Offer for a customer.

allowed_regions

Allowed geographical regions of the customer.

Type

Sequence[str]

allowed_customer_types

Allowed Customer Type.

Type

Sequence[google.cloud.channel_v1.types.CloudIdentityInfo.CustomerType]

promotional_order_types

Allowed Promotional Order Type. Present for Promotional offers.

Type

Sequence[google.cloud.channel_v1.types.PromotionalOrderType]

class google.cloud.channel_v1.types.CustomerEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents Pub/Sub message content describing customer update.

customer

Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

Type

str

event_type

Type of event which happened on the customer.

Type

google.cloud.channel_v1.types.CustomerEvent.Type

class Type(value)[source]

Bases: proto.enums.Enum

Type of customer event.

PRIMARY_DOMAIN_CHANGED = 1
PRIMARY_DOMAIN_VERIFIED = 2
TYPE_UNSPECIFIED = 0
class google.cloud.channel_v1.types.DeleteCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer].

name

Required. The resource name of the customer to delete.

Type

str

class google.cloud.channel_v1.types.EduData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Required Edu Attributes

institute_type

Designated institute type of customer.

Type

google.cloud.channel_v1.types.EduData.InstituteType

institute_size

Size of the institute.

Type

google.cloud.channel_v1.types.EduData.InstituteSize

website

Web address for the edu customer’s institution.

Type

str

class InstituteSize(value)[source]

Bases: proto.enums.Enum

Number of students and staff the institute has.

INSTITUTE_SIZE_UNSPECIFIED = 0
SIZE_10001_OR_MORE = 7
SIZE_1001_2000 = 4
SIZE_101_500 = 2
SIZE_1_100 = 1
SIZE_2001_5000 = 5
SIZE_5001_10000 = 6
SIZE_501_1000 = 3
class InstituteType(value)[source]

Bases: proto.enums.Enum

Enum to specify the institute type.

INSTITUTE_TYPE_UNSPECIFIED = 0
K12 = 1
UNIVERSITY = 2
class google.cloud.channel_v1.types.Entitlement(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An entitlement is a representation of a customer’s ability to use a service.

name

Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

Type

str

create_time

Output only. The time at which the entitlement is created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time at which the entitlement is updated.

Type

google.protobuf.timestamp_pb2.Timestamp

offer

Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

Type

str

commitment_settings

Commitment settings for a commitment-based Offer. Required for commitment based offers.

Type

google.cloud.channel_v1.types.CommitmentSettings

provisioning_state

Output only. Current provisioning state of the entitlement.

Type

google.cloud.channel_v1.types.Entitlement.ProvisioningState

provisioned_service

Output only. Service provisioning details for the entitlement.

Type

google.cloud.channel_v1.types.ProvisionedService

suspension_reasons

Output only. Enumerable of all current suspension reasons for an entitlement.

Type

Sequence[google.cloud.channel_v1.types.Entitlement.SuspensionReason]

purchase_order_id

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.

Type

str

trial_settings

Output only. Settings for trial offers.

Type

google.cloud.channel_v1.types.TrialSettings

association_info

Association information to other entitlements.

Type

google.cloud.channel_v1.types.AssociationInfo

parameters

Extended entitlement parameters. When creating an entitlement, valid parameters’ names and values are defined in the offer’s parameter definitions.

Type

Sequence[google.cloud.channel_v1.types.Parameter]

class ProvisioningState(value)[source]

Bases: proto.enums.Enum

Indicates the current provisioning state of the entitlement.

ACTIVE = 1
PROVISIONING_STATE_UNSPECIFIED = 0
SUSPENDED = 5
class SuspensionReason(value)[source]

Bases: proto.enums.Enum

Suspension reason for an entitlement if [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] = SUSPENDED.

OTHER = 100
PENDING_TOS_ACCEPTANCE = 4
RENEWAL_WITH_TYPE_CANCEL = 3
RESELLER_INITIATED = 1
SUSPENSION_REASON_UNSPECIFIED = 0
TRIAL_ENDED = 2
class google.cloud.channel_v1.types.EntitlementEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents Pub/Sub message content describing entitlement update.

entitlement

Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

event_type

Type of event which happened on the entitlement.

Type

google.cloud.channel_v1.types.EntitlementEvent.Type

class Type(value)[source]

Bases: proto.enums.Enum

Type of entitlement event.

ACTIVATED = 7
CANCELLED = 8
COMMITMENT_CHANGED = 4
CREATED = 1
LICENSE_ASSIGNMENT_CHANGED = 12
LICENSE_CAP_CHANGED = 13
PAID_SERVICE_STARTED = 11
PRICE_PLAN_SWITCHED = 3
RENEWAL_SETTING_CHANGED = 10
RENEWED = 5
SKU_CHANGED = 9
SUSPENDED = 6
TYPE_UNSPECIFIED = 0
class google.cloud.channel_v1.types.GetChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink].

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.

Type

str

view

Optional. The level of granularity the ChannelPartnerLink will display.

Type

google.cloud.channel_v1.types.ChannelPartnerLinkView

class google.cloud.channel_v1.types.GetCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].

name

Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

Type

str

class google.cloud.channel_v1.types.GetEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement].

name

Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

class google.cloud.channel_v1.types.ImportCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer]

domain

Required. Customer domain.

Type

str

cloud_identity_id

Required. Customer’s Cloud Identity ID

Type

str

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}

Type

str

auth_token

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.

Type

str

overwrite_if_exists

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.

Type

bool

channel_partner_id

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.

Type

str

customer

Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}

Type

str

class google.cloud.channel_v1.types.ListChannelPartnerLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]

parent

Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page. Obtained using [ListChannelPartnerLinksResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token] of the previous [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] call.

Type

str

view

Optional. The level of granularity the ChannelPartnerLink will display.

Type

google.cloud.channel_v1.types.ChannelPartnerLinkView

class google.cloud.channel_v1.types.ListChannelPartnerLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].

The Channel partner links for a reseller.

Type

Sequence[google.cloud.channel_v1.types.ChannelPartnerLink]

next_page_token

A token to retrieve the next page of results. Pass to [ListChannelPartnerLinksRequest.page_token][google.cloud.channel.v1.ListChannelPartnerLinksRequest.page_token] to obtain that page.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListCustomersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]

parent

Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token identifying a page of results other than the first page. Obtained through [ListCustomersResponse.next_page_token][google.cloud.channel.v1.ListCustomersResponse.next_page_token] of the previous [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] call.

Type

str

class google.cloud.channel_v1.types.ListCustomersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].

customers

The customers belonging to a reseller or distributor.

Type

Sequence[google.cloud.channel_v1.types.Customer]

next_page_token

A token to retrieve the next page of results. Pass to [ListCustomersRequest.page_token][google.cloud.channel.v1.ListCustomersRequest.page_token] to obtain that page.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListEntitlementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]

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}

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page. Obtained using [ListEntitlementsResponse.next_page_token][google.cloud.channel.v1.ListEntitlementsResponse.next_page_token] of the previous [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] call.

Type

str

class google.cloud.channel_v1.types.ListEntitlementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements].

entitlements

The reseller customer’s entitlements.

Type

Sequence[google.cloud.channel_v1.types.Entitlement]

next_page_token

A token to list the next page of results. Pass to [ListEntitlementsRequest.page_token][google.cloud.channel.v1.ListEntitlementsRequest.page_token] to obtain that page.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for ListOffers.

parent

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page.

Type

str

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

Type

str

language_code

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”.

Type

str

class google.cloud.channel_v1.types.ListOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for ListOffers.

offers

The list of Offers requested.

Type

Sequence[google.cloud.channel_v1.types.Offer]

next_page_token

A token to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for ListProducts.

account

Required. The resource name of the reseller account. Format: accounts/{account_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page.

Type

str

language_code

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”.

Type

str

class google.cloud.channel_v1.types.ListProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for ListProducts.

products

List of Products requested.

Type

Sequence[google.cloud.channel_v1.types.Product]

next_page_token

A token to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListPurchasableOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for ListPurchasableOffers.

create_entitlement_purchase

List Offers for CreateEntitlement purchase.

Type

google.cloud.channel_v1.types.ListPurchasableOffersRequest.CreateEntitlementPurchase

change_offer_purchase

List Offers for ChangeOffer purchase.

Type

google.cloud.channel_v1.types.ListPurchasableOffersRequest.ChangeOfferPurchase

customer

Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page.

Type

str

language_code

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”.

Type

str

class ChangeOfferPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List Offers for ChangeOffer purchase.

entitlement

Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

new_sku

Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}

Type

str

class CreateEntitlementPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List Offers for CreateEntitlement purchase.

sku

Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.

Type

str

class google.cloud.channel_v1.types.ListPurchasableOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for ListPurchasableOffers.

purchasable_offers

The list of Offers requested.

Type

Sequence[google.cloud.channel_v1.types.PurchasableOffer]

next_page_token

A token to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListPurchasableSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for ListPurchasableSkus.

create_entitlement_purchase

List SKUs for CreateEntitlement purchase.

Type

google.cloud.channel_v1.types.ListPurchasableSkusRequest.CreateEntitlementPurchase

change_offer_purchase

List SKUs for ChangeOffer purchase with a new SKU.

Type

google.cloud.channel_v1.types.ListPurchasableSkusRequest.ChangeOfferPurchase

customer

Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page.

Type

str

language_code

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”.

Type

str

class ChangeOfferPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List SKUs for upgrading or downgrading an entitlement. Make the purchase using [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].

entitlement

Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

change_type

Required. Change Type for the entitlement.

Type

google.cloud.channel_v1.types.ListPurchasableSkusRequest.ChangeOfferPurchase.ChangeType

class ChangeType(value)[source]

Bases: proto.enums.Enum

Change Type enum.

CHANGE_TYPE_UNSPECIFIED = 0
DOWNGRADE = 2
UPGRADE = 1
class CreateEntitlementPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List SKUs for a new entitlement. Make the purchase using [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement].

product

Required. List SKUs belonging to this Product. Format: products/{product_id}. Supports products/- to retrieve SKUs for all products.

Type

str

class google.cloud.channel_v1.types.ListPurchasableSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for ListPurchasableSkus.

purchasable_skus

The list of SKUs requested.

Type

Sequence[google.cloud.channel_v1.types.PurchasableSku]

next_page_token

A token to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for ListSkus.

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

account

Required. Resource name of the reseller. Format: accounts/{account_id}.

Type

str

page_size

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.

Type

int

page_token

Optional. A token for a page of results other than the first page. Optional.

Type

str

language_code

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”.

Type

str

class google.cloud.channel_v1.types.ListSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for ListSkus.

skus

The list of SKUs requested.

Type

Sequence[google.cloud.channel_v1.types.Sku]

next_page_token

A token to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListSubscribersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request Message for ListSubscribers.

account

Required. Resource name of the account.

Type

str

page_size

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.

Type

int

page_token

Optional. A page token, received from a previous ListSubscribers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSubscribers must match the call that provided the page token.

Type

str

class google.cloud.channel_v1.types.ListSubscribersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response Message for ListSubscribers.

topic

Name of the topic registered with the reseller.

Type

str

service_accounts

List of service accounts which have subscriber access to the topic.

Type

Sequence[str]

next_page_token

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListTransferableOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]

cloud_identity_id

Customer’s Cloud Identity ID

Type

str

customer_name

A reseller should create a customer and use the resource name of that customer here.

Type

str

parent

Required. The resource name of the reseller’s account.

Type

str

page_size

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.

Type

int

page_token

A token for a page of results other than the first page. Obtained using [ListTransferableOffersResponse.next_page_token][google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token] of the previous [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] call.

Type

str

sku

Required. The SKU to look up Offers for.

Type

str

language_code

The BCP-47 language code. For example, “en- S”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.

Type

str

class google.cloud.channel_v1.types.ListTransferableOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers].

transferable_offers

Information about Offers for a customer that can be used for transfer.

Type

Sequence[google.cloud.channel_v1.types.TransferableOffer]

next_page_token

A token to retrieve the next page of results. Pass to [ListTransferableOffersRequest.page_token][google.cloud.channel.v1.ListTransferableOffersRequest.page_token] to obtain that page.

Type

str

property raw_page
class google.cloud.channel_v1.types.ListTransferableSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]

cloud_identity_id

Customer’s Cloud Identity ID

Type

str

customer_name

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}

Type

str

parent

Required. The reseller account’s resource name. Parent uses the format: accounts/{account_id}

Type

str

page_size

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.

Type

int

page_token

A token for a page of results other than the first page. Obtained using [ListTransferableSkusResponse.next_page_token][google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token] of the previous [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] call. Optional.

Type

str

auth_token

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.

Type

str

language_code

The BCP-47 language code. For example, “en- S”. The response will localize in the corresponding language code, if specified. The default value is “en-US”. Optional.

Type

str

class google.cloud.channel_v1.types.ListTransferableSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus].

transferable_skus

Information about existing SKUs for a customer that needs a transfer.

Type

Sequence[google.cloud.channel_v1.types.TransferableSku]

next_page_token

A token to retrieve the next page of results. Pass to [ListTransferableSkusRequest.page_token][google.cloud.channel.v1.ListTransferableSkusRequest.page_token] to obtain that page.

Type

str

property raw_page
class google.cloud.channel_v1.types.LookupOfferRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for LookupOffer.

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}

Type

str

class google.cloud.channel_v1.types.MarketingInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the marketing information for a Product, SKU or Offer.

display_name

Human readable name.

Type

str

description

Human readable description. Description can contain HTML.

Type

str

Default logo.

Type

google.cloud.channel_v1.types.Media

class google.cloud.channel_v1.types.Media(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents media information.

title

Title of the media.

Type

str

content

URL of the media.

Type

str

type_

Type of the media.

Type

google.cloud.channel_v1.types.MediaType

class google.cloud.channel_v1.types.MediaType(value)[source]

Bases: proto.enums.Enum

Type of media used.

MEDIA_TYPE_IMAGE = 1
MEDIA_TYPE_UNSPECIFIED = 0
class google.cloud.channel_v1.types.Offer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id}

Type

str

marketing_info

Marketing information for the Offer.

Type

google.cloud.channel_v1.types.MarketingInfo

sku

SKU the offer is associated with.

Type

google.cloud.channel_v1.types.Sku

plan

Describes the payment plan for the Offer.

Type

google.cloud.channel_v1.types.Plan

constraints

Constraints on transacting the Offer.

Type

google.cloud.channel_v1.types.Constraints

price_by_resources

Price for each monetizable resource type.

Type

Sequence[google.cloud.channel_v1.types.PriceByResource]

start_time

Start of the Offer validity time.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. End of the Offer validity time.

Type

google.protobuf.timestamp_pb2.Timestamp

parameter_definitions

Parameters required to use current Offer to purchase.

Type

Sequence[google.cloud.channel_v1.types.ParameterDefinition]

class google.cloud.channel_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Provides contextual information about a [google.longrunning.Operation][google.longrunning.Operation].

operation_type

The RPC that initiated this Long Running Operation.

Type

google.cloud.channel_v1.types.OperationMetadata.OperationType

class OperationType(value)[source]

Bases: proto.enums.Enum

RPCs that return a Long Running Operation.

ACTIVATE_ENTITLEMENT = 7
CANCEL_ENTITLEMENT = 9
CHANGE_OFFER = 14
CHANGE_PARAMETERS = 15
CHANGE_RENEWAL_SETTINGS = 3
CREATE_ENTITLEMENT = 1
OPERATION_TYPE_UNSPECIFIED = 0
PROVISION_CLOUD_IDENTITY = 16
START_PAID_SERVICE = 5
SUSPEND_ENTITLEMENT = 8
TRANSFER_ENTITLEMENTS = 10
TRANSFER_ENTITLEMENTS_TO_GOOGLE = 11
class google.cloud.channel_v1.types.Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Definition for extended entitlement parameters.

name

Name of the parameter.

Type

str

value

Value of the parameter.

Type

google.cloud.channel_v1.types.Value

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.

Type

bool

class google.cloud.channel_v1.types.ParameterDefinition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Parameter’s definition. Specifies what parameter is required to use the current Offer to purchase.

name

Name of the parameter.

Type

str

parameter_type

Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.

Type

google.cloud.channel_v1.types.ParameterDefinition.ParameterType

min_value

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.

Type

google.cloud.channel_v1.types.Value

max_value

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.

Type

google.cloud.channel_v1.types.Value

allowed_values

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, …] Applicable to STRING parameter type.

Type

Sequence[google.cloud.channel_v1.types.Value]

optional

If set to true, parameter is optional to purchase this Offer.

Type

bool

class ParameterType(value)[source]

Bases: proto.enums.Enum

Data type of the parameter.

DOUBLE = 3
INT64 = 1
PARAMETER_TYPE_UNSPECIFIED = 0
STRING = 2
class google.cloud.channel_v1.types.PaymentPlan(value)[source]

Bases: proto.enums.Enum

Describes how the reseller will be billed.

COMMITMENT = 1
FLEXIBLE = 2
FREE = 3
OFFLINE = 5
PAYMENT_PLAN_UNSPECIFIED = 0
TRIAL = 4
class google.cloud.channel_v1.types.PaymentType(value)[source]

Bases: proto.enums.Enum

Specifies when the payment needs to happen.

PAYMENT_TYPE_UNSPECIFIED = 0
POSTPAY = 2
PREPAY = 1
class google.cloud.channel_v1.types.Period(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents period in days/months/years.

duration

Total duration of Period Type defined.

Type

int

period_type

Period Type.

Type

google.cloud.channel_v1.types.PeriodType

class google.cloud.channel_v1.types.PeriodType(value)[source]

Bases: proto.enums.Enum

Period Type.

DAY = 1
MONTH = 2
PERIOD_TYPE_UNSPECIFIED = 0
YEAR = 3
class google.cloud.channel_v1.types.Plan(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The payment plan for the Offer. Describes how to make a payment.

payment_plan

Describes how a reseller will be billed.

Type

google.cloud.channel_v1.types.PaymentPlan

payment_type

Specifies when the payment needs to happen.

Type

google.cloud.channel_v1.types.PaymentType

payment_cycle

Describes how frequently the reseller will be billed, such as once per month.

Type

google.cloud.channel_v1.types.Period

trial_period

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.

Type

google.cloud.channel_v1.types.Period

billing_account

Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.

Type

str

class google.cloud.channel_v1.types.Price(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the price of the Offer.

base_price

Base price.

Type

google.type.money_pb2.Money

discount

Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.

Type

float

effective_price

Effective Price after applying the discounts.

Type

google.type.money_pb2.Money

external_price_uri

Link to external price list, such as link to Google Voice rate card.

Type

str

class google.cloud.channel_v1.types.PriceByResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents price by resource type.

resource_type

Resource Type. Example: SEAT

Type

google.cloud.channel_v1.types.ResourceType

price

Price of the Offer. Present if there are no price phases.

Type

google.cloud.channel_v1.types.Price

price_phases

Specifies the price by time range.

Type

Sequence[google.cloud.channel_v1.types.PricePhase]

class google.cloud.channel_v1.types.PricePhase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

period_type

Defines the phase period type.

Type

google.cloud.channel_v1.types.PeriodType

first_period

Defines first period for the phase.

Type

int

last_period

Defines first period for the phase.

Type

int

price

Price of the phase. Present if there are no price tiers.

Type

google.cloud.channel_v1.types.Price

price_tiers

Price by the resource tiers.

Type

Sequence[google.cloud.channel_v1.types.PriceTier]

class google.cloud.channel_v1.types.PriceTier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

first_resource

First resource for which the tier price applies.

Type

int

last_resource

Last resource for which the tier price applies.

Type

int

price

Price of the tier.

Type

google.cloud.channel_v1.types.Price

class google.cloud.channel_v1.types.Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.

name

Resource Name of the Product. Format: products/{product_id}

Type

str

marketing_info

Marketing information for the product.

Type

google.cloud.channel_v1.types.MarketingInfo

class google.cloud.channel_v1.types.PromotionalOrderType(value)[source]

Bases: proto.enums.Enum

Constraints type for Promotional offers.

NEW_UPGRADE = 1
PROMOTIONAL_TYPE_UNSPECIFIED = 0
PROMOTION_SWITCH = 3
TRANSFER = 2
class google.cloud.channel_v1.types.ProvisionCloudIdentityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity]

customer

Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

Type

str

cloud_identity_info

CloudIdentity-specific customer information.

Type

google.cloud.channel_v1.types.CloudIdentityInfo

user

Admin user information.

Type

google.cloud.channel_v1.types.AdminUser

validate_only

Validate the request and preview the review, but do not post it.

Type

bool

class google.cloud.channel_v1.types.ProvisionedService(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Service provisioned for an entitlement.

provisioning_id

Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.

Type

str

product_id

Output only. The product pertaining to the provisioning resource as specified in the Offer.

Type

str

sku_id

Output only. The SKU pertaining to the provisioning resource as specified in the Offer.

Type

str

class google.cloud.channel_v1.types.PurchasableOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.

offer

Offer.

Type

google.cloud.channel_v1.types.Offer

class google.cloud.channel_v1.types.PurchasableSku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

SKU that you can purchase. This is used in ListPurchasableSku API response.

sku

SKU

Type

google.cloud.channel_v1.types.Sku

class google.cloud.channel_v1.types.RegisterSubscriberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request Message for RegisterSubscriber.

account

Required. Resource name of the account.

Type

str

service_account

Required. Service account that provides subscriber access to the registered topic.

Type

str

class google.cloud.channel_v1.types.RegisterSubscriberResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response Message for RegisterSubscriber.

topic

Name of the topic the subscriber will listen to.

Type

str

class google.cloud.channel_v1.types.RenewalSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Renewal settings for renewable Offers.

enable_renewal

If false, the plan will be completed at the end date.

Type

bool

resize_unit_count

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.

Type

bool

payment_plan

Describes how a reseller will be billed.

Type

google.cloud.channel_v1.types.PaymentPlan

payment_cycle

Describes how frequently the reseller will be billed, such as once per month.

Type

google.cloud.channel_v1.types.Period

class google.cloud.channel_v1.types.ResourceType(value)[source]

Bases: proto.enums.Enum

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.

GB = 3
IAAS_USAGE = 6
LICENSED_USER = 4
MAU = 2
MINUTES = 5
RESOURCE_TYPE_UNSPECIFIED = 0
SEAT = 1
SUBSCRIPTION = 7
class google.cloud.channel_v1.types.Sku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id}

Type

str

marketing_info

Marketing information for the SKU.

Type

google.cloud.channel_v1.types.MarketingInfo

product

Product the SKU is associated with.

Type

google.cloud.channel_v1.types.Product

class google.cloud.channel_v1.types.StartPaidServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.CloudChannelService.StartPaidService].

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}

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.SubscriberEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents information which resellers will get as part of notification from Cloud Pub/Sub.

customer_event

Customer event send as part of Pub/Sub event to partners.

Type

google.cloud.channel_v1.types.CustomerEvent

entitlement_event

Entitlement event send as part of Pub/Sub event to partners.

Type

google.cloud.channel_v1.types.EntitlementEvent

class google.cloud.channel_v1.types.SuspendEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement].

name

Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.TransferEligibility(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies transfer eligibility of a SKU.

is_eligible

Whether reseller is eligible to transfer the SKU.

Type

bool

description

Localized description if reseller is not eligible to transfer the SKU.

Type

str

ineligibility_reason

Specified the reason for ineligibility.

Type

google.cloud.channel_v1.types.TransferEligibility.Reason

class Reason(value)[source]

Bases: proto.enums.Enum

Reason of ineligibility.

PENDING_TOS_ACCEPTANCE = 1
REASON_UNSPECIFIED = 0
SKU_NOT_ELIGIBLE = 2
SKU_SUSPENDED = 3
class google.cloud.channel_v1.types.TransferEntitlementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].

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}

Type

str

entitlements

Required. The new entitlements to create or transfer.

Type

Sequence[google.cloud.channel_v1.types.Entitlement]

auth_token

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.

Type

str

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.TransferEntitlementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. This is put in the response field of google.longrunning.Operation.

entitlements

The transferred entitlements.

Type

Sequence[google.cloud.channel_v1.types.Entitlement]

class google.cloud.channel_v1.types.TransferEntitlementsToGoogleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle].

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}

Type

str

entitlements

Required. The entitlements to transfer to Google.

Type

Sequence[google.cloud.channel_v1.types.Entitlement]

request_id

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 (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.channel_v1.types.TransferableOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

TransferableOffer represents an Offer that can be used in Transfer. Read-only.

offer

Offer with parameter constraints updated to allow the Transfer.

Type

google.cloud.channel_v1.types.Offer

class google.cloud.channel_v1.types.TransferableSku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.

transfer_eligibility

Describes the transfer eligibility of a SKU.

Type

google.cloud.channel_v1.types.TransferEligibility

sku

The SKU pertaining to the provisioning resource as specified in the Offer.

Type

google.cloud.channel_v1.types.Sku

legacy_sku

Optional. The customer to transfer has an entitlement with the populated legacy SKU.

Type

google.cloud.channel_v1.types.Sku

class google.cloud.channel_v1.types.TrialSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Settings for trial offers.

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

end_time

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.channel_v1.types.UnregisterSubscriberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request Message for UnregisterSubscriber.

account

Required. Resource name of the account.

Type

str

service_account

Required. Service account to unregister from subscriber access to the topic.

Type

str

class google.cloud.channel_v1.types.UnregisterSubscriberResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response Message for UnregisterSubscriber.

topic

Name of the topic the service account subscriber access was removed from.

Type

str

class google.cloud.channel_v1.types.UpdateChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink]

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.

Type

str

Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.

Type

google.cloud.channel_v1.types.ChannelPartnerLink

update_mask

Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.channel_v1.types.UpdateCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer].

customer

Required. New contents of the customer.

Type

google.cloud.channel_v1.types.Customer

update_mask

The update mask that applies to the resource. Optional.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.channel_v1.types.Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Data type and value of a parameter.

int64_value

Represents an int64 value.

Type

int

string_value

Represents a string value.

Type

str

double_value

Represents a double value.

Type

float

proto_value

Represents an ‘Any’ proto value.

Type

google.protobuf.any_pb2.Any

bool_value

Represents a boolean value.

Type

bool