AccountsCustomers
class AccountsCustomers extends Resource (View source)
The "customers" collection of methods.
Typical usage is:
$cloudchannelService = new Google\Service\Cloudchannel(...);
$customers = $cloudchannelService->accounts_customers;Methods
Creates a new Customer resource under the reseller or distributor account.
Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer.
Returns the requested Customer resource. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. (customers.get)
Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 NOT_FOUND: Cloud Identity doesn't exist or was deleted. INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer. (customers.import)
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. (customers.listAccountsCustomers)
Lists the following: Offers that you can purchase for a customer. Offers that you can change for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid.
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.
Updates an existing Customer resource for the reseller or distributor.
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer was not found. ALREADY_EXISTS: The customer's primary email already exists.
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
Transfers customer entitlements to new reseller. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre- requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. Specify all transferring entitlements. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend.
Transfers customer entitlements from their current reseller to Google.
Details
GoogleCloudChannelV1Customer
create(string $parent, GoogleCloudChannelV1Customer $postBody, array $optParams = [])
Creates a new Customer resource under the reseller or distributor account.
Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT:
- Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource. (customers.create)
GoogleProtobufEmpty
delete(string $name, array $optParams = [])
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. (customers.delete)
GoogleCloudChannelV1Customer
get(string $name, array $optParams = [])
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. (customers.get)
GoogleCloudChannelV1Customer
import(string $parent, GoogleCloudChannelV1ImportCustomerRequest $postBody, array $optParams = [])
Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 NOT_FOUND: Cloud Identity doesn't exist or was deleted. INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer. (customers.import)
GoogleCloudChannelV1ListCustomersResponse
listAccountsCustomers(string $parent, array $optParams = [])
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. (customers.listAccountsCustomers)
GoogleCloudChannelV1ListPurchasableOffersResponse
listPurchasableOffers(string $customer, array $optParams = [])
Lists the following: Offers that you can purchase for a customer. Offers that you can change for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid.
(customers.listPurchasableOffers)
GoogleCloudChannelV1ListPurchasableSkusResponse
listPurchasableSkus(string $customer, array $optParams = [])
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.
(customers.listPurchasableSkus)
GoogleCloudChannelV1Customer
patch(string $name, GoogleCloudChannelV1Customer $postBody, array $optParams = [])
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. (customers.patch)
GoogleLongrunningOperation
provisionCloudIdentity(string $customer, GoogleCloudChannelV1ProvisionCloudIdentityRequest $postBody, array $optParams = [])
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer was not found. ALREADY_EXISTS: The customer's primary email already exists.
Retry after changing the customer's primary contact email. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata. (customers.provisionCloudIdentity)
GoogleCloudChannelV1QueryEligibleBillingAccountsResponse
queryEligibleBillingAccounts(string $customer, array $optParams = [])
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
(customers.queryEligibleBillingAccounts)
GoogleLongrunningOperation
transferEntitlements(string $parent, GoogleCloudChannelV1TransferEntitlementsRequest $postBody, array $optParams = [])
Transfers customer entitlements to new reseller. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre- requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. Specify all transferring entitlements. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend.
Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. (customers.transferEntitlements)
GoogleLongrunningOperation
transferEntitlementsToGoogle(string $parent, GoogleCloudChannelV1TransferEntitlementsToGoogleRequest $postBody, array $optParams = [])
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. (customers.transferEntitlementsToGoogle)