Package google.cloud.channel.v1alpha1

Index

CloudChannelReportsService (interface) (deprecated)
CloudChannelService (interface)
ActivateEntitlementRequest (message)
AdminUser (message)
AssignChannelPartnerRequest (message)
AssociationInfo (message)
BillableSku (message)
BillingAccount (message)
BillingAccountPurchaseInfo (message)
CancelEntitlementRequest (message)
ChangeOfferRequest (message)
ChangeParametersRequest (message)
ChangePlanRequest (message)
ChangeQuantityRequest (message)
ChangeRenewalSettingsRequest (message)
ChangeSkuRequest (message)
ChannelPartnerEvent (message)
ChannelPartnerEvent.Type (enum)
ChannelPartnerLink (message)
ChannelPartnerLinkState (enum)
ChannelPartnerLinkView (enum)
ChannelPartnerRepricingConfig (message)
CheckCloudIdentityAccountsExistRequest (message)
CheckCloudIdentityAccountsExistResponse (message)
CloudIdentityCustomerAccount (message)
CloudIdentityInfo (message)
CloudIdentityInfo.CustomerType (enum)
Column (message) (deprecated)
Column.DataType (enum)
CommitmentSettings (message)
ConditionalOverride (message)
Constraints (message)
Contact (message)
ContactInfo (message)
CreateChannelPartnerLinkRequest (message)
CreateChannelPartnerRepricingConfigRequest (message)
CreateCustomerRepricingConfigRequest (message)
CreateCustomerRequest (message)
CreateEntitlementRequest (message)
CreateOpportunityRequest (message)
Customer (message)
Customer.CustomerAttestationState (enum)
CustomerConstraints (message)
CustomerContact (message)
CustomerContact.Role (enum)
CustomerDetails (message)
CustomerDetails.Industry (enum)
CustomerEvent (message)
CustomerEvent.Type (enum)
CustomerInfo (message)
CustomerInfo.Region (enum)
CustomerRepricingConfig (message)
DateRange (message) (deprecated)
DeleteChannelPartnerRepricingConfigRequest (message)
DeleteCustomerRepricingConfigRequest (message)
DeleteCustomerRequest (message)
DiscountComponent (message)
DiscountType (enum)
EduData (message)
EduData.InstituteSize (enum)
EduData.InstituteType (enum)
Entitlement (message)
Entitlement.ProvisioningState (enum)
Entitlement.SuspensionReason (enum)
EntitlementChange (message)
EntitlementChange.ActivationReason (enum)
EntitlementChange.CancellationReason (enum)
EntitlementChange.ChangeType (enum)
EntitlementChange.OperatorType (enum)
EntitlementEvent (message)
EntitlementEvent.Type (enum)
FetchReportResultsRequest (message) (deprecated)
FetchReportResultsResponse (message) (deprecated)
GetChannelPartnerLinkRequest (message)
GetChannelPartnerRepricingConfigRequest (message)
GetCustomerRepricingConfigRequest (message)
GetCustomerRequest (message)
GetEntitlementRequest (message)
GetOpportunityRequest (message)
ImportCustomerRequest (message)
IsvSolutionConnectInfo (message)
IsvSolutionConnectInfo.ContractVehicle (enum)
IsvSolutionConnectInfo.DeliveryModel (enum)
IsvSolutionConnectInfo.SupportLevel (enum)
ListChannelPartnerLinksRequest (message)
ListChannelPartnerLinksResponse (message)
ListChannelPartnerRepricingConfigsRequest (message)
ListChannelPartnerRepricingConfigsResponse (message)
ListCustomerRepricingConfigsRequest (message)
ListCustomerRepricingConfigsResponse (message)
ListCustomersRequest (message)
ListCustomersResponse (message)
ListEntitlementChangesRequest (message)
ListEntitlementChangesResponse (message)
ListEntitlementsRequest (message)
ListEntitlementsResponse (message)
ListOffersRequest (message)
ListOffersResponse (message)
ListProductsRequest (message)
ListProductsResponse (message)
ListProvisionableCloudIdentityTypesRequest (message)
ListProvisionableCloudIdentityTypesResponse (message)
ListPurchasableOffersRequest (message)
ListPurchasableOffersRequest.ChangeOfferPurchase (message)
ListPurchasableOffersRequest.CreateEntitlementPurchase (message)
ListPurchasableOffersResponse (message)
ListPurchasableSkusRequest (message)
ListPurchasableSkusRequest.ChangeOfferPurchase (message)
ListPurchasableSkusRequest.ChangeOfferPurchase.ChangeType (enum)
ListPurchasableSkusRequest.CreateEntitlementPurchase (message)
ListPurchasableSkusResponse (message)
ListReportsRequest (message) (deprecated)
ListReportsResponse (message) (deprecated)
ListSkuGroupBillableSkusRequest (message)
ListSkuGroupBillableSkusResponse (message)
ListSkuGroupsRequest (message)
ListSkuGroupsResponse (message)
ListSkusRequest (message)
ListSkusResponse (message)
ListSubscribersRequest (message)
ListSubscribersResponse (message)
ListTransferableOffersRequest (message)
ListTransferableOffersResponse (message)
ListTransferableSkusRequest (message)
ListTransferableSkusResponse (message)
LookupOfferRequest (message)
MarketingInfo (message)
Media (message)
MediaType (enum)
Offer (message)
OperationMetadata (message)
OperationMetadata.OperationType (enum)
Opportunity (message)
Opportunity.OpportunityType (enum)
Opportunity.Source (enum)
Opportunity.Stage (enum)
Opportunity.State (enum)
OpportunityEvent (message)
OpportunityEvent.Type (enum)
OpportunityInfo (message)
OpportunityInfo.ProductCategory (enum)
OpportunityInfo.ProductFamily (enum)
OpportunityLine (message)
OpportunityTeamMember (message)
OpportunityTeamMember.AccessLevel (enum)
Parameter (message)
ParameterDefinition (message)
ParameterDefinition.ParameterType (enum)
PartnerAdvantageInfo (message)
PartnerInfo (message)
PartnerInfo.IncentiveType (enum)
PartnerInfo.PartnerViewType (enum)
PaymentPlan (enum)
PaymentType (enum)
PercentageAdjustment (message)
Period (message)
PeriodType (enum)
Plan (message)
Price (message)
PriceByResource (message)
PricePhase (message)
PriceTier (message)
Product (message)
ProductAuthorization (message)
ProductAuthorization.AuthorizedProductFamily (enum)
ProductAuthorization.Region (enum)
ProductAuthorization.SellType (enum)
ProductAuthorization.State (enum)
PromotionalOrderType (enum)
ProvisionCloudIdentityRequest (message)
ProvisionableCloudIdentityType (message)
ProvisionableCloudIdentityType.Reason (enum)
ProvisionedService (message)
PurchasableOffer (message)
PurchasableSku (message)
PurchaseEligibility (message)
PurchaseEligibility.Reason (enum)
QualificationInfo (message)
QualificationInfo.Authority (enum)
QualificationInfo.Budget (enum)
QualificationInfo.DecisionPhase (enum)
QualificationInfo.Need (enum)
QualificationInfo.OperationType (enum)
QualificationInfo.Timeline (enum)
QueryEligibleBillingAccountsRequest (message)
QueryEligibleBillingAccountsResponse (message)
QueryOpportunitiesRequest (message)
QueryOpportunitiesResponse (message)
RebateExtension (message)
RebateExtension.ExtensionReason (enum)
RebateExtension.ExtensionRejectionReason (enum)
RebateExtension.ExtensionStatus (enum)
RebillingBasis (enum)
RegisterSubscriberRequest (message)
RegisterSubscriberResponse (message)
RenewalSettings (message)
RenewalSettings.PaymentOption (enum)
Report (message) (deprecated)
ReportJob (message) (deprecated)
ReportResultsMetadata (message) (deprecated)
ReportStatus (message) (deprecated)
ReportStatus.State (enum)
ReportValue (message) (deprecated)
RepricingAdjustment (message)
RepricingCondition (message)
RepricingConfig (message)
RepricingConfig.ChannelPartnerGranularity (message) (deprecated)
RepricingConfig.EntitlementGranularity (message)
ResourceType (enum)
Row (message) (deprecated)
RunReportJobRequest (message) (deprecated)
RunReportJobResponse (message) (deprecated)
SalesCycle (message)
SalesCycle.PartnerCloseStage (enum)
Sku (message)
SkuGroup (message)
SkuGroupCondition (message)
SkuPurchaseGroup (message)
StartPaidServiceRequest (message)
SubscriberEvent (message)
SuspendEntitlementRequest (message)
TransferEligibility (message)
TransferEligibility.Reason (enum)
TransferEntitlementsRequest (message)
TransferEntitlementsResponse (message)
TransferEntitlementsToGoogleRequest (message)
TransferableOffer (message)
TransferableSku (message)
TrialSettings (message)
UnregisterSubscriberRequest (message)
UnregisterSubscriberResponse (message)
UpdateChannelPartnerLinkRequest (message)
UpdateChannelPartnerRepricingConfigRequest (message)
UpdateCustomerRepricingConfigRequest (message)
UpdateCustomerRequest (message)
UpdateOpportunityRequest (message)
Value (message)
WinLossInfo (message)

CloudChannelReportsService

CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud, Google Voice, and Google Workspace.)

Deprecated: This service is being deprecated. Please use Export Channel Services data to BigQuery instead.

FetchReportResults

rpc FetchReportResults( FetchReportResultsRequest ) returns ( FetchReportResultsResponse )

Retrieves data generated by CloudChannelReportsService.RunReportJob .

Deprecated: Please use Export Channel Services data to BigQuery instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.reports.usage.readonly

For more information, see the Authentication Overview .

ListReports

rpc ListReports( ListReportsRequest ) returns ( ListReportsResponse )

Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

Deprecated: Please use Export Channel Services data to BigQuery instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.reports.usage.readonly

For more information, see the Authentication Overview .

RunReportJob

rpc RunReportJob( RunReportJobRequest ) returns ( Operation )

Begins generation of data for a given report. The report identifier is a UID (for example, 613bf59q ).

Possible error codes:

PERMISSION_DENIED: The user doesn't have access to this report.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The report identifier was not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata .

To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job .

Deprecated: Please use Export Channel Services data to BigQuery instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.reports.usage.readonly

For more information, see the Authentication Overview .

CloudChannelService

CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.

Using this service: 1. Resellers and distributors can manage a customer entity. 2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access. 3. Resellers and distributors can manage customer entitlements.

CloudChannelService exposes the following resources: - Customer s: An entity-usually an enterprise-managed by a reseller or distributor.

Entitlement s: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.
ChannelPartnerLink s: An entity that identifies links between distributors and their indirect resellers in a channel.

ActivateEntitlement

rpc ActivateEntitlement( ActivateEntitlementRequest ) returns ( Operation )

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.

An entitlement activation is a long-running operation and it updates the state of the customer entitlement.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

AssignChannelPartner

rpc AssignChannelPartner( AssignChannelPartnerRequest ) returns ( Entitlement )

Assigns a channel partner to an Entitlement resource. The assigned partner becomes the reseller for the entitlement and will gain delegated admin access to the customer's entitlement. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement or ChannelPartner resource not found. Usually because of an invalid channel_partner_id or entitlement name.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The Entitlement resource with an updated channel partner.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CancelEntitlement

rpc CancelEntitlement( CancelEntitlementRequest ) returns ( Operation )

Cancels a previously fulfilled entitlement.

An entitlement cancellation is a long-running operation.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangeOffer

rpc ChangeOffer( ChangeOfferRequest ) returns ( Operation )

Updates the Offer for an existing customer entitlement.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Offer or Entitlement resource not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangeParameters

rpc ChangeParameters( ChangeParametersRequest ) returns ( Operation )

Change parameters of the entitlement.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
NOT_FOUND: Entitlement resource not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangePlan

rpc ChangePlan( ChangePlanRequest ) returns ( Operation )

Updates the plan for an existing customer entitlement.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Offer or Entitlement resource not found.
INVALID_PLAN: Can't update a commitment based plan to a flex plan in the middle of the commitment period.
SKU_CHANGE_NOT_ALLOWED: OfferId pertains to a different SKU.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Deprecated: Use ChangeOffer instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangeQuantity

rpc ChangeQuantity( ChangeQuantityRequest ) returns ( Operation )

Updates the quantity for existing seat-based entitlements.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
SEAT_REDUCTION_NOT_ALLOWED: Can't decrease num_units for a commitment based plan in the middle of the commitment period.
SEATS_EXCEED_LIMIT: The number of seats being changed to is greater than the allowed number of max seats. This only applies to flex plans.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Deprecated: Use ChangeParameters instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangeRenewalSettings

rpc ChangeRenewalSettings( ChangeRenewalSettingsRequest ) returns ( Operation )

Updates the renewal settings for an existing customer entitlement.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ChangeSku

rpc ChangeSku( ChangeSkuRequest ) returns ( Operation )

Updates the SKU for an existing customer entitlement. This method creates a new entitlement for the modified SKU and cancels the original SKU's entitlement.

An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- The new offer's SKU doesn't belong to the same product family as the existing entitlement's SKU
- Can't upgrade or downgrade an annual commitment.
NOT_FOUND: Offer or Entitlement resource not found.
ALREADY_EXISTS: The new offer SKU already exists for the customer. Call the ChangePlan api if the new offer has the same product and SKU as the existing one.
INVALID_PLAN: If purchasing multiple SKUs of the same product family results in a upgrade, the plan based on the existing SKU is commitment-based and the commitment interval hasn't expired.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Deprecated: Use ChangeOffer instead.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CheckCloudIdentityAccountsExist

rpc CheckCloudIdentityAccountsExist( CheckCloudIdentityAccountsExistRequest ) returns ( CheckCloudIdentityAccountsExistResponse )

Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
INVALID_VALUE: Invalid domain value in the request.

Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty)

Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateChannelPartnerLink

rpc CreateChannelPartnerLink( CreateChannelPartnerLinkRequest ) returns ( ChannelPartnerLink )

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists.
NOT_FOUND: No Cloud Identity customer exists for provided domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The new ChannelPartnerLink resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateChannelPartnerRepricingConfig

rpc CreateChannelPartnerRepricingConfig( CreateChannelPartnerRepricingConfigRequest ) returns ( ChannelPartnerRepricingConfig )

Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month .

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any ChannelPartner or RepricingConfig.EntitlementGranularity.entitlement , for any RepricingConfig.effective_invoice_month .
The contained ChannelPartnerRepricingConfig.repricing_config value must be different from the value used in the current config for a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateCustomer

rpc CreateCustomer( CreateCustomerRequest ) returns ( Customer )

Creates a new Customer resource under the reseller or distributor account.

Possible error codes:

PERMISSION_DENIED:
- The reseller account making the request is different from the reseller account in the API request.
- You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Domain field value doesn't match the primary email domain.

Return value: The newly created Customer resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateCustomerRepricingConfig

rpc CreateCustomerRepricingConfig( CreateCustomerRepricingConfigRequest ) returns ( CustomerRepricingConfig )

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month .

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement , for any RepricingConfig.effective_invoice_month .
The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement .

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateEntitlement

rpc CreateEntitlement( CreateEntitlementRequest ) returns ( Operation )

Creates an entitlement for a customer.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- There is already a customer entitlement for a SKU from the same product family.
INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS:
- The SKU was already purchased for the customer.
- The customer's primary email already exists. Retry after changing the customer's primary contact email.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified.
- A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

CreateOpportunity

rpc CreateOpportunity( CreateOpportunityRequest ) returns ( Opportunity )

Creates a new Opportunity resource for a deal submission process. This can have the state DRAFT or SUBMITTED . Creating a SUBMITTED opportunity initiates an offline review process, in which Google determines whether it's ACCEPTED or REJECTED .

Possible error codes:

PERMISSION_DENIED: The user making the request isn't allowed to create an opportunity.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: The newly created Opportunity resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

DeleteChannelPartnerRepricingConfig

rpc DeleteChannelPartnerRepricingConfig( DeleteChannelPartnerRepricingConfigRequest ) returns ( Empty )

Deletes the given ChannelPartnerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past.
NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

DeleteCustomer

rpc DeleteCustomer( DeleteCustomerRequest ) returns ( Empty )

Deletes the given Customer permanently.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The customer has existing entitlements.
NOT_FOUND: No Customer resource found for the name in the request.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

DeleteCustomerRepricingConfig

rpc DeleteCustomerRepricingConfig( DeleteCustomerRepricingConfigRequest ) returns ( Empty )

Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past.
NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetChannelPartnerLink

rpc GetChannelPartnerLink( GetChannelPartnerLinkRequest ) returns ( ChannelPartnerLink )

Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name.

Return value: The ChannelPartnerLink resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetChannelPartnerRepricingConfig

rpc GetChannelPartnerRepricingConfig( GetChannelPartnerRepricingConfigRequest ) returns ( ChannelPartnerRepricingConfig )

Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetCustomer

rpc GetCustomer( GetCustomerRequest ) returns ( Customer )

Returns the requested Customer resource.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter.

Return value: The Customer resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetCustomerRepricingConfig

rpc GetCustomerRepricingConfig( GetCustomerRepricingConfigRequest ) returns ( CustomerRepricingConfig )

Gets information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetEntitlement

rpc GetEntitlement( GetEntitlementRequest ) returns ( Entitlement )

Returns the requested Entitlement resource.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer entitlement was not found.

Return value: The requested Entitlement resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

GetOpportunity

rpc GetOpportunity( GetOpportunityRequest ) returns ( Opportunity )

Returns the requested Opportunity resource.

Possible error codes:

PERMISSION_DENIED: The user making the request isn't allowed to view the opportunity.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: No Opportunity resource found for the name in the request.

Return value: The Opportunity resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ImportCustomer

rpc ImportCustomer( ImportCustomerRequest ) returns ( Customer )

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.

Possible error codes:

PERMISSION_DENIED:
- The reseller account making the request is different from the reseller account in the API request.
- You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265
NOT_FOUND: Cloud Identity doesn't exist or was deleted.
INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.

Return value: The Customer .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListChannelPartnerLinks

rpc ListChannelPartnerLinks( ListChannelPartnerLinksRequest ) returns ( ListChannelPartnerLinksResponse )

List ChannelPartnerLink s belonging to a distributor. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: The list of the distributor account's ChannelPartnerLink resources.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListChannelPartnerRepricingConfigs

rpc ListChannelPartnerRepricingConfigs( ListChannelPartnerRepricingConfigsRequest ) returns ( ListChannelPartnerRepricingConfigsResponse )

Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

Channel Partner ID
RepricingConfig.effective_invoice_month
ChannelPartnerRepricingConfig.update_time

If unsuccessful, returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListCustomerRepricingConfigs

rpc ListCustomerRepricingConfigs( ListCustomerRepricingConfigsRequest ) returns ( ListCustomerRepricingConfigsResponse )

Lists information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

Customer ID
RepricingConfig.EntitlementGranularity.entitlement
RepricingConfig.effective_invoice_month
CustomerRepricingConfig.update_time

If unsuccessful, returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListCustomers

rpc ListCustomers( ListCustomersRequest ) returns ( ListCustomersResponse )

List Customer s.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: List of Customer s, or an empty list if there are no customers.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListEntitlementChanges

rpc ListEntitlementChanges( ListEntitlementChangesRequest ) returns ( ListEntitlementChangesResponse )

List entitlement history.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
INVALID_ARGUMENT: Missing or invalid required fields in the request.
NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return value: List of EntitlementChange s.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListEntitlements

rpc ListEntitlements( ListEntitlementsRequest ) returns ( ListEntitlementsResponse )

Lists Entitlement s belonging to a customer.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: A list of the customer's Entitlement s.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListOffers

rpc ListOffers( ListOffersRequest ) returns ( ListOffersResponse )

Lists the Offers the reseller can sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListProducts

rpc ListProducts( ListProductsRequest ) returns ( ListProductsResponse )

Lists the Products the reseller is authorized to sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListProvisionableCloudIdentityTypes

rpc ListProvisionableCloudIdentityTypes( ListProvisionableCloudIdentityTypesRequest ) returns ( ListProvisionableCloudIdentityTypesResponse )

Returns the Google Workspace customer types you can create for the given domain, and shows if this requires a transfer.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request cannot edit this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListPurchasableOffers

rpc ListPurchasableOffers( ListPurchasableOffersRequest ) returns ( ListPurchasableOffersResponse )

Lists the following:

Offers that you can purchase for a customer.
Offers that you can change for an entitlement.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListPurchasableSkus

rpc ListPurchasableSkus( ListPurchasableSkusRequest ) returns ( ListPurchasableSkusResponse )

Lists the following:

SKUs that you can purchase for a customer
SKUs that you can upgrade or downgrade for an entitlement.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListSkuGroupBillableSkus

rpc ListSkuGroupBillableSkus( ListSkuGroupBillableSkusRequest ) returns ( ListSkuGroupBillableSkusResponse )

Lists the Billable SKUs in a given SKU group.

Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.

Return Value: If successful, the BillableSku resources. The data for each resource is displayed in the ascending order of:

BillableSku.service_display_name
BillableSku.sku_display_name

If unsuccessful, returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListSkuGroups

rpc ListSkuGroups( ListSkuGroupsRequest ) returns ( ListSkuGroupsResponse )

Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the SkuGroup resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of SkuGroup.display_name

If unsuccessful, returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListSkus

rpc ListSkus( ListSkusRequest ) returns ( ListSkusResponse )

Lists the SKUs for a product the reseller is authorized to sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListSubscribers

rpc ListSubscribers( ListSubscribersRequest ) returns ( ListSubscribersResponse )

Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The topic resource doesn't exist.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: A list of service email addresses.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListTransferableOffers

rpc ListTransferableOffers( ListTransferableOffersRequest ) returns ( ListTransferableOffersResponse )

List TransferableOffer s of a customer based on Cloud Identity ID or Customer Name in the request.

Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The customer provided incorrect reseller information when generating auth token.
- The reseller account making the request is different from the reseller account in the query.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: List of TransferableOffer for the given customer and SKU.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ListTransferableSkus

rpc ListTransferableSkus( ListTransferableSkusRequest ) returns ( ListTransferableSkusResponse )

List TransferableSku s of a customer based on the Cloud Identity ID or Customer Name in the request.

Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from the reseller account in the query.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: A list of the customer's TransferableSku .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

LookupOffer

rpc LookupOffer( LookupOfferRequest ) returns ( Offer )

Returns the requested Offer resource.

Possible error codes:

PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement or offer was not found.

Return value: The Offer resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ProvisionCloudIdentity

rpc ProvisionCloudIdentity( ProvisionCloudIdentityRequest ) returns ( Operation )

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer was not found.
ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

QueryEligibleBillingAccounts

rpc QueryEligibleBillingAccounts( QueryEligibleBillingAccountsRequest ) returns ( QueryEligibleBillingAccountsResponse )

Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

QueryOpportunities

rpc QueryOpportunities( QueryOpportunitiesRequest ) returns ( QueryOpportunitiesResponse )

Query Opportunity s associated with a specific Partner.

Possible error codes:

PERMISSION_DENIED: The user making the request isn't allowed to list opportunities associated with the given partner.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: Opportunity s the user has access to, or an empty list if there are no opportunities.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

RegisterSubscriber

rpc RegisterSubscriber( RegisterSubscriberRequest ) returns ( RegisterSubscriberResponse )

Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The topic name with the registered service email address.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

StartPaidService

rpc StartPaidService( StartPaidServiceRequest ) returns ( Operation )

Starts paid service for a trial entitlement.

Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

SuspendEntitlement

rpc SuspendEntitlement( SuspendEntitlementRequest ) returns ( Operation )

Suspends a previously fulfilled entitlement.

An entitlement suspension is a long-running operation.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
NOT_ACTIVE: Entitlement is not active.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

TransferEntitlements

rpc TransferEntitlements( TransferEntitlementsRequest ) returns ( Operation )

Transfers customer entitlements to new reseller.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS: The SKU was already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
- Specify all transferring entitlements.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

TransferEntitlementsToGoogle

rpc TransferEntitlementsToGoogle( TransferEntitlementsToGoogleRequest ) returns ( Operation )

Transfers customer entitlements from their current reseller to Google.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS: The SKU was already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UnregisterSubscriber

rpc UnregisterSubscriber( UnregisterSubscriberRequest ) returns ( UnregisterSubscriberResponse )

Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The topic resource doesn't exist.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UpdateChannelPartnerLink

rpc UpdateChannelPartnerLink( UpdateChannelPartnerLinkRequest ) returns ( ChannelPartnerLink )

Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Link state cannot change from invited to active or suspended.
- Cannot send reseller_cloud_identity_id, invite_url, or name in update mask.
NOT_FOUND: ChannelPartnerLink resource not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The updated ChannelPartnerLink resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UpdateChannelPartnerRepricingConfig

rpc UpdateChannelPartnerRepricingConfig( UpdateChannelPartnerRepricingConfigRequest ) returns ( ChannelPartnerRepricingConfig )

Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.

You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig , taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month .

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UpdateCustomer

rpc UpdateCustomer( UpdateCustomerRequest ) returns ( Customer )

Updates an existing Customer resource for the reseller or distributor.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: No Customer resource found for the name in the request.

Return value: The updated Customer resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UpdateCustomerRepricingConfig

rpc UpdateCustomerRepricingConfig( UpdateCustomerRepricingConfigRequest ) returns ( CustomerRepricingConfig )

Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.

You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig , taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month .

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

UpdateOpportunity

rpc UpdateOpportunity( UpdateOpportunityRequest ) returns ( Opportunity )

Updates an existing Opportunity resource.

DRAFT / REJECTED : All fields for a DRAFT or REJECTED Opportunity can be edited.
SUBMITTED : You can't make further updates to a SUBMITTED Opportunity.
ACCEPTED : You can update some, but not all, of the fields for an ACCEPTED opportunity.

Possible error codes:

PERMISSION_DENIED: The user making the request isn't allowed to update the opportunity.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: No Opportunity resource found for the name in the request.

Return value: The updated Opportunity resource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview .

ActivateEntitlementRequest

Request message for CloudChannelService.ActivateEntitlement .

Fields

Fields
`name`	`string` Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`request_id`	`string` 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` ).

name

string

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

external_correlation_id

string

Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.

request_id

string

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

AdminUser

Information needed to create an Admin User for Google Workspace.

Fields

Fields
`email`	`string` Primary email of the admin user.
`given_name`	`string` Given name of the admin user.
`family_name`	`string` Family name of the admin user.

email

string

Primary email of the admin user.

given_name

string

Given name of the admin user.

family_name

string

Family name of the admin user.

AssignChannelPartnerRequest

Request message for CloudChannelService.AssignChannelPartner .

Fields

Fields
`name`	`string` Required. The resource name of the entitlement to assign. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`enable_delegated_admin`	`bool` Optional. If true, grants delegated admin rights to the channel partner for fulfilled entitlements. Applicable only if you provide a channel_partner_id.
`channel_partner_id`	`string` Required. Cloud Identity ID of the channel partner who will be the indirect reseller for the customer's entitlement. An indirect reseller needs to accept an invitation from the top-level distributor, sent by calling `CloudChannelService.CreateChannelPartnerLink` . This field is used in 2-tier entitlement purchases, where the purchase is placed by a top-level distributor on behalf of their indirect reseller. Cost allocation for this entitlement can be done for the partner in reports, and the indirect reseller will have delegated admin access to the customer. Required for entitlement purchases for a distributor account only. If there is no partner to assign to this customer, use the distributor's own Cloud Identity ID.

name

string

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

enable_delegated_admin

bool

Optional. If true, grants delegated admin rights to the channel partner for fulfilled entitlements. Applicable only if you provide a channel_partner_id.

channel_partner_id

string

Required. Cloud Identity ID of the channel partner who will be the indirect reseller for the customer's entitlement. An indirect reseller needs to accept an invitation from the top-level distributor, sent by calling CloudChannelService.CreateChannelPartnerLink . This field is used in 2-tier entitlement purchases, where the purchase is placed by a top-level distributor on behalf of their indirect reseller. Cost allocation for this entitlement can be done for the partner in reports, and the indirect reseller will have delegated admin access to the customer. Required for entitlement purchases for a distributor account only. If there is no partner to assign to this customer, use the distributor's own Cloud Identity ID.

AssociationInfo

Association links that an entitlement has to other entitlements.

Fields

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

base_entitlement

string

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

BillableSku

Represents the Billable SKU information.

Fields
`sku`	`string` Resource name of Billable SKU. Format: billableSkus/{sku}. Example: billableSkus/6E1B-6634-470F".
`sku_display_name`	`string` Unique human readable name for the SKU.
`service`	`string` Resource name of Service which contains Repricing SKU. Format: services/{service}. Example: "services/B7D9-FDCB-15D8".
`service_display_name`	`string` Unique human readable name for the Service.

BillingAccount

Represents a billing account.

Fields
`name`	`string` Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.
`display_name`	`string` Display name of the billing account.
`create_time`	`Timestamp` Output only. The time when this billing account was created.
`currency_code`	`string` Output only. The 3-letter currency code defined in ISO 4217.
`region_code`	`string` Output only. The CLDR region code.

BillingAccountPurchaseInfo

Represents a billing account that can be used to make a purchase.

Fields

Fields
`billing_account`	`BillingAccount` The billing account resource.

billing_account

BillingAccount

The billing account resource.

CancelEntitlementRequest

Request message for CloudChannelService.CancelEntitlement .

Fields

Fields
`name`	`string` Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`request_id`	`string` 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` ).

name

string

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

external_correlation_id

string

Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.

request_id

string

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.

The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000 ).

ChangeOfferRequest

Request message for CloudChannelService.ChangeOffer .

Fields
`name`	`string` Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`offer`	`string` Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}.
`parameters[]`	`Parameter` Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the `Offer.parameter_definitions` from the desired offer.
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`purchase_order_id`	`string` Optional. Purchase order id provided by the reseller.
`request_id`	`string` 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` ).
`billing_account`	`string` Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
`price_reference_id`	`string` Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.

ChangeParametersRequest

Request message for CloudChannelService.ChangeParameters .

Fields
`name`	`string` Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`parameters[]`	`Parameter` Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the `Offer.parameter_definitions` from the desired offer.
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`request_id`	`string` 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` ).
`purchase_order_id`	`string` Optional. Purchase order ID provided by the reseller.

ChangePlanRequest

Request message for CloudChannelService.ChangePlan .

Fields
`name`	`string` Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`offer`	`string` Required. New Offer applicable to a new plan. The offer takes the form: accounts/{account_id}/offers/{offer_id}.
`num_units`	`int32` New num units for the entitlement. For seat-based offers, this is the number of seats. For license based offers, this is the number of licenses. Required for commitment based offers.
`max_units`	`int32` New max units for the entitlement. It represents the maximum units a flexible offer is allowed to assign. Required for flexible offers.
`external_correlation_id`	`string` An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement. Optional.
`purchase_order_id`	`string` Purchase order ID provided by the reseller. Optional
`request_id`	`string` 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` ).
`billing_account`	`string` Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.

ChangeQuantityRequest

Request message for [CloudChannelService.ChangeQuantityRequest][].

Fields
`name`	`string` Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`num_units`	`int32` New num units for the entitlement. For seat-based offers, this is the number of seats. For license based offers, this is the number of licenses. Required for commitment based offers.
`max_units`	`int32` New max units for the entitlement. It represents the maximum units a flexible offer is allowed to assign. Required for flexible offers.
`external_correlation_id`	`string` An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement. Optional.
`request_id`	`string` 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` ).
`purchase_order_id`	`string` Optional. Purchase order ID provided by the reseller. Optional.

ChangeRenewalSettingsRequest

Request message for CloudChannelService.ChangeRenewalSettings .

Fields
`name`	`string` Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`renewal_settings`	`RenewalSettings` Required. New renewal settings.
`request_id`	`string` 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` ).

ChangeSkuRequest

Request message for CloudChannelService.ChangeSku .

Fields
`name`	`string` Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`offer`	`string` Required. New Offer applicable to a new SKU. The offer takes the form: accounts/{account_id}/offers/{offer_id}.
`external_correlation_id`	`string` An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement. Optional.
`num_units`	`int32` New num units for the entitlement. For seat-based offers, this is the number of seats. For license based offers, this is the number of licenses. Required for commitment based offers.
`max_units`	`int32` New max units for the entitlement. It represents the maximum units a flexible offer is allowed to assign. Required for flexible offers.
`purchase_order_id`	`string` Purchase order ID provided by the reseller. Optional
`request_id`	`string` 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` ).
`billing_account`	`string` Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.

ChannelPartnerEvent

Represents Pub/Sub messages about updates to a Channel Partner. You can retrieve updated values through the ChannelPartnerLinks API.

Fields

Fields
`channel_partner`	`string` Resource name for the Channel Partner Link. Channel_partner uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
`event_type`	`Type` Type of event which happened for the channel partner.

channel_partner

string

Resource name for the Channel Partner Link. Channel_partner uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

event_type

Type

Type of event which happened for the channel partner.

Type

Type of Channel Partner event.

Enums
`TYPE_UNSPECIFIED`	Default value. Does not display if there are no errors.
`LINK_STATE_CHANGED`	The Channel Partner link state changed.
`PARTNER_ADVANTAGE_INFO_CHANGED`	The Channel Partner's Partner Advantage information changed. This can entail the Channel Partner's authorization to sell a product in a particular region.

ChannelPartnerLink

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

Fields
`name`	`string` Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
`reseller_cloud_identity_id`	`string` Required. Cloud Identity ID of the linked reseller.
`link_state`	`ChannelPartnerLinkState` Required. State of the channel partner link.
`invite_link_uri`	`string` Output only. URI of the web page where partner accepts the link invitation.
`create_time`	`Timestamp` Output only. Timestamp of when the channel partner link is created.
`update_time`	`Timestamp` Output only. Timestamp of when the channel partner link is updated.
`public_id`	`string` Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
`channel_partner_cloud_identity_info`	`CloudIdentityInfo` Output only. Cloud Identity info of the channel partner (IR).
`partner_advantage_info`	`PartnerAdvantageInfo` Output only. Partner Advantage information for this Channel Partner (IR).

ChannelPartnerLinkState

ChannelPartnerLinkState represents state of a channel partner link.

Enums
`CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED`	Not used.
`INVITED`	An invitation has been sent to the reseller to create a channel partner link.
`ACTIVE`	Status when the reseller is active.
`REVOKED`	Status when the reseller has been revoked by the distributor.
`SUSPENDED`	Status when the reseller is suspended by Google or distributor.

ChannelPartnerLinkView

The level of granularity the ChannelPartnerLink will display.

Enums
`UNSPECIFIED`	The default / unset value. The API will default to the BASIC view.
`BASIC`	Includes all fields except the `ChannelPartnerLink.channel_partner_cloud_identity_info` .
`FULL`	Includes all fields.

ChannelPartnerRepricingConfig

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Fields

Fields
`name`	`string` Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.
`repricing_config`	`RepricingConfig` Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner.
`update_time`	`Timestamp` Output only. Timestamp of an update to the repricing rule. If `update_time` is after `RepricingConfig.effective_invoice_month` then it indicates this was set mid-month.

name

string

Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.

repricing_config

RepricingConfig

Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner.

update_time

Timestamp

Output only. Timestamp of an update to the repricing rule. If update_time is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.

CheckCloudIdentityAccountsExistRequest

Request message for CloudChannelService.CheckCloudIdentityAccountsExist .

Fields

Fields
`parent`	`string` Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}
`domain`	`string` Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails.
`primary_admin_email`	`string` Optional. Primary admin email to fetch for Cloud Identity account team customer.

parent

string

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

domain

string

Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails.

primary_admin_email

string

Optional. Primary admin email to fetch for Cloud Identity account team customer.

CheckCloudIdentityAccountsExistResponse

Response message for CloudChannelService.CheckCloudIdentityAccountsExist .

Fields

Fields
`cloud_identity_accounts[]`	`CloudIdentityCustomerAccount` The Cloud Identity accounts associated with the domain.

cloud_identity_accounts[]

CloudIdentityCustomerAccount

The Cloud Identity accounts associated with the domain.

CloudIdentityCustomerAccount

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

Fields
`existing`	`bool` Returns true if a Cloud Identity account exists for a specific domain.
`owned`	`bool` Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner (with active subscriptions or purchase consents).
`customer_name`	`string` 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}
`customer_cloud_identity_id`	`string` If existing = true, the Cloud Identity ID of the customer.
`customer_type`	`CustomerType` If existing = true, the type of the customer.
`channel_partner_cloud_identity_id`	`string` If existing = true, and is 2-tier customer, the channel partner of the customer.

CloudIdentityInfo

Cloud Identity information for the Cloud Channel Customer.

Fields
`customer_type`	`CustomerType` CustomerType indicates verification type needed for using services.
`primary_domain`	`string` Output only. The primary domain name.
`is_domain_verified`	`bool` 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.
`alternate_email`	`string` The alternate email.
`phone_number`	`string` Phone number associated with the Cloud Identity.
`language_code`	`string` Language code.
`admin_console_uri`	`string` Output only. URI of Customer's Admin console dashboard.
`edu_data`	`EduData` Edu information about the customer.

CustomerType

CustomerType of the customer

Enums
`CUSTOMER_TYPE_UNSPECIFIED`	Not used.
`DOMAIN`	Domain-owning customer which needs domain verification to use services.
`TEAM`	Team customer which needs email verification to use services.

Column

The definition of a report column. Specifies the data properties in the corresponding position of the report rows.

Fields

Fields
`column_id`	`string` The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in `RunReportJobRequest.filter` . To see all reports and their columns, call `CloudChannelReportsService.ListReports` .
`display_name`	`string` The column's display name.
`data_type`	`DataType` The type of the values for this column.

column_id

string

The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter . To see all reports and their columns, call CloudChannelReportsService.ListReports .

display_name

string

The column's display name.

data_type

DataType

The type of the values for this column.

DataType

Available data types for columns. Corresponds to the fields in the ReportValue oneof field.

Enums
`DATA_TYPE_UNSPECIFIED`	Not used.
`STRING`	ReportValues for this column will use string_value.
`INT`	ReportValues for this column will use int_value.
`DECIMAL`	ReportValues for this column will use decimal_value.
`MONEY`	ReportValues for this column will use money_value.
`DATE`	ReportValues for this column will use date_value.
`DATE_TIME`	ReportValues for this column will use date_time_value.

CommitmentSettings

Commitment settings for commitment-based offers.

Fields

Fields
`start_time`	`Timestamp` Output only. Commitment start timestamp.
`end_time`	`Timestamp` Output only. Commitment end timestamp.
`renewal_settings`	`RenewalSettings` Optional. Renewal settings applicable for a commitment-based Offer.

start_time

Timestamp

Output only. Commitment start timestamp.

end_time

Timestamp

Output only. Commitment end timestamp.

renewal_settings

RenewalSettings

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

ConditionalOverride

Specifies the override to conditionally apply.

Fields

Fields
`adjustment`	`RepricingAdjustment` Required. Information about the applied override's adjustment.
`rebilling_basis`	`RebillingBasis` Required. The `RebillingBasis` to use for the applied override. Shows the relative cost based on your repricing costs.
`repricing_condition`	`RepricingCondition` Required. Specifies the condition which, if met, will apply the override.

adjustment

RepricingAdjustment

Required. Information about the applied override's adjustment.

rebilling_basis

RebillingBasis

Required. The RebillingBasis to use for the applied override. Shows the relative cost based on your repricing costs.

repricing_condition

RepricingCondition

Required. Specifies the condition which, if met, will apply the override.

Constraints

Represents the constraints for buying the Offer.

Fields

Fields
`customer_constraints`	`CustomerConstraints` Represents constraints required to purchase the Offer for a customer.

customer_constraints

CustomerConstraints

Represents constraints required to purchase the Offer for a customer.

Contact

Contact Details.

Fields
`given_name`	`string` Required. Contact's first name.
`family_name`	`string` Required. Contact's last name.
`email`	`string` Required. Email.
`phone`	`PhoneNumber` Optional. Phone number. Only supports setting `e164_number` .

ContactInfo

Contact information for a customer account.

Fields
`first_name`	`string` The customer account contact's first name. Optional for Team customers.
`last_name`	`string` The customer account contact's last name. Optional for Team customers.
`display_name`	`string` Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.
`email`	`string` 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.
`title`	`string` Optional. The customer account contact's job title.
`phone`	`string` The customer account's contact phone number.

CreateChannelPartnerLinkRequest

Request message for CloudChannelService.CreateChannelPartnerLink

Fields

Fields
`parent`	`string` Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id}
`channel_partner_link`	`ChannelPartnerLink` Required. The channel partner link to create. Either channel_partner_link.reseller_cloud_identity_id or domain can be used to create a link.
`domain (deprecated)`	`string` This item is deprecated! Optional. The invited partner's domain. Either domain or channel_partner_link.reseller_cloud_identity_id can be used to create a link. Deprecated: Use `ChannelPartnerLink.reseller_cloud_identity_id` instead

parent

string

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

channel_partner_link

ChannelPartnerLink

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

domain
 (deprecated)

string

Optional. The invited partner's domain. Either domain or channel_partner_link.reseller_cloud_identity_id can be used to create a link. Deprecated: Use ChannelPartnerLink.reseller_cloud_identity_id instead

CreateChannelPartnerRepricingConfigRequest

Request message for CloudChannelService.CreateChannelPartnerRepricingConfig .

Fields

Fields
`parent`	`string` Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
`channel_partner_repricing_config`	`ChannelPartnerRepricingConfig` Required. The ChannelPartnerRepricingConfig object to update.

parent

string

Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

channel_partner_repricing_config

ChannelPartnerRepricingConfig

Required. The ChannelPartnerRepricingConfig object to update.

CreateCustomerRepricingConfigRequest

Request message for CloudChannelService.CreateCustomerRepricingConfig .

Fields

Fields
`parent`	`string` Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}
`customer_repricing_config`	`CustomerRepricingConfig` Required. The CustomerRepricingConfig object to update.

parent

string

Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}

customer_repricing_config

CustomerRepricingConfig

Required. The CustomerRepricingConfig object to update.

CreateCustomerRequest

Request message for CloudChannelService.CreateCustomer

Fields

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

parent

string

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

customer

Customer

Required. The customer to create.

CreateEntitlementRequest

Request message for CloudChannelService.CreateEntitlement

Fields
`parent`	`string` 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}
`entitlement`	`Entitlement` Required. The entitlement to create.
`enable_delegated_admin (deprecated)`	`bool` This item is deprecated! Optional. If true, grants delegated admin rights to the channel partner for fulfilled entitlements. Applicable only if you provide `Entitlement.channel_partner_id` . Deprecated.
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`request_id`	`string` 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` ).
`cloud_identity_info (deprecated)`	`CloudIdentityInfo` This item is deprecated! Optional Cloud Identity information for the customer. Used when placing the first order for Cloud Identity and Google Workspace products. Defaults to DOMAIN customer_type. Deprecated: Call `ProvisionCloudIdentity` before creating an entitlement.

CreateOpportunityRequest

Request message for CloudChannelService.CreateOpportunity

Fields

Fields
`opportunity`	`Opportunity` Required. The opportunity to create.

opportunity

Opportunity

Required. The opportunity to create.

Customer

Entity representing a customer of a reseller or distributor.

Fields
`name`	`string` Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
`org_display_name`	`string` Required. Name of the organization that the customer entity represents.
`org_postal_address`	`PostalAddress` Required. The organization address for the customer. To enforce US laws and embargoes, we require a region, postal code, and address lines. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
`primary_contact_info`	`ContactInfo` Primary contact info.
`alternate_email`	`string` 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.
`domain`	`string` Required. The customer's primary domain. Must match the primary contact email's domain.
`create_time`	`Timestamp` Output only. Time when the customer was created.
`update_time`	`Timestamp` Output only. Time when the customer was updated.
`cloud_identity_id`	`string` Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
`language_code`	`string` 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 .
`admin_console_url (deprecated)`	`string` This item is deprecated! Output only. URL of Customer's Admin console dashboard. Populated only if a Cloud Identity resource exists for this customer. Deprecated: Use `CloudIdentityInfo.admin_console_uri` instead.
`cloud_identity_info`	`CloudIdentityInfo` Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.
`channel_partner_id`	`string` Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.
`correlation_id`	`string` Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer.
`customer_attestation_state`	`CustomerAttestationState` Optional. Indicate if a customer is attesting about the correctness of provided information. Only required if creating a GCP Entitlement.

CustomerAttestationState

The enum represents if a customer belongs to public sector

Enums
`CUSTOMER_ATTESTATION_STATE_UNSPECIFIED`	Default value if not set yet
`EXEMPT`	Customer is exempt from attesting based on exemption list at https://cloud.google.com/terms/direct-tos-exemptions . Contact information of customer will be mandatory.
`NON_EXEMPT_AND_INFO_VERIFIED`	Customer is not exempt and has verified the information provided is correct. Contact information of customer will be mandatory.

CustomerConstraints

Represents constraints required to purchase the Offer for a customer.

Fields

Fields
`allowed_regions[]`	`string` Allowed geographical regions of the customer.
`allowed_customer_types[]`	`CustomerType` Allowed Customer Type.
`promotional_order_types[]`	`PromotionalOrderType` Allowed Promotional Order Type. Present for Promotional offers.

allowed_regions[]

string

Allowed geographical regions of the customer.

allowed_customer_types[]

CustomerType

Allowed Customer Type.

promotional_order_types[]

PromotionalOrderType

Allowed Promotional Order Type. Present for Promotional offers.

CustomerContact

Customer Contact.

Fields
`given_name`	`string` Output only. Contact First Name.
`family_name`	`string` Output only. Contact Last Name.
`title`	`string` Output only. Contact Title.
`role`	`Role` Output only. Contact Role.
`primary`	`bool` Output only. Is Primary contact for this Opportunity?

Role

Customer Contact Role.

Enums
`ROLE_UNSPECIFIED`	Not used.
`OTHER_ROLE`	Other role.
`ADMIN`	Administrator.
`BILLING_CONTACT`	Billing Contact.
`BUSINESS_DECISION_MAKER`	Business Decision Maker.
`BUSINESS_USER`	Business User.
`CHANGE_CHAMPION`	Change Champion.
`CHRONICLE_SIEM_CONTACT`	Chronicle SIEM Contact.
`CHRONICLE_SOAR_CONTACT`	Chronicle SOAR Contact.
`ECONOMIC_BUYER`	Economic Buyer.
`EVALUATOR`	Evaluator.
`EXECUTIVE_SPONSOR`	Executive Sponsor.
`INFLUENCER`	Influencer.
`MAIN_DECISION_MAKER`	Main Decision Maker.
`ORDERING_CONTACT`	Ordering Contact.
`PRODUCT_CONTACT`	Product Contact.
`TECH_CONTACT`	Technical Contact.
`TECH_DECISION_MAKER`	Technical Decision Maker.

CustomerDetails

Customer details used to create a new customer or map to existing customers.

Fields
`organization_name`	`string` Required. Name of the Customer Organization. Available in Limited view.
`domain`	`string` Required. Customer's primary website domain. Available in Limited view.
`address`	`PostalAddress` Required. Customer address.
`industry`	`Industry` Required. Customer's Primary Industry.
`employee_count`	`int32` Required. Workforce size.

Industry

Industry.

Enums
`INDUSTRY_UNSPECIFIED`	Not used.
`ADVERTISING_MARKETING`	Advertising & Marketing.
`AGRICULTURE`	Agriculture
`AUTOMOTIVE`	Automotive.
`BUSINESS_SERVICES`	Business & Professional Services.
`CONSUMER_GOODS`	Consumer Packaged Goods.
`EDUCATION`	Education.
`ELECTRICAL_ELECTRONICS`	Electrical & Electronics.
`ENERGY`	Energy & Utilities.
`FINANCIAL_SERVICES`	Financial Services.
`FOOD`	Food, Beverage & Restaurants.
`GAMING`	Gaming.
`HEALTHCARE`	Healthcare & Life Sciences.
`INDUSTRIAL_GOODS`	Industrial Goods & Manufacturing.
`GOVERNMENT`	Government.
`LOGISTICS`	Logistics.
`MANUFACTURING`	Manufacturing & Industrial.
`MEDIA`	Media & Entertainment.
`NON_PROFIT`	Non-Profit.
`OTHER`	Other.
`PUBLIC_SECTOR`	Public Sector & EDU.
`RETAIL_CONSUMER`	Retail & Consumer.
`RETAIL_WHOLESALE`	Retail & Wholesale.
`SOFTWARE`	Software & Internet.
`TELECOMMUNICATIONS`	Telecommunications.
`TELECOMMUNICATIONS_MEDIA`	Telecommunications, Media & Gaming.
`TOURISM`	Tourism & Leisure.

CustomerEvent

Represents Pub/Sub message content describing customer update.

Fields

Fields
`customer`	`string` Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
`event_type`	`Type` Type of event which happened for the customer.

customer

string

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

event_type

Type

Type of event which happened for the customer.

Type

Type of customer event.

Enums
`TYPE_UNSPECIFIED`	Not used.
`PRIMARY_DOMAIN_CHANGED`	Primary domain for customer was changed.
`PRIMARY_DOMAIN_VERIFIED`	Primary domain of the customer has been verified.

CustomerInfo

Customer Information provided during Opportunity Creation

Fields

Fields
`customer_details`	`CustomerDetails` Required. Firm details needed for creating a new customer or for mapping to an existing customer. Available in Limited view.
`contact`	`Contact` Optional. Primary Customer contact that will be added to the Opportunity Contact Roles.
`region`	`Region` Required. Geographical region where end customer is located Note: Partner needs to have Sell authorization in this region to qualify for deal registration incentives.

customer_details

CustomerDetails

Required. Firm details needed for creating a new customer or for mapping to an existing customer. Available in Limited view.

contact

Contact

Optional. Primary Customer contact that will be added to the Opportunity Contact Roles.

region

Region

Required. Geographical region where end customer is located Note: Partner needs to have Sell authorization in this region to qualify for deal registration incentives.

Region

Geographical region where end customer is located

Enums
`REGION_UNSPECIFIED`	Default value. Does not display if there are no errors.
`ANZ`	Australia & New Zealand
`CEE`	Central & Eastern Europe
`DACH`	Germany, Austria, & Switzerland
`FRANCE`	France
`INDIA`	India
`JAPAN`	Japan
`LATAM_BRAZIL`	LATAM - Brazil
`LATAM_SPANISH_SPEAKING`	LATAM - Spanish speaking
`NE`	Northern Europe
`NORTH_AMERICA`	North America
`OTHER_ASIA_PACIFIC`	Other Asia Pacific
`SEEMEA`	Southern Europe and Emerging Markets
`UK_AND_I`	UK & Ireland

CustomerRepricingConfig

Configuration for how a reseller will reprice a Customer.

Fields

Fields
`name`	`string` Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.
`repricing_config`	`RepricingConfig` Required. The configuration for bill modifications made by a reseller before sending it to customers.
`update_time`	`Timestamp` Output only. Timestamp of an update to the repricing rule. If `update_time` is after `RepricingConfig.effective_invoice_month` then it indicates this was set mid-month.

name

string

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

repricing_config

RepricingConfig

Required. The configuration for bill modifications made by a reseller before sending it to customers.

update_time

Timestamp

Output only. Timestamp of an update to the repricing rule. If update_time is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.

DateRange

A representation of usage or invoice date ranges.

Fields
`usage_start_date_time`	`DateTime` The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
`usage_end_date_time`	`DateTime` The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.
`invoice_start_date`	`Date` The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month.
`invoice_end_date`	`Date` The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month.

DeleteChannelPartnerRepricingConfigRequest

Request message for DeleteChannelPartnerRepricingConfig.

Fields

name

string

Required. The resource name of the channel partner repricing config rule to delete.

DeleteCustomerRepricingConfigRequest

Request message for CloudChannelService.DeleteCustomerRepricingConfig .

Fields

name

string

Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

DeleteCustomerRequest

Request message for CloudChannelService.DeleteCustomer .

Fields

name

string

Required. The resource name of the customer to delete.

DiscountComponent

Represents a single component of the total discount applicable on a Price.

Fields

discount_type

DiscountType

Type of the discount.

Union field discount_value . Specifies the contribution of this discount component to the total discount. discount_value can be only one of the following:

discount_percentage

double

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

discount_absolute

Money

Fixed value discount.

DiscountType

Discount Type.

Enums
`DISCOUNT_TYPE_UNSPECIFIED`	Not used.
`REGIONAL_DISCOUNT`	Regional discount.
`PROMOTIONAL_DISCOUNT`	Promotional discount.
`SALES_DISCOUNT`	Sales-provided discount.
`RESELLER_MARGIN`	Reseller margin.
`DEAL_CODE`	Deal code discount.

EduData

Required Edu Attributes

Fields

institute_type

InstituteType

Designated institute type of customer.

institute_size

InstituteSize

Size of the institute.

website

string

Web address for the edu customer's institution.

InstituteSize

Number of students and staff the institute has.

Enums
`INSTITUTE_SIZE_UNSPECIFIED`	Not used.
`SIZE_1_100`	1 - 100
`SIZE_101_500`	101 - 500
`SIZE_501_1000`	501 - 1,000
`SIZE_1001_2000`	1,001 - 2,000
`SIZE_2001_5000`	2,001 - 5,000
`SIZE_5001_10000`	5,001 - 10,000
`SIZE_10001_OR_MORE`	10,001 +

InstituteType

Enum to specify the institute type.

Enums
`INSTITUTE_TYPE_UNSPECIFIED`	Not used.
`K12`	Elementary/Secondary Schools & Districts
`UNIVERSITY`	Higher Education Universities & Colleges

Entitlement

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

Fields

name

string

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

create_time

Timestamp

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

update_time

Timestamp

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

channel_partner_id
 (deprecated)

string

Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: channel_partner_id has been moved to the Customer.

offer

string

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

num_units
 (deprecated)

int32

Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use parameters instead.

max_units
 (deprecated)

int32

Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use parameters instead.

assigned_units
 (deprecated)

int32

The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use parameters instead.

commitment_settings

CommitmentSettings

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

provisioning_state

ProvisioningState

Output only. Current provisioning state of the entitlement.

provisioned_service

ProvisionedService

Output only. Service provisioning details for the entitlement.

suspension_reasons[]

SuspensionReason

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

purchase_order_id

string

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. This is only supported for Google Workspace entitlements.

trial_settings

TrialSettings

Output only. Settings for trial offers.

association_info

AssociationInfo

Association information to other entitlements.

parameters[]

Parameter

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions .

For Google Workspace, the following Parameters may be accepted as input:

max_units: The maximum assignable units for a flexible offer

num_units: The total commitment for commitment-based offers

The response may additionally include the following output-only Parameters:

assigned_units: The number of licenses assigned to users.

For Google Cloud billing subaccounts, the following Parameter may be accepted as input:

display_name: The display name of the billing subaccount.

billing_account

string

Optional. The billing account resource name that is used to pay for this entitlement.

price_reference_id

string

Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.

ProvisioningState

Indicates the current provisioning state of the entitlement.

Enums
`PROVISIONING_STATE_UNSPECIFIED`	Not used.
`ACTIVE`	The entitlement is currently active.
`CANCELED`	The entitlement was canceled. After an entitlement is `CANCELED` , its status will not change. Deprecated: Canceled entitlements will no longer be visible. This item is deprecated!
`COMPLETE`	The entitlement reached end of term and was not renewed. After an entitlement is `COMPLETE` , its status will not change. Deprecated: This is represented as ProvisioningState=SUSPENDED and suspensionReason in (TRIAL_ENDED, RENEWAL_WITH_TYPE_CANCEL) This item is deprecated!
`PENDING`	The entitlement is pending. Deprecated: This is represented as ProvisioningState=SUSPENDED and suspensionReason=PENDING_TOS_ACCEPTANCE This item is deprecated!
`SUSPENDED`	The entitlement is currently suspended.

SuspensionReason

Suspension reason for an entitlement if provisioning_state = SUSPENDED.

Enums
`SUSPENSION_REASON_UNSPECIFIED`	Not used.
`RESELLER_INITIATED`	Entitlement was manually suspended by the Reseller.
`TRIAL_ENDED`	Trial ended.
`RENEWAL_WITH_TYPE_CANCEL`	Entitlement renewal was canceled.
`PENDING_TOS_ACCEPTANCE`	Entitlement was automatically suspended on creation for pending ToS acceptance on customer.
`OTHER`	Other reasons (internal reasons, abuse, etc.).

EntitlementChange

Change event entry for Entitlement order history

Fields

entitlement

string

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

offer

string

Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.

provisioned_service

ProvisionedService

Service provisioned for an Entitlement.

change_type

ChangeType

The change action type.

create_time

Timestamp

The submitted time of the change.

operator_type

OperatorType

Operator type responsible for the change.

parameters[]

Parameter

Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.

operator

string

Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.

Union field change_reason . The reason the change was made change_reason can be only one of the following:

suspension_reason

SuspensionReason

Suspension reason for the Entitlement.

cancellation_reason

CancellationReason

Cancellation reason for the Entitlement.

activation_reason

ActivationReason

The Entitlement's activation reason

other_change_reason

string

e.g. purchase_number change reason, entered by CRS.

ActivationReason

The Entitlement's activation reason

Enums
`ACTIVATION_REASON_UNSPECIFIED`	Not used.
`RESELLER_REVOKED_SUSPENSION`	Reseller reactivated a suspended Entitlement.
`CUSTOMER_ACCEPTED_PENDING_TOS`	Customer accepted pending terms of service.
`RENEWAL_SETTINGS_CHANGED`	Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement.
`OTHER_ACTIVATION_REASON`	Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.)

CancellationReason

Cancellation reason for the entitlement

Enums
`CANCELLATION_REASON_UNSPECIFIED`	Not used.
`SERVICE_TERMINATED`	Reseller triggered a cancellation of the service.
`RELATIONSHIP_ENDED`	Relationship between the reseller and customer has ended due to a transfer.
`PARTIAL_TRANSFER`	Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller.

ChangeType

Specifies the type of change action

Enums
`CHANGE_TYPE_UNSPECIFIED`	Not used.
`CREATED`	New Entitlement was created.
`PRICE_PLAN_SWITCHED`	Price plan associated with an Entitlement was changed.
`COMMITMENT_CHANGED`	Number of seats committed for a commitment Entitlement was changed.
`RENEWED`	An annual Entitlement was renewed.
`SUSPENDED`	Entitlement was suspended.
`ACTIVATED`	Entitlement was activated.
`CANCELLED`	Entitlement was cancelled.
`SKU_CHANGED`	Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus.
`RENEWAL_SETTING_CHANGED`	The settings for renewal of an Entitlement have changed.
`PAID_SUBSCRIPTION_STARTED`	Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created.
`LICENSE_CAP_CHANGED`	License cap was changed for the entitlement.
`SUSPENSION_DETAILS_CHANGED`	The suspension details have changed (but it is still suspended).
`TRIAL_END_DATE_EXTENDED`	The trial end date was extended.
`TRIAL_STARTED`	Entitlement started trial.

OperatorType

Specifies the type of operator responsible for the change

Enums
`OPERATOR_TYPE_UNSPECIFIED`	Not used.
`CUSTOMER_SERVICE_REPRESENTATIVE`	Customer service representative.
`SYSTEM`	System auto job.
`CUSTOMER`	Customer user.
`RESELLER`	Reseller user.

EntitlementEvent

Represents Pub/Sub message content describing entitlement update.

Fields

entitlement

string

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

event_type

Type

Type of event which happened for the entitlement.

Type

Type of entitlement event.

Enums
`TYPE_UNSPECIFIED`	Not used.
`CREATED`	A new entitlement was created.
`PRICE_PLAN_SWITCHED`	The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.
`COMMITMENT_CHANGED`	Annual commitment for a commit plan was changed.
`RENEWED`	An annual entitlement was renewed.
`SUSPENDED`	Entitlement was suspended.
`ACTIVATED`	Entitlement was unsuspended.
`CANCELLED`	Entitlement was cancelled.
`SKU_CHANGED`	Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).
`RENEWAL_SETTING_CHANGED`	The renewal settings of an entitlement has changed.
`PAID_SERVICE_STARTED`	Paid service has started on trial entitlement.
`LICENSE_ASSIGNMENT_CHANGED`	License was assigned to or revoked from a user.
`LICENSE_CAP_CHANGED`	License cap was changed for the entitlement.

FetchReportResultsRequest

Request message for CloudChannelReportsService.FetchReportResults .

Fields
`report_job`	`string` Required. The report job created by `CloudChannelReportsService.RunReportJob` . Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
`page_size`	`int32` Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time). The maximum value is 30,000; the server will change larger values to 30,000.
`page_token`	`string` Optional. A token that specifies a page of results beyond the first page. Obtained through `FetchReportResultsResponse.next_page_token` of the previous `CloudChannelReportsService.FetchReportResults` call.
`partition_keys[]`	`string` Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

FetchReportResultsResponse

Response message for CloudChannelReportsService.FetchReportResults . Contains a tabular representation of the report results.

Fields

report_metadata

ReportResultsMetadata

The metadata for the report results (display name, columns, row count, and date ranges).

rows[]

Row

The report's lists of values. Each row follows the settings and ordering of the columns from report_metadata .

next_page_token

string

Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results.

GetChannelPartnerLinkRequest

Request message for CloudChannelService.GetChannelPartnerLink .

Fields

name

string

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.

view

ChannelPartnerLinkView

Optional. The level of granularity the ChannelPartnerLink will display.

GetChannelPartnerRepricingConfigRequest

Request message for CloudChannelService.GetChannelPartnerRepricingConfig

Fields

name

string

Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.

GetCustomerRepricingConfigRequest

Request message for CloudChannelService.GetCustomerRepricingConfig .

Fields

name

string

Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

GetCustomerRequest

Request message for CloudChannelService.GetCustomer .

Fields

name

string

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

GetEntitlementRequest

Request message for CloudChannelService.GetEntitlement .

Fields

name

string

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

GetOpportunityRequest

Request message for CloudChannelService.GetOpportunity

Fields

name

string

Required. The name of the opportunity to retrieve. Format: opportunities/{opportunity}

partner

string

Required. Provide the Partner Id for which the Opportunity is being retrieved. Format: partner = partners/{id}

ImportCustomerRequest

Request message for CloudChannelService.ImportCustomer

Fields

parent

string

Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

auth_token

string

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.

overwrite_if_exists

bool

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.

channel_partner_id

string

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.

customer

string

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

Union field customer_identity . Specifies the identity of the transfer customer. A customer's cloud_identity_id or domain is required to look up the customer's Cloud Identity. For Team customers, only the cloud_identity_id option is valid. customer_identity can be only one of the following:

domain

string

Required. Customer domain.

cloud_identity_id

string

Required. Customer's Cloud Identity ID

primary_admin_email

string

Required. Customer's primary admin email.

IsvSolutionConnectInfo

Information about a ISV Solution Connect Deal.

Fields
`isv_solution_connect_deal`	`bool` Is the deal an ISV solution connect deal? Can't be edited after the Opportunity is Accepted. Default: false.
`customer_contact_requested`	`bool` Has customer requested to be contacted? Can't be edited after the Opportunity is Accepted. Must be marked as true in order for an ISV oppty to be accepted. Default: false.
`support_level`	`SupportLevel` Support Level. Can't be edited after the Opportunity is Accepted.
`contract_vehicle`	`ContractVehicle` Contract Vehicle. Can't be edited after the Opportunity is Accepted.
`delivery_model`	`DeliveryModel` Delivery Model. Can't be edited after the Opportunity is Accepted.
`notes`	`string` Optional. Notes. Only available for ISV Opportunities. ISV and Googler use this field to keep each other up to date on selling activity to the customer. Maximum character length: 5000.
`next_step`	`string` Optional. Next Step. Only available for ISV Opportunities. Summarizes between the ISV and Googler what the next action is on and who should take it. Maximum character length: 255.

ContractVehicle

Contract Vehicle.

Enums
`CONTRACT_VEHICLE_UNSPECIFIED`	Not used.
`CLOUD_MARKETPLACE`	Google Cloud Marketplace.
`PARTNER_CONTRACT`	Partner contract.
`UNKNOWN`	Not known at this time.

DeliveryModel

Delivery Model.

Enums
`DELIVERY_MODEL_UNSPECIFIED`	Not used.
`OTHER_DELIVERY_MODEL`	Other.
`DATA_TO_CUSTOMER_BIGQUERY`	Data to customer BigQuery.
`VM_ON_CUSTOMER_TENANCY`	VM on Customer Tenancy.
`SAAS_ON_GOOGLE_CLOUD`	SaaS on Google Cloud.

SupportLevel

Support Level.

Enums
`SUPPORT_LEVEL_UNSPECIFIED`	Not used.
`OTHER_SUPPORT_LEVEL`	Other.
`TECH`	Technical support.
`TRANSACTION`	Transaction related support (POC/Google Cloud Marketplace/Procurement).
`UPSELL_RENEW_CROSS_SELL`	Upselling/renewal/cross-selling support.
`ALIGN_SALES_ACCOUNT`	Align sales/account strategy.
`ALREADY_CONTACT`	Already in touch with Google Cloud sales.

ListChannelPartnerLinksRequest

Request message for CloudChannelService.ListChannelPartnerLinks

Fields
`parent`	`string` Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}
`page_size`	`int32` 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.
`page_token`	`string` Optional. A token for a page of results other than the first page. Obtained using `ListChannelPartnerLinksResponse.next_page_token` of the previous `CloudChannelService.ListChannelPartnerLinks` call.
`view`	`ChannelPartnerLinkView` Optional. The level of granularity the ChannelPartnerLink will display.

ListChannelPartnerLinksResponse

Response message for CloudChannelService.ListChannelPartnerLinks .

Fields

channel_partner_links[]

ChannelPartnerLink

The Channel partner links for a reseller.

next_page_token

string

A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.

ListChannelPartnerRepricingConfigsRequest

Request message for CloudChannelService.ListChannelPartnerRepricingConfigs .

Fields
`parent`	`string` Required. The resource name of the account's `ChannelPartnerLink` . Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.
`page_size`	`int32` Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.
`page_token`	`string` Optional. A token identifying a page of results beyond the first page. Obtained through `ListChannelPartnerRepricingConfigsResponse.next_page_token` of the previous `CloudChannelService.ListChannelPartnerRepricingConfigs` call.
`filter`	`string` Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] results (channel_partner_link only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set `parent=accounts/{account_id}/channelPartnerLinks/-` . Example: `channel_partner_link = accounts/account_id/channelPartnerLinks/c1` OR `channel_partner_link = accounts/account_id/channelPartnerLinks/c2` .

ListChannelPartnerRepricingConfigsResponse

Response message for CloudChannelService.ListChannelPartnerRepricingConfigs .

Fields

channel_partner_repricing_configs[]

ChannelPartnerRepricingConfig

The repricing configs for this channel partner.

next_page_token

string

A token to retrieve the next page of results. Pass to ListChannelPartnerRepricingConfigsRequest.page_token to obtain that page.

ListCustomerRepricingConfigsRequest

Request message for CloudChannelService.ListCustomerRepricingConfigs .

Fields
`parent`	`string` Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.
`page_size`	`int32` Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.
`page_token`	`string` Optional. A token identifying a page of results beyond the first page. Obtained through `ListCustomerRepricingConfigsResponse.next_page_token` of the previous `CloudChannelService.ListCustomerRepricingConfigs` call.
`filter`	`string` Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] results (customer only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set `parent=accounts/{account_id}/customers/-` . Example: customer = accounts/account_id/customers/c1 OR customer = accounts/account_id/customers/c2.

ListCustomerRepricingConfigsResponse

Response message for CloudChannelService.ListCustomerRepricingConfigs .

Fields

customer_repricing_configs[]

CustomerRepricingConfig

The repricing configs for this channel partner.

next_page_token

string

A token to retrieve the next page of results. Pass to ListCustomerRepricingConfigsRequest.page_token to obtain that page.

ListCustomersRequest

Request message for CloudChannelService.ListCustomers

Fields
`parent`	`string` Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.
`page_size`	`int32` 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.
`page_token`	`string` Optional. A token identifying a page of results other than the first page. Obtained through `ListCustomersResponse.next_page_token` of the previous `CloudChannelService.ListCustomers` call.
`filter`	`string` Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.

ListCustomersResponse

Response message for CloudChannelService.ListCustomers .

Fields

customers[]

Customer

The customers belonging to a reseller or distributor.

next_page_token

string

A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page.

ListEntitlementChangesRequest

Request message for CloudChannelService.ListEntitlementChanges

Fields

parent

string

Required. The resource name of the entitlement for which to list entitlement changes. The - wildcard may be used to match entitlements across a customer. Formats:

accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
accounts/{account_id}/customers/{customer_id}/entitlements/-

page_size

int32

Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50.

page_token

string

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

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

filter

string

Optional. Filters applied to the list results.

ListEntitlementChangesResponse

Response message for CloudChannelService.ListEntitlementChanges

Fields

entitlement_changes[]

EntitlementChange

The list of entitlement changes.

next_page_token

string

A token to list the next page of results.

ListEntitlementsRequest

Request message for CloudChannelService.ListEntitlements

Fields

parent

string

Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}

page_size

int32

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.

page_token

string

Optional. A token for a page of results other than the first page. Obtained using ListEntitlementsResponse.next_page_token of the previous CloudChannelService.ListEntitlements call.

ListEntitlementsResponse

Response message for CloudChannelService.ListEntitlements .

Fields

entitlements[]

Entitlement

The reseller customer's entitlements.

next_page_token

string

A token to list the next page of results. Pass to ListEntitlementsRequest.page_token to obtain that page.

ListOffersRequest

Request message for ListOffers.

Fields
`parent`	`string` Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.
`page_size`	`int32` 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.
`page_token`	`string` Optional. A token for a page of results other than the first page.
`filter`	`string` 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
`language_code`	`string` 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".
`deal_code`	`string` Optional. A string to filter for only these specific deal codes
`show_future_offers`	`bool` Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

ListOffersResponse

Response message for ListOffers.

Fields

offers[]

Offer

The list of Offers requested.

The pricing information for each Offer only includes the base price. Effective prices and discounts aren't populated.

next_page_token

string

A token to retrieve the next page of results.

ListProductsRequest

Request message for ListProducts.

Fields
`account`	`string` Required. The resource name of the reseller account. Format: accounts/{account_id}.
`page_size`	`int32` 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.
`page_token`	`string` Optional. A token for a page of results other than the first page.
`language_code`	`string` 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".

ListProductsResponse

Response message for ListProducts.

Fields

products[]

Product

List of Products requested.

next_page_token

string

A token to retrieve the next page of results.

ListProvisionableCloudIdentityTypesRequest

Request message for CloudChannelService.ListProvisionableCloudIdentityTypes

Fields
`parent`	`string` Required. The resource name of the reseller's account. Parent uses the format: accounts/{account_id}
`domain`	`string` Required. The customer's domain.
`channel_partner_id`	`string` Optional. The Cloud Identity Id of the channel partner under the account to list ProvisionableCloudIdentityTypes for
`primary_admin_email`	`string` Optional. The primary admin email of the customer.

ListProvisionableCloudIdentityTypesResponse

Response message for CloudChannelService.ListProvisionableCloudIdentityTypes

Fields

cloud_identity_types[]

ProvisionableCloudIdentityType

List of cloud identity types and if you can provision them for the domain.

ListPurchasableOffersRequest

Request message for ListPurchasableOffers.

Fields

customer

string

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

page_size

int32

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.

page_token

string

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

language_code

string

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

Union field purchase_option . Defines the intended purchase. purchase_option can be only one of the following:

create_entitlement_purchase

CreateEntitlementPurchase

List Offers for CreateEntitlement purchase.

change_offer_purchase

ChangeOfferPurchase

List Offers for ChangeOffer purchase.

ChangeOfferPurchase

List Offers for ChangeOffer purchase.

Fields
`entitlement`	`string` Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
`new_sku`	`string` Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}
`billing_account`	`string` Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
`deal_code`	`string` Optional. A string to filter for only these specific deal codes

CreateEntitlementPurchase

List Offers for CreateEntitlement purchase.

Fields

sku

string

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

billing_account

string

Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.

deal_code

string

Optional. A string to filter for only these specific deal codes

ListPurchasableOffersResponse

Response message for ListPurchasableOffers.

Fields

purchasable_offers[]

PurchasableOffer

The list of Offers requested.

next_page_token

string

A token to retrieve the next page of results.

ListPurchasableSkusRequest

Request message for ListPurchasableSkus.

Fields

customer

string

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

page_size

int32

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.

page_token

string

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

language_code

string

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

Union field purchase_option . Defines the intended purchase. purchase_option can be only one of the following:

create_entitlement_purchase

CreateEntitlementPurchase

List SKUs for CreateEntitlement purchase.

change_offer_purchase

ChangeOfferPurchase

List SKUs for ChangeOffer purchase with a new SKU.

ChangeOfferPurchase

List SKUs for upgrading or downgrading an entitlement. Make the purchase using CloudChannelService.ChangeOffer .

Fields

entitlement

string

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

change_type

ChangeType

Required. Change Type for the entitlement.

ChangeType

Change Type enum.

Enums
`CHANGE_TYPE_UNSPECIFIED`	Not used.
`UPGRADE`	SKU is an upgrade on the current entitlement.
`DOWNGRADE`	SKU is a downgrade on the current entitlement.

CreateEntitlementPurchase

List SKUs for a new entitlement. Make the purchase using CloudChannelService.CreateEntitlement .

Fields

product

string

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

ListPurchasableSkusResponse

Response message for ListPurchasableSkus.

Fields

purchasable_skus[]

PurchasableSku

The list of SKUs requested.

next_page_token

string

A token to retrieve the next page of results.

ListReportsRequest

Request message for CloudChannelReportsService.ListReports .

Fields
`parent`	`string` Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}
`page_size`	`int32` Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.
`page_token`	`string` Optional. A token that specifies a page of results beyond the first page. Obtained through `ListReportsResponse.next_page_token` of the previous `CloudChannelReportsService.ListReports` call.
`language_code`	`string` Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

ListReportsResponse

Response message for CloudChannelReportsService.ListReports .

Fields

reports[]

Report

The reports available to the partner.

next_page_token

string

Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results.

ListSkuGroupBillableSkusRequest

Request message for ListSkuGroupBillableSkus.

Fields

parent

string

Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.

page_size

int32

Optional. The maximum number of SKUs to return. The service may return fewer than this value. If unspecified, returns a maximum of 100000 SKUs. The maximum value is 100000; values above 100000 will be coerced to 100000.

page_token

string

Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkusResponse.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call.

ListSkuGroupBillableSkusResponse

Response message for ListSkuGroupBillableSkus.

Fields

billable_skus[]

BillableSku

The list of billable SKUs in the requested SKU group.

next_page_token

string

A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkusRequest.page_token to obtain that page.

ListSkuGroupsRequest

Request message for ListSkuGroups.

Fields

parent

string

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

page_size

int32

Optional. The maximum number of SKU groups to return. The service may return fewer than this value. If unspecified, returns a maximum of 1000 SKU groups. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupsResponse.next_page_token of the previous CloudChannelService.ListSkuGroups call.

ListSkuGroupsResponse

Response message for ListSkuGroups.

Fields

sku_groups[]

SkuGroup

The list of SKU groups requested.

next_page_token

string

A token to retrieve the next page of results. Pass to ListSkuGroupsRequest.page_token to obtain that page.

ListSkusRequest

Request message for ListSkus.

Fields
`parent`	`string` 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.
`account`	`string` Required. Resource name of the reseller. Format: accounts/{account_id}.
`page_size`	`int32` 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.
`page_token`	`string` Optional. A token for a page of results other than the first page. Optional.
`language_code`	`string` 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".

ListSkusResponse

Response message for ListSkus.

Fields

skus[]

Sku

The list of SKUs requested.

next_page_token

string

A token to retrieve the next page of results.

ListSubscribersRequest

Request Message for ListSubscribers.

Fields
`account`	`string` Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
`page_size`	`int32` 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.
`page_token`	`string` 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.
`integrator`	`string` Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.

ListSubscribersResponse

Response Message for ListSubscribers.

Fields

topic

string

Name of the topic registered with the reseller.

service_accounts[]

string

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

next_page_token

string

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

ListTransferableOffersRequest

Request message for CloudChannelService.ListTransferableOffers

Fields

parent

string

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

page_size

int32

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.

page_token

string

A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call.

sku

string

Required. The SKU to look up Offers for.

language_code

string

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

billing_account

string

Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.

This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.

Union field transferred_customer_identity . Specifies the identity of transferred customer. Either a cloud_identity_id of the customer or the customer name is required to look up transferrable Offers. transferred_customer_identity can be only one of the following:

cloud_identity_id

string

Customer's Cloud Identity ID

customer_name

string

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

ListTransferableOffersResponse

Response message for CloudChannelService.ListTransferableOffers .

Fields

transferable_offers[]

TransferableOffer

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

next_page_token

string

A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page.

ListTransferableSkusRequest

Request message for CloudChannelService.ListTransferableSkus

Fields

parent

string

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

page_size

int32

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.

page_token

string

A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional.

auth_token

string

language_code

string

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". Optional.

Union field transferred_customer_identity . Specifies the identity of transferred customer. Either a cloud_identity_id of the customer or the customer name is required to look up transferable SKUs. transferred_customer_identity can be only one of the following:

cloud_identity_id

string

Customer's Cloud Identity ID

customer_name

string

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}

ListTransferableSkusResponse

Response message for CloudChannelService.ListTransferableSkus .

Fields

transferable_skus[]

TransferableSku

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

next_page_token

string

A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page.

LookupOfferRequest

Request message for LookupOffer.

Fields

entitlement

string

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

MarketingInfo

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

Fields

display_name

string

Human readable name.

description

string

Human readable description. Description can contain HTML.

default_logo

Media

Default logo.

Media

Represents media information.

Fields

title

string

Title of the media.

content

string

URL of the media.

type

MediaType

Type of the media.

MediaType

Type of media used.

Enums
`MEDIA_TYPE_UNSPECIFIED`	Not used.
`MEDIA_TYPE_IMAGE`	Type of image.

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.

Fields
`name`	`string` Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id}
`marketing_info`	`MarketingInfo` Marketing information for the Offer.
`sku`	`Sku` SKU the offer is associated with.
`plan`	`Plan` Describes the payment plan for the Offer.
`constraints`	`Constraints` Constraints on transacting the Offer.
`price_by_resources[]`	`PriceByResource` Price for each monetizable resource type.
`start_time`	`Timestamp` Start of the Offer validity time.
`end_time`	`Timestamp` Output only. End of the Offer validity time.
`parameter_definitions[]`	`ParameterDefinition` Parameters required to use current Offer to purchase.
`deal_code`	`string` The deal code of the offer to get a special promotion or discount.

OperationMetadata

Provides contextual information about a google.longrunning.Operation .

Fields

operation_type

OperationType

The RPC that initiated this Long Running Operation.

OperationType

RPCs that return a Long Running Operation.

Enums
`OPERATION_TYPE_UNSPECIFIED`	Not used.
`CREATE_ENTITLEMENT`	Long Running Operation was triggered by CreateEntitlement.
`CHANGE_QUANTITY`	Long Running Operation was triggered by ChangeQuantity.
`CHANGE_RENEWAL_SETTINGS`	Long Running Operation was triggered by ChangeRenewalSettings.
`CHANGE_PLAN`	Long Running Operation was triggered by ChangePlan.
`START_PAID_SERVICE`	Long Running Operation was triggered by StartPaidService.
`CHANGE_SKU`	Long Running Operation was triggered by ChangeSku.
`ACTIVATE_ENTITLEMENT`	Long Running Operation was triggered by ActivateEntitlement.
`SUSPEND_ENTITLEMENT`	Long Running Operation was triggered by SuspendEntitlement.
`CANCEL_ENTITLEMENT`	Long Running Operation was triggered by CancelEntitlement.
`TRANSFER_ENTITLEMENTS`	Long Running Operation was triggered by TransferEntitlements.
`TRANSFER_ENTITLEMENTS_TO_GOOGLE`	Long Running Operation was triggered by TransferEntitlementsToGoogle.
`CHANGE_OFFER`	Long Running Operation was triggered by ChangeOffer.
`CHANGE_PARAMETERS`	Long Running Operation was triggered by ChangeParameters.
`PROVISION_CLOUD_IDENTITY`	Long Running Operation was triggered by ProvisionCloudIdentity.

Opportunity

An Opportunity is a pending sale from a customer likely to purchase Google Cloud products or services. Once closed, an Opportunity is either won (results in an order) or lost.

Fields
`name`	`string` Identifier. Resource name of an Opportunity in the form: opportunities/{opportunity_id}. Available in Limited view.
`customer_display_name`	`string` Output only. Customer display name that the Opportunity is associated with. This maps to the Vector Account name. Available in Limited view.
`state`	`State` Optional. State the Opportunity is in. Client can only set the state to DRAFT or SUBMITTED. Default: DRAFT. Available in Limited view.
`state_description`	`string` Output only. Contains the reason if the Opportunity was not accepted. Available in Limited view.
`stage`	`Stage` The sales stage that the Opportunity is in. New Opportunities are created in Stage 0. Can only be updated after the Opportunity is ACCEPTED. Can't be updated to CLOSED. Available in Limited view.
`owner`	`string` Output only. Name of the Google FSR who owns the Opportunity. Available in Limited view.
`owner_email`	`string` Output only. Email of the Google FSR who owns the Opportunity. Available in Limited view.
`creator_email`	`string` Output only. User email that created the Opportunity. If the Opportunity is created through an integrator, this will be the integrator's service account.
`source`	`Source` Output only. Represents if the Opportunity was created by Google or by Partner. Available in Limited view.
`opportunity_info`	`OpportunityInfo` Required. Information about the Opportunity provided during deal submission. Required for Creating an Opportunity. Available in Limited view.
`qualification_info`	`QualificationInfo` Required. Information that will be used to qualify the Opportunity for approval and incentive eligibility. Required for Creating an Opportunity.
`customer_info`	`CustomerInfo` Required. Information of the end customer used for matching to an existing customer account or for creating a new one. Required for Creating an Opportunity. Can't be edited after the Opportunity is Accepted. Available in Limited view.
`isv_solution_connect_info`	`IsvSolutionConnectInfo` Optional. Optional information that can be provided for ISV deals during Create Opportunity. Can't be edited after the Opportunity is Accepted.
`partner_info`	`PartnerInfo` Optional. Opportunity information related to the sourcing Partner. Present only after the Opportunity is Accepted. Unset otherwise. Can be edited. Available in Limited view.
`sales_cycle`	`SalesCycle` Optional. Information related to the Sales cycle. Present only after the Opportunity is Accepted. Unset otherwise. Can be edited. Available in Limited view.
`win_loss_info`	`WinLossInfo` Output only. Information related to the Sales cycle. Present only after the Opportunity is closed. Unset otherwise. Can't be edited.
`opportunity_lines[]`	`OpportunityLine` Output only. Information about the Products added to the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
`opportunity_team_members[]`	`OpportunityTeamMember` Output only. Information on the Partner users with access to the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited. Available in Limited view. Only lists the Partner Development Manager (PDM) roles in Limited view.
`customer_contacts[]`	`CustomerContact` Output only. List of Customer contacts for the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
`rebate_extensions[]`	`RebateExtension` Output only. Information about the rebate extensions requested on the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
`create_time`	`Timestamp` Output only. Timestamp when the Opportunity was created.
`update_time`	`Timestamp` Output only. Timestamp when the Opportunity was last updated.
`reference_opportunity_id`	`string` Output only. Opportunity ID in the Partner Advantage Portal. This ID is meant for mapping the Opportunities to the old system, and has a 1 to 1 mapping with the opportunities in this Service. Available in Limited view.
`opportunity_type`	`OpportunityType` Optional. Indicates if the opportunity is an Regular/Independent Software Vendor/2-tier deal. If not specified, it will be treated as a Regular. Can't be edited after the Opportunity is Accepted.
`submitter_email`	`string` Optional. User email that created the Opportunity through an integrator. Only used if the Opportunity is created through an integrator. Can only be set during Opportunity creation. Can't be edited after it's set.

OpportunityType

Opportunity Type

Enums
`OPPORTUNITY_TYPE_UNSPECIFIED`	Not used.
`REGULAR`	Service or Sell 1-tier Opportunity. Default value.
`TWO_TIER`	2-Tier Opportunity
`ISV_SOLUTION_CONNECT`	Independent Software Vendor Opportunity

Source

Represents the source for Oppty creation.

Enums
`SOURCE_UNKNOWN`	Not used.
`GOOGLE`	Created by Google sales rep.
`GOOGLE_BDR`	Created by Google Business.
`GOOGLE_PROGRAMMATIC`	Created by Google programmatically.
`PARTNER`	If the Opportunity was created by Partner.

Stage

Represents the sales stages of an Opportunity.

Enums
`STAGE_UNSPECIFIED`	Not used.
`QUALIFY`	Stage 0 - Qualify.
`REFINE`	Stage 1 - Refine.
`TECH_EVAL_SOL_DEV`	Stage 2 - Tech evaluation and Solution Development.
`PROPOSAL_NEGOTIATION`	Stage 3 - Proposal negotiation.
`MIGRATION_IMPL`	Stage 4 - Migration or Implementation. Represents Closed/Won stage. Can only be set by the system.
`CLOSED_LOST`	Closed lost. Can only be set by the system.
`CLOSED_ADMIN`	Closed by Admin. Can only be set by the system.

State

Represents the approval state of the Opportunity.

Enums
`STATE_UNSPECIFIED`	Not used.
`DRAFT`	Set this state if you are not ready to submit the Opportunity for Approval.
`SUBMITTED`	Set this state to process the Approval.
`ACCEPTED`	Can only be set by the system. Indicates that the Opportunity has been accepted.
`NOT_ACCEPTED`	Can only be set by the system. Indicates that the Opportunity has not been accepted. Clients can edit the Opportunity and resubmit it for approval by setting the state back to SUBMITTED.

OpportunityEvent

Represents Pub/Sub message content describing opportunity updates.

Fields

opportunity

string

Resource name of the opportunity. Format: opportunities/{opportunity}

event_type

Type

Type of event which happened for the opportunity.

partner

string

Resource name of the partner. Format: partners/{partner}

Type

Type of opportunity event.

Enums
`TYPE_UNSPECIFIED`	Not used.
`CREATED`	New opportunity created.
`UPDATED`	Existing opportunity updated.
`PARTNER_DETACHED`	Partner has been detached from the opportunity and can no longer access it.

OpportunityInfo

Contains details about the Opportunity.

Fields
`partner_entity`	`string` Required. Partner who sources the deal. In case of 2-tier Partners, this is the Distributor id. Format: partners/{id}
`indirect_partner_entity`	`string` Optional. If a 2-tier deal provide the Indirect Reseller involved. Format: partners/{id}
`display_name`	`string` Optional. Display name for the Opportunity. Available in Limited view. Maximum character length: 120.
`description`	`string` Optional. Opportunity description. Available in Limited view.
`product_family[]`	`ProductFamily` Optional. Product Family the Opportunity belongs to. For MVP, only 1 Product Family is supported. Required for ISV Solution Connect Opportunity. For Non-ISV Opportunities its derived from the Product Category.
`product_category[]`	`ProductCategory` Optional. Product Category the Opportunity belongs to. For MVP, only 1 Product Category is supported. Required for non-ISV Opportunities. For ISV Solution Connect, the Product Category should be empty. Can't be edited after the Opportunity is Accepted.
`confidential`	`bool` Optional. Flag to identify if the Opportunity is confidential and needs to have restricted access. Default: false.
`gcp_watermark`	`double` Output only. GCP Watermark.
`opportunity_amount`	`Money` Output only. Total estimate for the Opportunity calculated based on the Opportunity Line items.

ProductCategory

Defines the sub category under Product Family. For ISV Solution Connect, the Product Category should be PRODUCT_CATEGORY_UNSPECIFIED.

Enums
`PRODUCT_CATEGORY_UNSPECIFIED`	Not used.
`GOOGLE_GEMINI_AI`	Google Gemini AI. This item is deprecated.
`GCP_AI`	GCP AI.
`GCP_ANALYTICS`	GCP Analytics.
`GCP_ANTHOS`	GCP Anthos.
`GCP_APIGEE`	GCP Apigee.
`GCP_APPSHEET`	GCP Appsheet.
`GCP_COMPUTE`	GCP Compute.
`GCP_DATABASES`	GCP Databases.
`GCP_DISTRIBUTED_CLOUD`	GCP Distributed Cloud.
`GCP_DUET_AI`	GCP Duet AI.
`GCP_GPU`	GCP GPU.
`GCP_LOOKER`	GCP Looker.
`GCP_NETWORK`	GCP Network.
`GCP_OTHER`	GCP Other.
`GCP_OTHER_SECURITY`	GCP Other Security. Not currently supported.
`GCP_PLATFORM`	GCP Platform.
`GCP_SCCE`	GCP SCCE. Not currently supported.
`GCP_SERVERLESS`	GCP Serverless.
`GCP_STORAGE`	GCP Storage.
`GCP_SUPPORT`	GCP Support.
`GOOGLE_CLOUD_IDENTITY`	Google Cloud Identity.
`GOOGLE_MAPS`	Google Maps.
`GOOGLE_VAULT`	Google Vault.
`GOOGLE_VOICE`	Google Voice.
`GOOGLE_WORKSPACE_CORE`	Google Workspace Core.
`GOOGLE_WORKSPACE_EDU`	Google Workspace Edu.
`GCP_AGENTSPACE`	Google Agentspace.
`CHROME_OS_ENTERPRISE`	Chrome OS - Enterprise
`CHROME_OS_EDUCATION`	Chrome OS - Education
`PSO_TRAINING`	PSO - Training
`PSO_CONSULTING`	PSO - Consulting
`GCP_GOOGLE_SECOPS`	GCP - Google Secops
`GCP_GOOGLE_THREAT_INTELLIGENCE`	GCP - Google Threat Intelligence
`GCP_CHROME_ENTERPRISE_PREMIUM`	GCP - Chrome Enterprise Premium
`GCP_RECAPTCHA`	GCP - reCAPTCHA
`GCP_MANAGED_HUNT`	GCP - Managed Hunt
`GCP_MANAGED_DEFENSE`	GCP - Managed Defense
`GCP_WEBRISK`	GCP - Web Risk
`GCP_MANDIANT_CONSULTING_SERVICES`	GCP - Mandiant Consulting Services
`GCP_SCC`	GCP Security Command Center

ProductFamily

Defines the high-level Product Family. Product Authorization is performed at this level.

Enums
`PRODUCT_FAMILY_UNSPECIFIED`	Not used.
`GOOGLE_CLOUD_PLATFORM`	Google Cloud Platform.
`GOOGLE_WORKSPACE`	Google Workspace.
`MAPS`	Maps.
`CHROME`	Chrome
`PSO`	PSO

OpportunityLine

Opportunity Line item.

Fields
`display_name`	`string` Output only. Product display name.
`quantity`	`int32` Output only. Quantity.
`sales_price`	`Money` Output only. Sales price.
`list_price`	`Money` Output only. List price.
`total_price`	`Money` Output only. Total price of the line.
`metric`	`string` Output only. Unit of measure.
`description`	`string` Output only. Line item description.

OpportunityTeamMember

Opportunity Team Member.

Fields

name

string

Output only. Name. Available in Limited view.

email

string

Output only. Email. Available in Limited view.

access_level

AccessLevel

Output only. Access Level. Available in Limited view.

AccessLevel

Access Level.

Enums
`ACCESS_LEVEL_UNSPECIFIED`	Not used.
`VIEW_ONLY`	View only.
`MODIFY`	Modify.

Parameter

Definition for extended entitlement parameters.

Fields

name

string

Name of the parameter.

value

Value

Value of the parameter.

editable

bool

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.

ParameterDefinition

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

Fields
`name`	`string` Name of the parameter.
`parameter_type`	`ParameterType` Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
`min_value`	`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.
`max_value`	`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.
`allowed_values[]`	`Value` If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
`optional`	`bool` If set to true, parameter is optional to purchase this Offer.

ParameterType

Data type of the parameter.

Enums
`PARAMETER_TYPE_UNSPECIFIED`	Not used.
`INT64`	Int64 type.
`STRING`	String type.
`DOUBLE`	Double type.
`BOOLEAN`	Boolean type.

PartnerAdvantageInfo

Partner Advantage information for a Channel Partner.

Fields

product_authorization[]

ProductAuthorization

A list of this Channel Partner's product authorizations.

PartnerInfo

Partner Information provided after the Opportunity is Accepted.

Fields
`incentive_eligibility`	`bool` Output only. Whether Partner is eligible for incentives for this Opportunity.
`incentive_type`	`IncentiveType` Output only. Incentive type if the Opportunity is eligible for incentive: Deal Registration or Deal Referral.
`contract_expiry_date`	`Date` Contract expiration date. Date in UTC. Can be edited after the Opportunity is Accepted.
`rebate_expiration_date`	`Date` Output only. Rebate expiration date.
`distributor`	`string` Distributor in case of 2-tier deals. Format: partners/{id}. Can be edited after the Opportunity is Accepted.
`sub_billing_account_id`	`string` Optional. Cloud Billing subaccount ID. Can be edited after the Opportunity is Accepted.
`extensions_count`	`int32` Output only. Number of extensions for rebate.
`gcp_project_numbers[]`	`string` Optional. Google Cloud project numbers. Can be edited after the Opportunity is Accepted. Can only be numeric values.
`submit_time`	`Timestamp` Output only. Timestamp when the Opportunity was last submitted.
`approve_time`	`Timestamp` Output only. Timestamp when the Opportunity was approved.
`partner_view_type`	`PartnerViewType` Output only. Indicates what view the partner has access to.

IncentiveType

Incentive Type.

Enums
`INCENTIVE_TYPE_UNSPECIFIED`	Not used.
`DEAL_REGISTRATION`	Deal Registration incentive.
`DEAL_REFERRAL`	Deal Referral incentive.

PartnerViewType

Partner View Type for the Opportunity.

Enums
`PARTNER_VIEW_TYPE_UNSPECIFIED`	Not used.
`FULL`	Partner has access to all the fields in the Opportunity.
`LIMITED`	Partner has access to limited fields in the Opportunity. Non-sourcing service Partners have limited view. No updates are allowed on the Opportunity in LIMITED view.

PaymentPlan

Describes how the reseller will be billed.

Enums
`PAYMENT_PLAN_UNSPECIFIED`	Not used.
`COMMITMENT`	Commitment.
`FLEXIBLE`	No commitment.
`FREE`	Free.
`TRIAL`	Trial.
`OFFLINE`	Price and ordering not available through API.

PaymentType

Specifies when the payment needs to happen.

Enums
`PAYMENT_TYPE_UNSPECIFIED`	Not used.
`PREPAY`	Prepay. Amount has to be paid before service is rendered.
`POSTPAY`	Postpay. Reseller is charged at the end of the Payment cycle.

PercentageAdjustment

An adjustment that applies a flat markup or markdown to an entire bill.

Fields

percentage

Decimal

The percentage of the bill to adjust. For example: Mark down by 1% => "-1.00" Mark up by 1% => "1.00" Pass-Through => "0.00"

Period

Represents period in days/months/years.

Fields

duration

int32

Total duration of Period Type defined.

period_type

PeriodType

Period Type.

PeriodType

Period Type.

Enums
`PERIOD_TYPE_UNSPECIFIED`	Not used.
`DAY`	Day.
`MONTH`	Month.
`YEAR`	Year.

Plan

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

Fields
`payment_plan`	`PaymentPlan` Describes how a reseller will be billed.
`payment_type`	`PaymentType` Specifies when the payment needs to happen.
`payment_cycle`	`Period` Describes how frequently the reseller will be billed, such as once per month.
`trial_period`	`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.
`billing_account`	`string` Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers.

Price

Represents the price of the Offer.

Fields
`base_price`	`Money` Base price.
`discount`	`double` Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
`effective_price`	`Money` Effective Price after applying the discounts.
`price_period`	`Period` The time period with respect to which base and effective prices are defined. Example: 1 month, 6 months, 1 year, etc.
`external_price_uri`	`string` Link to external price list, such as link to Google Voice rate card.
`discount_components[]`	`DiscountComponent` Breakdown of the discount into its components. This will be empty if there is no discount present.

PriceByResource

Represents price by resource type.

Fields

resource_type

ResourceType

Resource Type. Example: SEAT

price

Price

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

price_phases[]

PricePhase

Specifies the price by time range.

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.

Fields
`period_type`	`PeriodType` Defines the phase period type.
`first_period`	`int32` Defines first period for the phase.
`last_period`	`int32` Defines first period for the phase.
`price`	`Price` Price of the phase. Present if there are no price tiers.
`price_tiers[]`	`PriceTier` Price by the resource tiers.

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.

Fields

first_resource

int32

First resource for which the tier price applies.

last_resource

int32

Last resource for which the tier price applies.

price

Price

Price of the tier.

Product

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

Fields

name

string

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

marketing_info

MarketingInfo

Marketing information for the product.

ProductAuthorization

The product and region pairs that a reseller may be authorized to sell.

Fields
`sell_type`	`SellType` The type of reseller this ProductAuthorization corresponds to.
`authorized_product_family`	`AuthorizedProductFamily` The family of Google products that the reseller may be authorized to sell.
`region`	`Region` The region where this reseller is authorized to sell this product family.
`state`	`State` The state of this product authorization.

AuthorizedProductFamily

The family of Google products that the reseller may be authorized to sell.

Enums
`AUTHORIZED_PRODUCT_FAMILY_UNSPECIFIED`	Default value. Does not display if there are no errors.
`GOOGLE_CLOUD_PLATFORM`	Google Cloud
`CHROME_ENTERPRISE`	Chrome. Deprecated: Use `AuthorizedProductFamily.CHROME` instead. This item is deprecated!
`GOOGLE_WORKSPACE`	Google Workspace
`GOOGLE_MAPS_PLATFORM`	Google Maps
`CHROME`	Chrome
`GOOGLE_WORKSPACE_FOR_EDUCATION`	Google Workspace for Education

Region

The region where this reseller is authorized to sell this product family.

Enums
`REGION_UNSPECIFIED`	Default value. Does not display if there are no errors.
`ANZ`	Australia & New Zealand
`CEE`	Central & Eastern Europe
`DACH`	Germany, Austria, & Switzerland
`FRANCE`	France
`GLOBAL`	Global
`INDIA`	India
`JAPAN`	Japan
`LATAM_BRAZIL`	LATAM - Brazil
`LATAM_SPANISH_SPEAKING`	LATAM - Spanish speaking
`NE`	Northern Europe
`NORTH_AMERICA`	North America
`OTHER_ASIA_PACIFIC`	Other Asia Pacific
`SEEMEA`	Southern Europe and Emerging Markets
`UK_AND_I`	UK & Ireland

SellType

The type of reseller this ProductAuthorization corresponds to.

Enums
`SELL_TYPE_UNSPECIFIED`	Default value. Does not display if there are no errors.
`ONE_TIER`	Reseller sells directly through Google.
`TWO_TIER`	Reseller sells through a distributor.

State

The state of this product authorization.

Enums
`STATE_UNSPECIFIED`	Default value. Does not display if there are no errors.
`INTERESTED`	The default status for an authorization. Stays set while the partner works on the authorization tasks.
`ACTIVE`	Shows that the partner has completed their requisite tasks and can sell the product family in the corresponding region.
`SUBMITTED`	Set when a partner submits the authorization for Google's review.
`INACTIVE`	Used to indicate the authorization is no longer active.
`SUSPENDED`	Used when a partner no longer meets the authorization requirements. Stays set while the partner works on meeting the requirements.
`REJECTED`	Indicates that the application was rejected.
`OFFBOARDING`	Used when the partner is no longer authorized to do business, regardless of reason.

PromotionalOrderType

Constraints type for Promotional offers.

Enums
`PROMOTIONAL_TYPE_UNSPECIFIED`	Not used.
`NEW_UPGRADE`	Order used for new customers, trial conversions and upgrades.
`TRANSFER`	All orders for transferring an existing customer.
`PROMOTION_SWITCH`	Orders for modifying an existing customer's promotion on the same SKU.

ProvisionCloudIdentityRequest

Request message for CloudChannelService.ProvisionCloudIdentity

Fields
`customer`	`string` Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
`cloud_identity_info`	`CloudIdentityInfo` CloudIdentity-specific customer information.
`user`	`AdminUser` Admin user information.
`validate_only`	`bool` Validate the request and preview the review, but do not post it.

ProvisionableCloudIdentityType

A Cloud identity type, if you can provision it, and why. Used in the ListProvisionableCloudIdentityTypes response.

Fields

customer_type

CustomerType

Customer Type

is_eligible

bool

If you can create a customer with that type.

ineligibility_reason

Reason

Optional. Only shown if is_eligible = false.

Reason

Enums to represent why the specified customer Type is not eligible for a provision.

Enums
`REASON_UNSPECIFIED`	Not used.
`TRANSFER_REQUIRED`	Transfer is required to have a Cloud Identity with that domain. This item is deprecated!
`DOMAIN_CUSTOMER_EXISTS`	Reseller already owns a Domain customer with that domain.
`TEAM_CUSTOMER_EXISTS`	Only Team customers can be created for this domain
`TAKEOVER_IN_PROGRESS`	Domain is in the process of converting from Team to Domain.
`CONFLICTING_SKUS_EXIST`	Deprecated: All combinations of skus are now allowed so the concept of conflicting skus no longer exists. This item is deprecated!
`IMPORT_REQUIRED`	Dasher customer already exists, and the reseller has purchase relationship with the customer.

ProvisionedService

Service provisioned for an entitlement.

Fields

provisioning_id

string

Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.

product_id

string

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

sku_id

string

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

PurchasableOffer

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

Fields

offer

Offer

Offer.

price_reference_id

string

PurchasableSku

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

Fields

sku

Sku

SKU

PurchaseEligibility

Specifies purchase eligibility of a SKU.

Fields

is_eligible

bool

Whether reseller is eligible to purchase the SKU.

description

string

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

ineligibility_reason

Reason

Specified the reason for ineligibility.

Reason

Reason of ineligibility.

Enums
`REASON_UNSPECIFIED`	Not used.
`ACCEPT_TOS`	Reseller needs to accept TOS before purchasing the SKU.

QualificationInfo

Qualification information for the Opportunity.

Fields
`deal_number`	`string` Output only. System generated unique deal identifier.
`operation_type`	`OperationType` Required. Transaction Operation type for which the Opportunity is being created.
`contract_length_months`	`int32` Required. Contract terms in months. Can't be edited for ISV Opportunity after they are Accepted.
`quantity`	`int32` Optional. Number of seats or licenses. Default: 1. Can't be edited after the Opportunity is Accepted.
`deal_size`	`Money` Required. Target budget/estimated cost. Can't be edited after the Opportunity is Accepted.
`estimated_close_date`	`Date` Required. Target deal close date in UTC. Can't be edited after the Opportunity is Accepted.
`public_sector`	`bool` Optional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can't be edited after the Opportunity is Accepted. Default: false.
`budget`	`Budget` Optional. Budget. Can't be edited after the Opportunity is Accepted. Required for Regular and 2-Tier Opportunity, optional for ISV Opportunity.
`authority`	`Authority` Optional. Authority. Can't be edited after the Opportunity is Accepted. Required for Regular and 2-Tier Opportunity, optional for ISV Opportunity.
`need`	`Need` Optional. Need. Can't be edited after the Opportunity is Accepted. Required for Regular and 2-Tier Opportunity, optional for ISV Opportunity.
`timeline`	`Timeline` Optional. Timeline. Can't be edited after the Opportunity is Accepted. Required for Regular and 2-Tier Opportunity, optional for ISV Opportunity.
`campaign_code`	`string` Optional. Valid campaign name for the selected customer's region and products. Ex: "CA-0072131 - 2023 H1 - PPF - Modernize SaaS apps onto GCP".
`mssp_deal`	`bool` Optional. Flag to highlight if the partner will also act as MSSP (Managed Security Service Provided).
`legal_language_accepted`	`bool` Required. Is the legal_language accepted? Must be true for the Opportunity to be created. Can't be edited after the Opportunity is Accepted. T&C is listed here: https://docs.google.com/document/d/1UvQQtoZ6xiBCGoz0nJFNo-O80iR9faeHzQdWUfnEGTg/edit
`decision_phase`	`DecisionPhase` Required. Decision Phase.
`public_tender_attestation`	`bool` Optional. For the Partner to attest if this is a U.S. Public Tender opportunity. Only required for Public Sector opportunities. Can't be edited after the Opportunity is Accepted.

Authority

Authority.

Enums
`AUTHORITY_UNSPECIFIED`	Not used.
`CONFIRMED_NO_AUTHORITY_DECIDED`	Confirmed no authority decided.
`DONT_KNOW`	Don't know the authority.
`CLEARLY_IDENTIFIED_PROCESS`	Clearly identified process.
`VAGUE_UNDERSTANDING`	Vague understanding.

Budget

Budget.

Enums
`BUDGET_UNSPECIFIED`	Not used.
`BUDGET_EXISTS_NOT_SPECIFIED`	Budget exists, not specified.
`CONFIRMED_NO_BUDGET`	Confirmed no budget.
`EXACT_BUDGET_GIVEN`	Exact budget given.
`REFUSE_TO_DISCLOSE`	Refuse to disclose.

DecisionPhase

Decision Phase.

Enums
`DECISION_PHASE_UNSPECIFIED`	Not used.
`INFORMATION_GATHERING`	Initial research and information gathering
`TRIAL_OR_PILOT`	Currently in-trial or looking to trial/pilot
`FINAL_DECISION`	Final decision

Need

Need.

Enums
`NEED_UNSPECIFIED`	Not used.
`CLEAR_NEED`	Clear need.
`COMPELLING_NEED`	Compelling need.
`NO_NEED`	No need.

OperationType

Transaction Operation type.

Enums
`OPERATION_TYPE_UNSPECIFIED`	Not used.
`NEW`	New.
`RENEWAL`	Renewal.
`ADD_ON`	Add-on.
`EXPANSION`	Expansion - user increase or upgrade.

Timeline

Timeline.

Enums
`TIMELINE_UNSPECIFIED`	Not used.
`CONFIRMED_NO_DECISION_DATE`	Confirmed no decision date.
`REFUSED_TO_GIVE_DATE`	Refused to give date.
`SPECIFIC_DECISION_DATES_GIVEN`	Specific decision dates given.
`VAGUE_DECISION_DATES_GIVEN`	Vague decision dates given.

QueryEligibleBillingAccountsRequest

Request message for QueryEligibleBillingAccounts.

Fields

customer

string

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

skus[]

string

Required. List of SKUs to list eligible billing accounts for. At least one SKU is required. Format: products/{product_id}/skus/{sku_id}.

QueryEligibleBillingAccountsResponse

Response message for QueryEligibleBillingAccounts.

Fields

sku_purchase_groups[]

SkuPurchaseGroup

List of SKU purchase groups where each group represents a set of SKUs that must be purchased using the same billing account. Each SKU from [QueryEligibleBillingAccountsRequest.skus] will appear in exactly one SKU group.

QueryOpportunitiesRequest

Request message for CloudChannelService.QueryOpportunities

Fields

partner

string

Required. Provide the Partner ID for which the Opportunities are being queried. Format: partner = partners/{id}

page_size

int32

Optional. The maximum number of opportunities to return. The service might return fewer than this value. If unspecified, at most 50 opportunities are returned. The maximum value is 100; values above 100 are coerced to 100.

page_token

string

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

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

filter

string

Optional. Filters on the Opportunity . Currently supports filtering on the following fields:

state
stage
partner_info.rebate_expiration_date
sales_cycle.close_date
source
customer_display_name
partner_info.incentive_eligibility ,
qualification_info.campaign_code
update_time

For information on the filter format, see https://google.aip.dev/160 .

order_by

string

Optional. Sort order of the Opportunity . Currently supports sorting on the following fields:

state
stage
partner_info.rebate_expiration_date
sales_cycle.close_date
source
opportunity_info.display_name
customer_display_name
opportunity_info.product_category
update_time

For information on the sort format, see https://google.aip.dev/132#ordering .

QueryOpportunitiesResponse

Response message for CloudChannelService.QueryOpportunities

Fields

opportunities[]

Opportunity

The opportunities for the specified partner.

next_page_token

string

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

total_size

int32

Total Number of Opportunties for the given filter.

RebateExtension

Rebate Extension.

Fields
`request_number`	`string` Output only. Extension Request number.
`extension_reason`	`ExtensionReason` Output only. Extension Reason.
`extension_status`	`ExtensionStatus` Output only. Extension Status.
`extension_rejection_reason`	`ExtensionRejectionReason` Output only. Extension Rejection Reason.
`comments`	`string` Output only. Comments.

ExtensionReason

Extension Reason.

Enums
`EXTENSION_REASON_UNSPECIFIED`	Not used.
`OTHER_EXTENSION_REASON`	Other.
`CUSTOMER_ENGAGEMENT_DELAYED`	Customer Engagement Delayed.
`PROOF_OF_CONCEPT_LONGER_THAN_EXPECTED`	Proof of Concept Longer Than Expected.
`COMPLEX_DEAL`	Complex Deal

ExtensionRejectionReason

Extension Rejection Reason.

Enums
`EXTENSION_REJECTION_REASON_UNSPECIFIED`	Not used.
`OTHER_EXTENSION_REJECTION_REASON`	Other.
`LACK_OF_PARTNER_ENGAGEMENT`	Lack of Partner Engagement.
`NEGATIVE_CUSTOMER_FEEDBACK`	Negative Customer Feedback
`PPS_REJECTION`	PPS Rejection.

ExtensionStatus

Extension Status.

Enums
`EXTENSION_STATUS_UNSPECIFIED`	Not used.
`SUBMITTED`	Submitted.
`APPROVED`	Approved.
`REJECTED`	Rejected.

RebillingBasis

Specifies the different costs that the modified bill can be based on.

Enums
`REBILLING_BASIS_UNSPECIFIED`	Not used.
`COST_AT_LIST`	Use the list cost, also known as the MSRP.
`DIRECT_CUSTOMER_COST`	Pass through all discounts except the Reseller Program Discount. If this is the default cost base and no adjustments are specified, the output cost will be exactly what the customer would see if they viewed the bill in the Google Cloud Console.

RegisterSubscriberRequest

Request Message for RegisterSubscriber.

Fields

account

string

Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.

service_account

string

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

integrator

string

Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.

RegisterSubscriberResponse

Response Message for RegisterSubscriber.

Fields

topic

string

Name of the topic the subscriber will listen to.

RenewalSettings

Renewal settings for renewable Offers.

Fields
`enable_renewal`	`bool` If false, the plan will be completed at the end date.
`resize_unit_count`	`bool` 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.
`disable_commitment (deprecated)`	`bool` This item is deprecated! If true, disables commitment-based offer on renewal and switches to flexible or pay as you go. Deprecated: Use `payment_plan` instead.
`payment_option (deprecated)`	`PaymentOption` This item is deprecated! Set if enable_renewal=true. Deprecated: Use `payment_cycle` instead.
`payment_plan`	`PaymentPlan` Describes how a reseller will be billed.
`payment_cycle`	`Period` Describes how frequently the reseller will be billed, such as once per month.
`scheduled_renewal_offer`	`string` Output only. The offer resource name that the entitlement will renew on at the end date. Takes the form: accounts/{account_id}/offers/{offer_id}.

PaymentOption

Determines scheduled payment frequency.

Enums
`PAYMENT_OPTION_UNSPECIFIED`	Not used.
`ANNUAL`	Paid in yearly installments.
`MONTHLY`	Paid in monthly installments.

Report

The ID and description of a report that was used to generate report data. For example, "Google Cloud Daily Spend", "Google Workspace License Activity", etc.

Fields
`name`	`string` Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q` ). Name uses the format: accounts/{account_id}/reports/{report_id}
`display_name`	`string` A human-readable name for this report.
`columns[]`	`Column` The list of columns included in the report. This defines the schema of the report results.
`description`	`string` A description of other aspects of the report, such as the products it supports.

ReportJob

The result of a [RunReportJob][] operation. Contains the name to use in FetchReportResultsRequest.report_job and the status of the operation.

Fields

name

string

Required. The resource name of a report job. Name uses the format: accounts/{account_id}/reportJobs/{report_job_id}

report_status

ReportStatus

The current status of report generation.

ReportResultsMetadata

The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults .

Fields
`report`	`Report` Details of the completed report.
`row_count`	`int64` The total number of rows of data in the final report.
`date_range`	`DateRange` The date range of reported usage.
`preceding_date_range`	`DateRange` The usage dates immediately preceding `date_range` with the same duration. Use this to calculate trending usage and costs. This is only populated if you request trending data. For example, if `date_range` is July 1-15, `preceding_date_range` will be June 16-30.

ReportStatus

Status of a report generation process.

Fields

state

State

The current state of the report generation process.

start_time

Timestamp

The report generation's start time.

end_time

Timestamp

The report generation's completion time.

State

Available states of report generation.

Enums
`STATE_UNSPECIFIED`	Not used.
`STARTED`	Report processing started.
`WRITING`	Data generated from the report is being staged.
`AVAILABLE`	Report data is available for access.
`FAILED`	Report failed.

ReportValue

A single report value.

Fields

Union field value . A single report value. value can be only one of the following:

string_value

string

A value of type string .

int_value

int64

A value of type int .

decimal_value

Decimal

A value of type google.type.Decimal , representing non-integer numeric values.

money_value

Money

A value of type google.type.Money (currency code, whole units, decimal units).

date_value

Date

A value of type google.type.Date (year, month, day).

date_time_value

DateTime

A value of type google.type.DateTime (year, month, day, hour, minute, second, and UTC offset or timezone.)

RepricingAdjustment

A type that represents the various adjustments you can apply to a bill.

Fields

Union field adjustment . A oneof that represents the different types for this adjustment. adjustment can be only one of the following:

percentage_adjustment

PercentageAdjustment

Flat markup or markdown on an entire bill.

RepricingCondition

Represents the various repricing conditions you can use for a conditional override.

Fields

Union field condition . Represents the types of existing conditional statements. condition can be only one of the following:

sku_group_condition

SkuGroupCondition

SKU Group condition for override.

RepricingConfig

Configuration for repricing a Google bill over a period of time.

Fields

effective_invoice_month

Date

Required. The YearMonth when these adjustments activate. The Day field needs to be "0" since we only accept YearMonth repricing boundaries.

adjustment

RepricingAdjustment

Required. Information about the adjustment.

rebilling_basis

RebillingBasis

Required. The RebillingBasis to use for this bill. Specifies the relative cost based on repricing costs you will apply.

conditional_overrides[]

ConditionalOverride

The conditional overrides to apply for this configuration. If you list multiple overrides, only the first valid override is used. If you don't list any overrides, the API uses the normal adjustment and rebilling basis.

Union field granularity . Required. Defines the granularity for repricing. granularity can be only one of the following:

entitlement_granularity

EntitlementGranularity

Required. Applies the repricing configuration at the entitlement level.

Note: If a ChannelPartnerRepricingConfig using RepricingConfig.EntitlementGranularity becomes effective, then no existing or future RepricingConfig.ChannelPartnerGranularity will apply to the RepricingConfig.EntitlementGranularity.entitlement . This is the recommended value for both CustomerRepricingConfig and ChannelPartnerRepricingConfig .

channel_partner_granularity
 (deprecated)

ChannelPartnerGranularity

Applies the repricing configuration at the channel partner level. Only ChannelPartnerRepricingConfig supports this value. Deprecated: This is no longer supported. Use RepricingConfig.entitlement_granularity instead.

ChannelPartnerGranularity

This type has no fields.

Applies the repricing configuration at the channel partner level. The channel partner value is derived from the resource name. Takes an empty json object. Deprecated: This is no longer supported. Use RepricingConfig.EntitlementGranularity instead.

EntitlementGranularity

Applies the repricing configuration at the entitlement level.

Fields

entitlement

string

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

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.

Enums
`RESOURCE_TYPE_UNSPECIFIED`	Not used.
`SEAT`	Seat.
`MAU`	Monthly active user.
`GB`	GB (used for storage SKUs).
`LICENSED_USER`	Active licensed users(for Voice SKUs).
`MINUTES`	Voice usage.
`IAAS_USAGE`	For IaaS SKUs like Google Cloud, monetization is based on usage accrued on your billing account irrespective of the type of monetizable resource. This enum represents an aggregated resource/container for all usage SKUs on a billing account. Currently, only applicable to Google Cloud.
`SUBSCRIPTION`	For Google Cloud subscriptions like Anthos or SAP.

Row

A row of report values.

Fields

values[]

ReportValue

The list of values in the row.

partition_key

string

The key for the partition this row belongs to. This field is empty if the report is not partitioned.

RunReportJobRequest

Request message for CloudChannelReportsService.RunReportJob .

Fields
`name`	`string` Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q` ). Name uses the format: accounts/{account_id}/reports/{report_id}
`date_range`	`DateRange` Optional. The range of usage or invoice dates to include in the result.
`filter`	`string` Optional. A structured string that defines conditions on dimension columns to restrict the report output. Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using `column_id` as keys. For example: `(customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022`
`language_code`	`string` Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

RunReportJobResponse

Response message for CloudChannelReportsService.RunReportJob .

Fields

report_job

ReportJob

Pass report_job.name to FetchReportResultsRequest.report_job to retrieve the report's results.

report_metadata

ReportResultsMetadata

The metadata for the report's results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data.

SalesCycle

Information on the sales cycle.

Fields
`close_date`	`Date` Output only. For open opportunities, this is the expected close date. For closed opportunities, this is the contract signed date. Available in Limited view.
`partner_ready_to_close`	`PartnerCloseStage` Partner ready to close info. Can be edited after the Opportunity is Accepted.
`close_date_push_count`	`int32` Output only. Number of times close date is pushed/changed.
`prm_site_details`	`string` Output only. PRM site details.

PartnerCloseStage

Partner close stage

Enums
`PARTNER_CLOSE_STAGE_UNSPECIFIED`	Not used.
`MIGRATION_IMPL`	Stage 4 - Migration or Implementation. Represents Closed/Won stage.
`CLOSED_LOST`	Closed lost.

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.

Fields

name

string

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

marketing_info

MarketingInfo

Marketing information for the SKU.

product

Product

Product the SKU is associated with.

SkuGroup

Represents the SKU group information.

Fields

name

string

Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041".

display_name

string

Unique human readable identifier for the SKU group.

SkuGroupCondition

A condition that applies the override if a line item SKU is found in the SKU group.

Fields

sku_group

string

Specifies a SKU group ( https://cloud.google.com/skus/sku-groups) . Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041".

SkuPurchaseGroup

Represents a set of SKUs that must be purchased using the same billing account.

Fields

skus[]

string

Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}.

billing_account_purchase_infos[]

BillingAccountPurchaseInfo

List of billing accounts that are eligible to purhcase these SKUs.

StartPaidServiceRequest

Request message for CloudChannelService.StartPaidService .

Fields

name

string

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}

external_correlation_id

string

Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.

request_id

string

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.

The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000 ).

SubscriberEvent

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

Fields

Union field event . Specifies the Pub/Sub event provided to the partners. This is a required field. event can be only one of the following:

customer_event

CustomerEvent

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

entitlement_event

EntitlementEvent

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

channel_partner_event

ChannelPartnerEvent

Channel Partner event sent as part of Pub/Sub event to partners.

opportunity_event

OpportunityEvent

Opportunity event sent as part of Pub/Sub event to partners/integrators.

SuspendEntitlementRequest

Request message for CloudChannelService.SuspendEntitlement .

Fields

name

string

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

external_correlation_id

string

Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.

request_id

string

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.

The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000 ).

TransferEligibility

Specifies transfer eligibility of a SKU.

Fields

is_eligible

bool

Whether reseller is eligible to transfer the SKU.

description

string

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

ineligibility_reason

Reason

Specified the reason for ineligibility.

Reason

Reason of ineligibility.

Enums
`REASON_UNSPECIFIED`	Not used.
`PENDING_TOS_ACCEPTANCE`	Reseller needs to accept TOS before transferring the SKU.
`SKU_NOT_ELIGIBLE`	Reseller not eligible to sell the SKU.
`SKU_SUSPENDED`	SKU subscription is suspended
`CHANNEL_PARTNER_NOT_AUTHORIZED_FOR_SKU`	The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

TransferEntitlementsRequest

Request message for CloudChannelService.TransferEntitlements .

Fields
`parent`	`string` 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}
`entitlements[]`	`Entitlement` Required. The new entitlements to create or transfer.
`enable_delegated_admin (deprecated)`	`bool` This item is deprecated! Optional. If true, grants delegated admin rights for fulfilled entitlements to the channel partner. Applicable only if you provide an Entitlement.channel_partner_id.
`auth_token`	`string` 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.
`external_correlation_id`	`string` Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
`request_id`	`string` 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` ).

TransferEntitlementsResponse

Response message for CloudChannelService.TransferEntitlements . This is put in the response field of google.longrunning.Operation.

Fields

entitlements[]

Entitlement

The transferred entitlements.

TransferEntitlementsToGoogleRequest

Request message for CloudChannelService.TransferEntitlementsToGoogle .

Fields

parent

string

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}

entitlements[]

Entitlement

Required. The entitlements to transfer to Google.

request_id

string

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.

The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000 ).

TransferableOffer

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

Fields

offer

Offer

Offer with parameter constraints updated to allow the Transfer.

price_reference_id

string

TransferableSku

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

Fields
`product_id (deprecated)`	`string` This item is deprecated! The product pertaining to the provisioning resource as specified in the Offer. Deprecated: Use `sku.product.name` instead.
`sku_id (deprecated)`	`string` This item is deprecated! The SKU pertaining to the provisioning resource as specified in the Offer. Deprecated: Use `sku.name` instead.
`num_units (deprecated)`	`int32` This item is deprecated! Number of units for a commitment-based Offer. For example, for seat-based offers, this would be the number of seats; for license-based offers, this would be the number of licenses. Deprecated: Use `ListTransferableOffers` API instead.
`max_units (deprecated)`	`int32` This item is deprecated! Maximum number of units for a non-commitment-based offer, such as Flexible or Trial. Deprecated: Use `ListTransferableOffers` API instead.
`purchase_eligibility (deprecated)`	`PurchaseEligibility` This item is deprecated! Describes the purchase eligibility of a SKU. Deprecated: Use `transfer_eligibility` instead.
`is_commitment (deprecated)`	`BoolValue` This item is deprecated! Whether a transferable SKU is commitment-based or not. Deprecated: Use `ListTransferableOffers` API instead.
`commitment_end_timestamp (deprecated)`	`Timestamp` This item is deprecated! Commitment end timestamp. Deprecated: Use `ListTransferableOffers` API instead.
`assigned_units (deprecated)`	`int32` This item is deprecated! The current number of users that are assigned a license for the sku_id. This cannot be reduced during a transfer. Deprecated: Use `ListTransferableOffers` API instead.
`transfer_eligibility`	`TransferEligibility` Describes the transfer eligibility of a SKU.
`sku_display_name (deprecated)`	`string` This item is deprecated! Human readable SKU name. This field can be used by resellers if the transferable SKU is not available in their offers. Deprecated: Use `sku.marketing_info.display_name` instead.
`sku`	`Sku` The SKU pertaining to the provisioning resource as specified in the Offer.
`legacy_sku`	`Sku` Optional. The customer to transfer has an entitlement with the populated legacy SKU.

TrialSettings

Settings for trial offers.

Fields

trial

bool

Determines if the entitlement is in a trial or not:

true - The entitlement is in trial.
false - The entitlement is not in trial.

end_time

Timestamp

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

UnregisterSubscriberRequest

Request Message for UnregisterSubscriber.

Fields

account

string

Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.

service_account

string

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

integrator

string

Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.

UnregisterSubscriberResponse

Response Message for UnregisterSubscriber.

Fields

topic

string

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

UpdateChannelPartnerLinkRequest

Request message for CloudChannelService.UpdateChannelPartnerLink

Fields

name

string

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.

channel_partner_link

ChannelPartnerLink

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

update_mask

FieldMask

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

UpdateChannelPartnerRepricingConfigRequest

Request message for CloudChannelService.UpdateChannelPartnerRepricingConfig .

Fields

channel_partner_repricing_config

ChannelPartnerRepricingConfig

Required. The ChannelPartnerRepricingConfig object to update.

UpdateCustomerRepricingConfigRequest

Request message for CloudChannelService.UpdateCustomerRepricingConfig .

Fields

customer_repricing_config

CustomerRepricingConfig

Required. The CustomerRepricingConfig object to update.

UpdateCustomerRequest

Request message for CloudChannelService.UpdateCustomer .

Fields

name
 (deprecated)

string

Deprecated: Set Customer.name instead Name uses the format: accounts/{account_id}/customers/{customer_id}

customer

Customer

Required. New contents of the customer.

update_mask

FieldMask

The update mask that applies to the resource. Optional.

UpdateOpportunityRequest

Request message for CloudChannelService.UpdateOpportunity

Fields

opportunity

Opportunity

Required. The opportunity to update.

The opportunity's name field is used to identify the opportunity to update. Format: opportunities/{opportunity}

update_mask

FieldMask

Required. The list of fields to update.

partner

string

Required. Provide the Partner Id for which the Opportunity is being updated. Format: partner = partners/{id}

Value

Data type and value of a parameter.

Fields

Union field kind . The kind of value. kind can be only one of the following:

int64_value

int64

Represents an int64 value.

string_value

string

Represents a string value.

double_value

double

Represents a double value.

proto_value

Any

Represents an 'Any' proto value.

bool_value

bool

Represents a boolean value.

WinLossInfo

Win Loss Details.

Fields
`lost_reason`	`string` Output only. Lost reason.
`lost_main_reason`	`string` Output only. Lost main reason.
`lost_rejected_reason_details`	`string` Output only. Lost rejected reason details.
`win_main_reason`	`string` Output only. Win main reason.
`won_reason`	`string` Output only. Won reason.
`win_loss_products[]`	`string` Output only. Win/loss products.
`win_loss_additional_context`	`string` Output only. Win/loss additional context.

Package google.cloud.channel.v1alpha1 Stay organized with collections Save and categorize content based on your preferences.

Index

CloudChannelReportsService

CloudChannelService

ActivateEntitlementRequest

AdminUser

AssignChannelPartnerRequest

AssociationInfo

BillableSku

BillingAccount

BillingAccountPurchaseInfo

CancelEntitlementRequest

ChangeOfferRequest

ChangeParametersRequest

ChangePlanRequest

ChangeQuantityRequest

ChangeRenewalSettingsRequest

ChangeSkuRequest

ChannelPartnerEvent

Type

ChannelPartnerLink

ChannelPartnerLinkState

ChannelPartnerLinkView

ChannelPartnerRepricingConfig

CheckCloudIdentityAccountsExistRequest

CheckCloudIdentityAccountsExistResponse

CloudIdentityCustomerAccount

CloudIdentityInfo

CustomerType

Column

DataType

CommitmentSettings

ConditionalOverride

Constraints

Contact

ContactInfo

CreateChannelPartnerLinkRequest

CreateChannelPartnerRepricingConfigRequest

CreateCustomerRepricingConfigRequest

CreateCustomerRequest

CreateEntitlementRequest

CreateOpportunityRequest

Customer

CustomerAttestationState

CustomerConstraints

CustomerContact

Role

CustomerDetails

Industry

CustomerEvent

Type

CustomerInfo

Region

CustomerRepricingConfig

DateRange

DeleteChannelPartnerRepricingConfigRequest

DeleteCustomerRepricingConfigRequest

DeleteCustomerRequest

DiscountComponent

DiscountType

EduData

InstituteSize

InstituteType

Entitlement

ProvisioningState

SuspensionReason

EntitlementChange

ActivationReason

CancellationReason

ChangeType

OperatorType

EntitlementEvent

Type

FetchReportResultsRequest

FetchReportResultsResponse

GetChannelPartnerLinkRequest

GetChannelPartnerRepricingConfigRequest

GetCustomerRepricingConfigRequest

GetCustomerRequest

GetEntitlementRequest

Package google.cloud.channel.v1alpha1