Google Cloud Channel V1 Client - Class CloudChannelServiceClient (1.7.0)

Version 1.7.0

• 2.1.1 (latest)
• 2.1.0
• 2.0.0
• 1.9.5
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Channel V1 Client class CloudChannelServiceClient.

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

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Channel \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

activateEntitlement

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::activateEntitlementAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ActivateEntitlementRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

cancelEntitlement

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::cancelEntitlementAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CancelEntitlementRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

changeOffer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::changeOfferAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeOfferRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

changeParameters

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::changeParametersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeParametersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

changeRenewalSettings

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::changeRenewalSettingsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeRenewalSettingsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

checkCloudIdentityAccountsExist

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::checkCloudIdentityAccountsExistAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CheckCloudIdentityAccountsExistRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\CheckCloudIdentityAccountsExistResponse

createChannelPartnerLink

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::createChannelPartnerLinkAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateChannelPartnerLinkRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerLink

createChannelPartnerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::createChannelPartnerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateChannelPartnerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerRepricingConfig

createCustomer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::createCustomerAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateCustomerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Customer

createCustomerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::createCustomerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateCustomerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\CustomerRepricingConfig

createEntitlement

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::createEntitlementAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateEntitlementRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteChannelPartnerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::deleteChannelPartnerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteChannelPartnerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteCustomer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::deleteCustomerAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteCustomerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteCustomerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::deleteCustomerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteCustomerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getChannelPartnerLink

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::getChannelPartnerLinkAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetChannelPartnerLinkRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerLink

getChannelPartnerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::getChannelPartnerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetChannelPartnerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerRepricingConfig

getCustomer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::getCustomerAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetCustomerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Customer

getCustomerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::getCustomerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetCustomerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\CustomerRepricingConfig

getEntitlement

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::getEntitlementAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetEntitlementRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Entitlement

importCustomer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::importCustomerAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ImportCustomerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Customer

listChannelPartnerLinks

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listChannelPartnerLinksAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListChannelPartnerLinksRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listChannelPartnerRepricingConfigs

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listChannelPartnerRepricingConfigsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListChannelPartnerRepricingConfigsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCustomerRepricingConfigs

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listCustomerRepricingConfigsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListCustomerRepricingConfigsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCustomers

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listCustomersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListCustomersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listEntitlementChanges

List entitlement history.

Possible error codes:

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

Return value: List of EntitlementChanges.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listEntitlementChangesAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListEntitlementChangesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listEntitlements

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listEntitlementsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListEntitlementsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listOffers

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listOffersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListOffersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listProducts

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listProductsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListProductsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listPurchasableOffers

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listPurchasableOffersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListPurchasableOffersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listPurchasableSkus

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listPurchasableSkusAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListPurchasableSkusRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSkuGroupBillableSkus

Lists the Billable SKUs in a given SKU group.

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

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

• BillableSku.service_display_name
• BillableSku.sku_display_name

If unsuccessful, returns an error.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listSkuGroupBillableSkusAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkuGroupBillableSkusRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSkuGroups

Lists the Rebilling supported SKU groups the account is authorized to sell.

Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

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

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

If unsuccessful, returns an error.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listSkuGroupsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkuGroupsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSkus

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

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listSkusAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkusRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSubscribers

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listSubscribersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSubscribersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listTransferableOffers

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listTransferableOffersAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListTransferableOffersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listTransferableSkus

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::listTransferableSkusAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListTransferableSkusRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

lookupOffer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::lookupOfferAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\LookupOfferRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Offer

provisionCloudIdentity

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::provisionCloudIdentityAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ProvisionCloudIdentityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

registerSubscriber

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::registerSubscriberAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\RegisterSubscriberRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\RegisterSubscriberResponse

startPaidService

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::startPaidServiceAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\StartPaidServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

suspendEntitlement

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::suspendEntitlementAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\SuspendEntitlementRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

transferEntitlements

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::transferEntitlementsAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\TransferEntitlementsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

transferEntitlementsToGoogle

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::transferEntitlementsToGoogleAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\TransferEntitlementsToGoogleRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

unregisterSubscriber

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::unregisterSubscriberAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UnregisterSubscriberRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\UnregisterSubscriberResponse

updateChannelPartnerLink

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::updateChannelPartnerLinkAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateChannelPartnerLinkRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerLink

updateChannelPartnerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::updateChannelPartnerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateChannelPartnerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\ChannelPartnerRepricingConfig

updateCustomer

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::updateCustomerAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateCustomerRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\Customer

updateCustomerRepricingConfig

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.

The async variant is Google\Cloud\Channel\V1\Client\BaseClient\self::updateCustomerRepricingConfigAsync() .

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateCustomerRepricingConfigRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Channel\V1\CustomerRepricingConfig

activateEntitlementAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ActivateEntitlementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

cancelEntitlementAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CancelEntitlementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

changeOfferAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeOfferRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

changeParametersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeParametersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

changeRenewalSettingsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ChangeRenewalSettingsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

checkCloudIdentityAccountsExistAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CheckCloudIdentityAccountsExistRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createChannelPartnerLinkAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateChannelPartnerLinkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createChannelPartnerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateChannelPartnerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCustomerAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateCustomerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCustomerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateCustomerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createEntitlementAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\CreateEntitlementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteChannelPartnerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteChannelPartnerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteCustomerAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteCustomerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteCustomerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\DeleteCustomerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getChannelPartnerLinkAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetChannelPartnerLinkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getChannelPartnerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetChannelPartnerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCustomerAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetCustomerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCustomerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetCustomerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getEntitlementAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\GetEntitlementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

importCustomerAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ImportCustomerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listChannelPartnerLinksAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListChannelPartnerLinksRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listChannelPartnerRepricingConfigsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListChannelPartnerRepricingConfigsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCustomerRepricingConfigsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListCustomerRepricingConfigsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCustomersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListCustomersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listEntitlementChangesAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListEntitlementChangesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listEntitlementsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListEntitlementsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listOffersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListOffersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listProductsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListProductsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listPurchasableOffersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListPurchasableOffersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listPurchasableSkusAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListPurchasableSkusRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSkuGroupBillableSkusAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkuGroupBillableSkusRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSkuGroupsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkuGroupsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSkusAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSkusRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSubscribersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListSubscribersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTransferableOffersAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListTransferableOffersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTransferableSkusAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ListTransferableSkusRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

lookupOfferAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\LookupOfferRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

provisionCloudIdentityAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\ProvisionCloudIdentityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

registerSubscriberAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\RegisterSubscriberRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

startPaidServiceAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\StartPaidServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

suspendEntitlementAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\SuspendEntitlementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

transferEntitlementsAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\TransferEntitlementsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

transferEntitlementsToGoogleAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\TransferEntitlementsToGoogleRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

unregisterSubscriberAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UnregisterSubscriberRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateChannelPartnerLinkAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateChannelPartnerLinkRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateChannelPartnerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateChannelPartnerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCustomerAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateCustomerRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCustomerRepricingConfigAsync

Parameters
Name	Description
request	Google\Cloud\Channel\V1\UpdateCustomerRepricingConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::channelPartnerLinkName

Formats a string containing the fully-qualified path to represent a channel_partner_link resource.

Parameters
Name	Description
account	string
channelPartnerLink	string

Returns
Type	Description
string	The formatted channel_partner_link resource.

static::channelPartnerRepricingConfigName

Formats a string containing the fully-qualified path to represent a channel_partner_repricing_config resource.

Parameters
Name	Description
account	string
channelPartner	string
channelPartnerRepricingConfig	string

Returns
Type	Description
string	The formatted channel_partner_repricing_config resource.

static::customerName

Formats a string containing the fully-qualified path to represent a customer resource.

Parameters
Name	Description
account	string
customer	string

Returns
Type	Description
string	The formatted customer resource.

static::customerRepricingConfigName

Formats a string containing the fully-qualified path to represent a customer_repricing_config resource.

Parameters
Name	Description
account	string
customer	string
customerRepricingConfig	string

Returns
Type	Description
string	The formatted customer_repricing_config resource.

static::entitlementName

Formats a string containing the fully-qualified path to represent a entitlement resource.

Parameters
Name	Description
account	string
customer	string
entitlement	string

Returns
Type	Description
string	The formatted entitlement resource.

static::offerName

Formats a string containing the fully-qualified path to represent a offer resource.

Parameters
Name	Description
account	string
offer	string

Returns
Type	Description
string	The formatted offer resource.

static::productName

Formats a string containing the fully-qualified path to represent a product resource.

Parameter
Name	Description
product	string

Returns
Type	Description
string	The formatted product resource.

static::skuGroupName

Formats a string containing the fully-qualified path to represent a sku_group resource.

Parameters
Name	Description
account	string
skuGroup	string

Returns
Type	Description
string	The formatted sku_group resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• channelPartnerLink: accounts/{account}/channelPartnerLinks/{channel_partner_link}
• channelPartnerRepricingConfig: accounts/{account}/channelPartnerLinks/{channel_partner}/channelPartnerRepricingConfigs/{channel_partner_repricing_config}
• customer: accounts/{account}/customers/{customer}
• customerRepricingConfig: accounts/{account}/customers/{customer}/customerRepricingConfigs/{customer_repricing_config}
• entitlement: accounts/{account}/customers/{customer}/entitlements/{entitlement}
• offer: accounts/{account}/offers/{offer}
• product: products/{product}
• skuGroup: accounts/{account}/skuGroups/{sku_group}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.