class Customers extends Resource (View source)

The "customers" collection of methods.

Typical usage is:

 $resellerService = new Google\Service\Reseller(...);
 $customers = $resellerService->customers;

Methods

get(string $customerId, array $optParams = [])

Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account. (customers.get)

insert(Customer $postBody, array $optParams = [])

Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the customers.get If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the customerAuthToken\ as described in order a resold account for an existing customer. For more information about ordering a new customer account, see order a new customer account. After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see order a new customer account. (customers.insert)

patch(string $customerId, Customer $postBody, array $optParams = [])

Updates a customer account's settings. This method supports patch semantics.

update(string $customerId, Customer $postBody, array $optParams = [])

Updates a customer account's settings. You cannot update customerType via the Reseller API, but a "team" customer can verify their domain and become customerType = "domain". For more information, see update a customer's settings.

Details

Customer get(string $customerId, array $optParams = [])

Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account. (customers.get)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.

array $optParams

Optional parameters.

Return Value

Customer

Exceptions

Exception

Customer insert(Customer $postBody, array $optParams = [])

Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the customers.get If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the customerAuthToken\ as described in order a resold account for an existing customer. For more information about ordering a new customer account, see order a new customer account. After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see order a new customer account. (customers.insert)

Parameters

Customer $postBody
array $optParams

Optional parameters.

Return Value

Customer

Exceptions

Exception

Customer patch(string $customerId, Customer $postBody, array $optParams = [])

Updates a customer account's settings. This method supports patch semantics.

You cannot update customerType via the Reseller API, but a "team" customer can verify their domain and become customerType = "domain". For more information, see Verify your domain to unlock Essentials features. (customers.patch)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.

Customer $postBody
array $optParams

Optional parameters.

Return Value

Customer

Exceptions

Exception

Customer update(string $customerId, Customer $postBody, array $optParams = [])

Updates a customer account's settings. You cannot update customerType via the Reseller API, but a "team" customer can verify their domain and become customerType = "domain". For more information, see update a customer's settings.

(customers.update)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.

Customer $postBody
array $optParams

Optional parameters.

Return Value

Customer

Exceptions

Exception