1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. Domains

Domains

class Domains extends Resource (View source)

The "domains" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $domains = $adminService->domains;

Methods

delete(string $customer, string $domainName, array $optParams = [])

Deletes a domain of the customer. (domains.delete)

Domains
get(string $customer, string $domainName, array $optParams = [])

Retrieves a domain of the customer. (domains.get)

Domains
insert(string $customer, Domains $postBody, array $optParams = [])

Inserts a domain of the customer. (domains.insert)

Domains2
listDomains(string $customer, array $optParams = [])

Lists the domains of the customer. (domains.listDomains)

Details

at line 41
delete(string $customer, string $domainName, array $optParams = [])

Deletes a domain of the customer. (domains.delete)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $domainName

Name of domain to be deleted
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
Domains get(string $customer, string $domainName, array $optParams = [])

Retrieves a domain of the customer. (domains.get)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
string $domainName

Name of domain to be retrieved
array $optParams

Optional parameters.

Return Value

Domains

Exceptions

Exception

at line 77
Domains insert(string $customer, Domains $postBody, array $optParams = [])

Inserts a domain of the customer. (domains.insert)

Parameters

string $customer

Immutable ID of the Google Workspace account.
Domains $postBody
array $optParams

Optional parameters.

Return Value

Domains

Exceptions

Exception

at line 97
Domains2 listDomains(string $customer, array $optParams = [])

Lists the domains of the customer. (domains.listDomains)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
array $optParams

Optional parameters.

Return Value

Domains2

Exceptions

Exception