Package google.cloud.channel.v1

Index

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: - Customers: An entity—usually an enterprise—managed by a reseller or distributor.

  • Entitlements: 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.

  • ChannelPartnerLinks: 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.

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.

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.

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.

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

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

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.

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.

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.

ListCustomers

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

List Customers.

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 Customers, 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.

ListEntitlements

rpc ListEntitlements(ListEntitlementsRequest) returns (ListEntitlementsResponse)

Lists Entitlements 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 Entitlements.

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.

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

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 Cloud Pub/Sub topic created for this Channel Services account.

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 TransferableOffers 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 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: 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 TransferableSkus 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.
  • 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.

RegisterSubscriber

rpc RegisterSubscriber(RegisterSubscriberRequest) returns (RegisterSubscriberResponse)

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. 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.
  • 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.

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.

UnregisterSubscriber

rpc UnregisterSubscriber(UnregisterSubscriberRequest) returns (UnregisterSubscriberResponse)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. 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.

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.

ActivateEntitlementRequest

Request message for CloudChannelService.ActivateEntitlement.

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}

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

AssociationInfo

Association links that an entitlement has to other entitlements.

Fields
base_entitlement

string

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

CancelEntitlementRequest

Request message for CloudChannelService.CancelEntitlement.

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}

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

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.

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

ChangeParametersRequest

Request message for [CloudChannelService.ChangeParametersRequest][].

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.

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.

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}

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

ChannelPartnerLinkState

ChannelPartnerLinkState represents state of a channel partner link.

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

CheckCloudIdentityAccountsExistRequest

Request message for CloudChannelService.CheckCloudIdentityAccountsExist.

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

CheckCloudIdentityAccountsExistResponse

Response message for CloudChannelService.CheckCloudIdentityAccountsExist.

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

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.

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 Default value. This state doesn't show unless an error occurs.
DOMAIN Domain-owning customer which needs domain verification to use services.
TEAM Team customer which needs email verification to use services.

CommitmentSettings

Commitment settings for commitment-based offers.

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.

Constraints

Represents the constraints for buying the Offer.

Fields
customer_constraints

CustomerConstraints

Represents constraints required to purchase the Offer for a customer.

ContactInfo

Contact information for a customer account.

Fields
first_name

string

The customer account contact's first name.

last_name

string

The customer account contact's last name.

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.

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
parent

string

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

CreateCustomerRequest

Request message for CloudChannelService.CreateCustomer

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.

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.

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

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 and zip code. 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.

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.

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.

CustomerConstraints

Represents constraints required to purchase the Offer for a customer.

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.

CustomerEvent

Represents Pub/Sub message content describing customer update.

Fields
customer

string

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

event_type

Type

Type of event which happened on the customer.

Type

Type of customer event.

Enums
TYPE_UNSPECIFIED Default value. This state doesn't show unless an error occurs.
PRIMARY_DOMAIN_CHANGED Primary domain for customer was changed.
PRIMARY_DOMAIN_VERIFIED Primary domain of the customer has been verified.

DeleteCustomerRequest

Request message for CloudChannelService.DeleteCustomer.

Fields
name

string

Required. The resource name of the customer to delete.

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 Default value. This state doesn't show unless an error occurs.
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 Default value. This state doesn't show unless an error occurs.
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.

offer

string

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

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.

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 parameters' names and values are defined in the offer's parameter definitions.

ProvisioningState

Indicates the current provisioning state of the entitlement.

Enums
PROVISIONING_STATE_UNSPECIFIED Default value. This state doesn't show unless an error occurs.
ACTIVE The entitlement is currently active.
SUSPENDED The entitlement is currently suspended.

SuspensionReason

Suspension reason for an entitlement if provisioning_state = SUSPENDED.

Enums
SUSPENSION_REASON_UNSPECIFIED Default value. This state doesn't show unless an error occurs.
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.).

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 on the entitlement.

Type

Type of entitlement event.

Enums
TYPE_UNSPECIFIED Default value. This state doesn't show unless an error occurs.
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.

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.

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}

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
next_page_token

string

A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.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.

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.

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

ListOffersResponse

Response message for ListOffers.

Fields
offers[]

Offer

The list of Offers requested.

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.

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}

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

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.

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

Required. Resource name of the account.

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.

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

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

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.

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.

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.

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 Default value. This state doesn't show unless an error occurs.
CREATE_ENTITLEMENT Long Running Operation was triggered by CreateEntitlement.
CHANGE_RENEWAL_SETTINGS Long Running Operation was triggered by ChangeRenewalSettings.
START_PAID_SERVICE Long Running Operation was triggered by StartPaidService.
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.

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.

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.

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

external_price_uri

string

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

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.

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.

ProvisionedService

Service provisioned for an entitlement.

Fields
provisioning_id

string

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

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.

PurchasableSku

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

Fields
sku

Sku

SKU

RegisterSubscriberRequest

Request Message for RegisterSubscriber.

Fields
account

string

Required. Resource name of the account.

service_account

string

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

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.

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.

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 Platform, 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 Platform.
SUBSCRIPTION For Google Cloud Platform subscriptions like Anthos or SAP.

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.

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}

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

SubscriberEvent

Represents information which resellers will get as part of notification from Cloud 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 send as part of Pub/Sub event to partners.

entitlement_event

EntitlementEvent

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

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}

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

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 Reason is not available.
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

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.

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.

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.

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

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.

TransferableSku

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

Fields
transfer_eligibility

TransferEligibility

Describes the transfer eligibility of a SKU.

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

Required. Resource name of the account.

service_account

string

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

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.

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.

UpdateCustomerRequest

Request message for CloudChannelService.UpdateCustomer.

Fields
customer

Customer

Required. New contents of the customer.

update_mask

FieldMask

The update mask that applies to the resource. Optional.

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.