Class CloudChannelServiceGrpc.CloudChannelServiceBlockingStub (3.16.0)

public static final class CloudChannelServiceGrpc.CloudChannelServiceBlockingStub extends AbstractBlockingStub<CloudChannelServiceGrpc.CloudChannelServiceBlockingStub>

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

Resellers and distributors can manage a customer entity.
Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > CloudChannelServiceGrpc.CloudChannelServiceBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

activateEntitlement(ActivateEntitlementRequest request)

public Operation activateEntitlement(ActivateEntitlementRequest request)

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.

Parameter

Name	Description
`request`	`ActivateEntitlementRequest`

Returns

Type	Description
`Operation`

build(Channel channel, CallOptions callOptions)

protected CloudChannelServiceGrpc.CloudChannelServiceBlockingStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns

Type	Description
`CloudChannelServiceGrpc.CloudChannelServiceBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelEntitlement(CancelEntitlementRequest request)

public Operation cancelEntitlement(CancelEntitlementRequest request)

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.

Parameter

Name	Description
`request`	`CancelEntitlementRequest`

Returns

Type	Description
`Operation`

changeOffer(ChangeOfferRequest request)

public Operation changeOffer(ChangeOfferRequest request)

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.

Parameter

Name	Description
`request`	`ChangeOfferRequest`

Returns

Type	Description
`Operation`

changeParameters(ChangeParametersRequest request)

public Operation changeParameters(ChangeParametersRequest request)

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.

Parameter

Name	Description
`request`	`ChangeParametersRequest`

Returns

Type	Description
`Operation`

changeRenewalSettings(ChangeRenewalSettingsRequest request)

public Operation changeRenewalSettings(ChangeRenewalSettingsRequest request)

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.

Parameter

Name	Description
`request`	`ChangeRenewalSettingsRequest`

Returns

Type	Description
`Operation`

checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request)

public CheckCloudIdentityAccountsExistResponse checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request)

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.

Parameter

Name	Description
`request`	`CheckCloudIdentityAccountsExistRequest`

Returns

Type	Description
`CheckCloudIdentityAccountsExistResponse`

createChannelPartnerLink(CreateChannelPartnerLinkRequest request)

public ChannelPartnerLink createChannelPartnerLink(CreateChannelPartnerLinkRequest request)

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.

Parameter

Name	Description
`request`	`CreateChannelPartnerLinkRequest`

Returns

Type	Description
`ChannelPartnerLink`

createChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest request)

public ChannelPartnerRepricingConfig createChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest request)

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.effective_invoice_month.
The contained ChannelPartnerRepricingConfig.repricing_config vaule 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.

Parameter

Name	Description
`request`	`CreateChannelPartnerRepricingConfigRequest`

Returns

Type	Description
`ChannelPartnerRepricingConfig`

createCustomer(CreateCustomerRequest request)

public Customer createCustomer(CreateCustomerRequest request)

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.

Parameter

Name	Description
`request`	`CreateCustomerRequest`

Returns

Type	Description
`Customer`

createCustomerRepricingConfig(CreateCustomerRepricingConfigRequest request)

public CustomerRepricingConfig createCustomerRepricingConfig(CreateCustomerRepricingConfigRequest request)

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 or RepricingConfig.effective_invoice_month.
The contained CustomerRepricingConfig.repricing_config vaule 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.

Parameter

Name	Description
`request`	`CreateCustomerRepricingConfigRequest`

Returns

Type	Description
`CustomerRepricingConfig`

createEntitlement(CreateEntitlementRequest request)

public Operation createEntitlement(CreateEntitlementRequest request)

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.

Parameter

Name	Description
`request`	`CreateEntitlementRequest`

Returns

Type	Description
`Operation`

deleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest request)

public Empty deleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`DeleteChannelPartnerRepricingConfigRequest`

Returns

Type	Description
`Empty`

deleteCustomer(DeleteCustomerRequest request)

public Empty deleteCustomer(DeleteCustomerRequest request)

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.

Parameter

Name	Description
`request`	`DeleteCustomerRequest`

Returns

Type	Description
`Empty`

deleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest request)

public Empty deleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`DeleteCustomerRepricingConfigRequest`

Returns

Type	Description
`Empty`

getChannelPartnerLink(GetChannelPartnerLinkRequest request)

public ChannelPartnerLink getChannelPartnerLink(GetChannelPartnerLinkRequest request)

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.

Parameter

Name	Description
`request`	`GetChannelPartnerLinkRequest`

Returns

Type	Description
`ChannelPartnerLink`

getChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest request)

public ChannelPartnerRepricingConfig getChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`GetChannelPartnerRepricingConfigRequest`

Returns

Type	Description
`ChannelPartnerRepricingConfig`

getCustomer(GetCustomerRequest request)

public Customer getCustomer(GetCustomerRequest request)

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.

Parameter

Name	Description
`request`	`GetCustomerRequest`

Returns

Type	Description
`Customer`

getCustomerRepricingConfig(GetCustomerRepricingConfigRequest request)

public CustomerRepricingConfig getCustomerRepricingConfig(GetCustomerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`GetCustomerRepricingConfigRequest`

Returns

Type	Description
`CustomerRepricingConfig`

getEntitlement(GetEntitlementRequest request)

public Entitlement getEntitlement(GetEntitlementRequest request)

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.

Parameter

Name	Description
`request`	`GetEntitlementRequest`

Returns

Type	Description
`Entitlement`

importCustomer(ImportCustomerRequest request)

public Customer importCustomer(ImportCustomerRequest request)

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

Parameter

Name	Description
`request`	`ImportCustomerRequest`

Returns

Type	Description
`Customer`

listChannelPartnerLinks(ListChannelPartnerLinksRequest request)

public ListChannelPartnerLinksResponse listChannelPartnerLinks(ListChannelPartnerLinksRequest request)

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

Parameter

Name	Description
`request`	`ListChannelPartnerLinksRequest`

Returns

Type	Description
`ListChannelPartnerLinksResponse`

listChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest request)

public ListChannelPartnerRepricingConfigsResponse listChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest request)

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.

Parameter

Name	Description
`request`	`ListChannelPartnerRepricingConfigsRequest`

Returns

Type	Description
`ListChannelPartnerRepricingConfigsResponse`

listCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest request)

public ListCustomerRepricingConfigsResponse listCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest request)

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.

Parameter

Name	Description
`request`	`ListCustomerRepricingConfigsRequest`

Returns

Type	Description
`ListCustomerRepricingConfigsResponse`

listCustomers(ListCustomersRequest request)

public ListCustomersResponse listCustomers(ListCustomersRequest request)

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.

Parameter

Name	Description
`request`	`ListCustomersRequest`

Returns

Type	Description
`ListCustomersResponse`

listEntitlements(ListEntitlementsRequest request)

public ListEntitlementsResponse listEntitlements(ListEntitlementsRequest request)

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.

Parameter

Name	Description
`request`	`ListEntitlementsRequest`

Returns

Type	Description
`ListEntitlementsResponse`

listOffers(ListOffersRequest request)

public ListOffersResponse listOffers(ListOffersRequest request)

Lists the Offers the reseller can sell. Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameter

Name	Description
`request`	`ListOffersRequest`

Returns

Type	Description
`ListOffersResponse`

listProducts(ListProductsRequest request)

public ListProductsResponse listProducts(ListProductsRequest request)

Lists the Products the reseller is authorized to sell. Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameter

Name	Description
`request`	`ListProductsRequest`

Returns

Type	Description
`ListProductsResponse`

listPurchasableOffers(ListPurchasableOffersRequest request)

public ListPurchasableOffersResponse listPurchasableOffers(ListPurchasableOffersRequest request)

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.

Parameter

Name	Description
`request`	`ListPurchasableOffersRequest`

Returns

Type	Description
`ListPurchasableOffersResponse`

listPurchasableSkus(ListPurchasableSkusRequest request)

public ListPurchasableSkusResponse listPurchasableSkus(ListPurchasableSkusRequest request)

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.

Parameter

Name	Description
`request`	`ListPurchasableSkusRequest`

Returns

Type	Description
`ListPurchasableSkusResponse`

listSkus(ListSkusRequest request)

public ListSkusResponse listSkus(ListSkusRequest request)

Lists the SKUs for a product the reseller is authorized to sell. Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameter

Name	Description
`request`	`ListSkusRequest`

Returns

Type	Description
`ListSkusResponse`

listSubscribers(ListSubscribersRequest request)

public ListSubscribersResponse listSubscribers(ListSubscribersRequest request)

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.

Parameter

Name	Description
`request`	`ListSubscribersRequest`

Returns

Type	Description
`ListSubscribersResponse`

listTransferableOffers(ListTransferableOffersRequest request)

public ListTransferableOffersResponse listTransferableOffers(ListTransferableOffersRequest request)

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 customer provided incorrect reseller information when generating auth token.
- 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.

Parameter

Name	Description
`request`	`ListTransferableOffersRequest`

Returns

Type	Description
`ListTransferableOffersResponse`

listTransferableSkus(ListTransferableSkusRequest request)

public ListTransferableSkusResponse listTransferableSkus(ListTransferableSkusRequest request)

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.

Parameter

Name	Description
`request`	`ListTransferableSkusRequest`

Returns

Type	Description
`ListTransferableSkusResponse`

lookupOffer(LookupOfferRequest request)

public Offer lookupOffer(LookupOfferRequest request)

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.

Parameter

Name	Description
`request`	`LookupOfferRequest`

Returns

Type	Description
`Offer`

provisionCloudIdentity(ProvisionCloudIdentityRequest request)

public Operation provisionCloudIdentity(ProvisionCloudIdentityRequest request)

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.

Parameter

Name	Description
`request`	`ProvisionCloudIdentityRequest`

Returns

Type	Description
`Operation`

registerSubscriber(RegisterSubscriberRequest request)

public RegisterSubscriberResponse registerSubscriber(RegisterSubscriberRequest request)

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.

Parameter

Name	Description
`request`	`RegisterSubscriberRequest`

Returns

Type	Description
`RegisterSubscriberResponse`

startPaidService(StartPaidServiceRequest request)

public Operation startPaidService(StartPaidServiceRequest request)

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.

Parameter

Name	Description
`request`	`StartPaidServiceRequest`

Returns

Type	Description
`Operation`

suspendEntitlement(SuspendEntitlementRequest request)

public Operation suspendEntitlement(SuspendEntitlementRequest request)

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.

Parameter

Name	Description
`request`	`SuspendEntitlementRequest`

Returns

Type	Description
`Operation`

transferEntitlements(TransferEntitlementsRequest request)

public Operation transferEntitlements(TransferEntitlementsRequest request)

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.

Parameter

Name	Description
`request`	`TransferEntitlementsRequest`

Returns

Type	Description
`Operation`

transferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request)

public Operation transferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request)

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.

Parameter

Name	Description
`request`	`TransferEntitlementsToGoogleRequest`

Returns

Type	Description
`Operation`

unregisterSubscriber(UnregisterSubscriberRequest request)

public UnregisterSubscriberResponse unregisterSubscriber(UnregisterSubscriberRequest request)

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.

Parameter

Name	Description
`request`	`UnregisterSubscriberRequest`

Returns

Type	Description
`UnregisterSubscriberResponse`

updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request)

public ChannelPartnerLink updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request)

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.

Parameter

Name	Description
`request`	`UpdateChannelPartnerLinkRequest`

Returns

Type	Description
`ChannelPartnerLink`

updateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest request)

public ChannelPartnerRepricingConfig updateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`UpdateChannelPartnerRepricingConfigRequest`

Returns

Type	Description
`ChannelPartnerRepricingConfig`

updateCustomer(UpdateCustomerRequest request)

public Customer updateCustomer(UpdateCustomerRequest request)

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.

Parameter

Name	Description
`request`	`UpdateCustomerRequest`

Returns

Type	Description
`Customer`

updateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest request)

public CustomerRepricingConfig updateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest request)

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.

Parameter

Name	Description
`request`	`UpdateCustomerRepricingConfigRequest`

Returns

Type	Description
`CustomerRepricingConfig`