CloudChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
CloudChannelServiceTransport | The transport used by the client instance. |
Methods
CloudChannelServiceClient
CloudChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the cloud channel service client.
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, CloudChannelServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
activate_entitlement
activate_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.ActivateEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ActivateEntitlementRequest, dict]
The request object. Request message for CloudChannelService.ActivateEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
cancel_entitlement
cancel_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CancelEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.CancelEntitlementRequest, dict]
The request object. Request message for CloudChannelService.CancelEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
change_offer
change_offer(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeOfferRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ChangeOfferRequest, dict]
The request object. Request message for CloudChannelService.ChangeOffer. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
change_parameters
change_parameters(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeParametersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ChangeParametersRequest, dict]
The request object. Request message for [CloudChannelService.ChangeParametersRequest][]. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
change_renewal_settings
change_renewal_settings(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeRenewalSettingsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ChangeRenewalSettingsRequest, dict]
The request object. Request message for CloudChannelService.ChangeRenewalSettings. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
check_cloud_identity_accounts_exist
check_cloud_identity_accounts_exist(request: Optional[Union[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_CloudIdentityCustomerAccount resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no xref_CloudIdentityCustomerAccount resources match the domain.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistRequest, dict]
The request object. Request message for CloudChannelService.CheckCloudIdentityAccountsExist. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse | Response message for CloudChannelService.CheckCloudIdentityAccountsExist. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_channel_partner_link
create_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.CreateChannelPartnerLinkRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_ChannelPartnerLink resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.CreateChannelPartnerLinkRequest, dict]
The request object. Request message for CloudChannelService.CreateChannelPartnerLink |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
create_customer
create_customer(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new xref_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 xref_Customer resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.CreateCustomerRequest, dict]
The request object. Request message for CloudChannelService.CreateCustomer |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |
create_entitlement
create_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CreateEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.CreateEntitlementRequest, dict]
The request object. Request message for CloudChannelService.CreateEntitlement |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
customer_path
customer_path(account: str, customer: str)Returns a fully-qualified customer string.
delete_customer
delete_customer(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the given xref_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 xref_Customer resource found for the name in the request.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.DeleteCustomerRequest, dict]
The request object. Request message for CloudChannelService.DeleteCustomer. |
name |
str
Required. The resource name of the customer to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
entitlement_path
entitlement_path(account: str, customer: str, entitlement: str)Returns a fully-qualified entitlement string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
get_channel_partner_link
get_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.GetChannelPartnerLinkRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the requested xref_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 xref_ChannelPartnerLink resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.GetChannelPartnerLinkRequest, dict]
The request object. Request message for CloudChannelService.GetChannelPartnerLink. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
get_customer
get_customer(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the requested xref_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 xref_Customer resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.GetCustomerRequest, dict]
The request object. Request message for CloudChannelService.GetCustomer. |
name |
str
Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |
get_entitlement
get_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.GetEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the requested xref_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 xref_Entitlement resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.GetEntitlementRequest, dict]
The request object. Request message for CloudChannelService.GetEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Entitlement | An entitlement is a representation of a customer's ability to use a service. |
import_customer
import_customer(request: Optional[Union[google.cloud.channel_v1.types.service.ImportCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Imports a xref_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 xref_Customer.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ImportCustomerRequest, dict]
The request object. Request message for CloudChannelService.ImportCustomer |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |
list_channel_partner_links
list_channel_partner_links(request: Optional[Union[google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_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 xref_ChannelPartnerLink resources.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListChannelPartnerLinksRequest, dict]
The request object. Request message for CloudChannelService.ListChannelPartnerLinks |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksPager | Response message for CloudChannelService.ListChannelPartnerLinks. Iterating over this object will yield results and resolve additional pages automatically. |
list_customers
list_customers(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_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 xref_Customers, or an empty list if there are no customers.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListCustomersRequest, dict]
The request object. Request message for CloudChannelService.ListCustomers |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager | Response message for CloudChannelService.ListCustomers. Iterating over this object will yield results and resolve additional pages automatically. |
list_entitlements
list_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists xref_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 xref_Entitlements.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListEntitlementsRequest, dict]
The request object. Request message for CloudChannelService.ListEntitlements |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager | Response message for CloudChannelService.ListEntitlements. Iterating over this object will yield results and resolve additional pages automatically. |
list_offers
list_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Offers the reseller can sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListOffersRequest, dict]
The request object. Request message for ListOffers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager | Response message for ListOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_products
list_products(request: Optional[Union[google.cloud.channel_v1.types.service.ListProductsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Products the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListProductsRequest, dict]
The request object. Request message for ListProducts. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager | Response message for ListProducts. Iterating over this object will yield results and resolve additional pages automatically. |
list_purchasable_offers
list_purchasable_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListPurchasableOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListPurchasableOffersRequest, dict]
The request object. Request message for ListPurchasableOffers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager | Response message for ListPurchasableOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_purchasable_skus
list_purchasable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListPurchasableSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListPurchasableSkusRequest, dict]
The request object. Request message for ListPurchasableSkus. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager | Response message for ListPurchasableSkus. Iterating over this object will yield results and resolve additional pages automatically. |
list_skus
list_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the SKUs for a product the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListSkusRequest, dict]
The request object. Request message for ListSkus. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager | Response message for ListSkus. Iterating over this object will yield results and resolve additional pages automatically. |
list_subscribers
list_subscribers(request: Optional[Union[google.cloud.channel_v1.types.service.ListSubscribersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListSubscribersRequest, dict]
The request object. Request Message for ListSubscribers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager | Response Message for ListSubscribers. Iterating over this object will yield results and resolve additional pages automatically. |
list_transferable_offers
list_transferable_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListTransferableOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.
Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from the reseller account in the query.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of xref_TransferableOffer for the given customer and SKU.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListTransferableOffersRequest, dict]
The request object. Request message for CloudChannelService.ListTransferableOffers |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager | Response message for CloudChannelService.ListTransferableOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_transferable_skus
list_transferable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListTransferableSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_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 xref_TransferableSku.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ListTransferableSkusRequest, dict]
The request object. Request message for CloudChannelService.ListTransferableSkus |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager | Response message for CloudChannelService.ListTransferableSkus. Iterating over this object will yield results and resolve additional pages automatically. |
lookup_offer
lookup_offer(request: Optional[Union[google.cloud.channel_v1.types.service.LookupOfferRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the requested xref_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 xref_Offer resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.LookupOfferRequest, dict]
The request object. Request message for LookupOffer. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Offer | Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying. |
offer_path
offer_path(account: str, offer: str)Returns a fully-qualified offer string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_customer_path
parse_customer_path(path: str)Parses a customer path into its component segments.
parse_entitlement_path
parse_entitlement_path(path: str)Parses a entitlement path into its component segments.
parse_offer_path
parse_offer_path(path: str)Parses a offer path into its component segments.
parse_product_path
parse_product_path(path: str)Parses a product path into its component segments.
parse_sku_path
parse_sku_path(path: str)Parses a sku path into its component segments.
product_path
product_path(product: str)Returns a fully-qualified product string.
provision_cloud_identity
provision_cloud_identity(request: Optional[Union[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.ProvisionCloudIdentityRequest, dict]
The request object. Request message for CloudChannelService.ProvisionCloudIdentity |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Customer Entity representing a customer of a reseller or distributor. |
register_subscriber
register_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.RegisterSubscriberRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_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.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.RegisterSubscriberRequest, dict]
The request object. Request Message for RegisterSubscriber. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.RegisterSubscriberResponse | Response Message for RegisterSubscriber. |
sku_path
sku_path(product: str, sku: str)Returns a fully-qualified sku string.
start_paid_service
start_paid_service(request: Optional[Union[google.cloud.channel_v1.types.service.StartPaidServiceRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.StartPaidServiceRequest, dict]
The request object. Request message for CloudChannelService.StartPaidService. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
suspend_entitlement
suspend_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.SuspendEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.SuspendEntitlementRequest, dict]
The request object. Request message for CloudChannelService.SuspendEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
transfer_entitlements
transfer_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.TransferEntitlementsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.TransferEntitlementsRequest, dict]
The request object. Request message for CloudChannelService.TransferEntitlements. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be TransferEntitlementsResponse Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation. |
transfer_entitlements_to_google
transfer_entitlements_to_google(request: Optional[Union[google.cloud.channel_v1.types.service.TransferEntitlementsToGoogleRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_OperationMetadata.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.TransferEntitlementsToGoogleRequest, dict]
The request object. Request message for CloudChannelService.TransferEntitlementsToGoogle. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
unregister_subscriber
unregister_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.UnregisterSubscriberRequest, dict]
The request object. Request Message for UnregisterSubscriber. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.UnregisterSubscriberResponse | Response Message for UnregisterSubscriber. |
update_channel_partner_link
update_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateChannelPartnerLinkRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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 xref_ChannelPartnerLink resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.UpdateChannelPartnerLinkRequest, dict]
The request object. Request message for CloudChannelService.UpdateChannelPartnerLink |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
update_customer
update_customer(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates an existing xref_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 xref_Customer resource found for the name in the request.
Return value: The updated xref_Customer resource.
| Name | Description |
request |
Union[google.cloud.channel_v1.types.UpdateCustomerRequest, dict]
The request object. Request message for CloudChannelService.UpdateCustomer. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |