REST Resource: customers
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Клиент
| JSON-представление |
|---|
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| Поля |
|---|
id | string Уникальный идентификатор аккаунта Google Workspace клиента. (Только чтение) |
customerDomain | string Строка основного доменного имени клиента. Не включайте префикс www при создании нового клиента. |
kind | string Идентифицирует ресурс как клиента. Значение: admin#directory#customer |
etag | string ETag ресурса. |
alternateEmail | string Дополнительный контактный адрес электронной почты клиента. Этот адрес электронной почты не может находиться в том же домене, что и домен customerDomain |
customerCreationTime | string Время создания клиента (только чтение) |
postalAddress | object ( CustomerPostalAddress ) Информация о почтовом адресе клиента. |
phoneNumber | string Контактный телефон клиента в формате E.164 . |
language | string Языковой код клиента ISO 639-2. Список поддерживаемых кодов см. на странице «Коды языков» . Действительные коды языков, не входящие в поддерживаемый набор, будут приняты API, но могут привести к непредвиденному поведению. Значение по умолчанию — en . |
Почтовый адрес клиента
| JSON-представление |
|---|
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| Поля |
|---|
countryCode | string Это обязательное свойство. Информацию о countryCode см. в элементах кода страны ISO 3166 . |
addressLine2 | string Адресная строка 2 адреса. |
region | string Название региона. Примером значения региона является NY для штата Нью-Йорк. |
addressLine3 | string Адресная строка 3 адреса. |
locality | string Название местности. Примером значения местоположения является город San Francisco . |
postalCode | string Почтовый индекс. Пример postalCode — почтовый индекс, например 10009 . Это соответствует - http://portablecontacts.net/draft-spec.html#address_element. |
addressLine1 | string Физический адрес клиента. Адрес может состоять из одной-трех строк. |
organizationName | string Название компании или подразделения компании. |
contactName | string Имя контактного лица клиента. |
Методы |
|---|
| Возвращает клиента. |
| Патчи клиента. |
| Обновляет клиента. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-28 UTC.
[null,null,["Последнее обновление: 2025-07-28 UTC."],[],[],null,["# REST Resource: customers\n\nResource: Customer\n------------------\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"customerDomain\": string, \"kind\": string, \"etag\": string, \"alternateEmail\": string, \"customerCreationTime\": string, \"postalAddress\": { object (/workspace/admin/directory/reference/rest/v1/customers#CustomerPostalAddress) }, \"phoneNumber\": string, \"language\": string } ``` |\n\n| Fields ||\n|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The unique ID for the customer's Google Workspace account. (Readonly) |\n| `customerDomain` | `string` The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |\n| `kind` | `string` Identifies the resource as a customer. Value: `admin#directory#customer` |\n| `etag` | `string` ETag of the resource. |\n| `alternateEmail` | `string` The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |\n| `customerCreationTime` | `string` The customer's creation time (Readonly) |\n| `postalAddress` | `object (`[CustomerPostalAddress](/workspace/admin/directory/reference/rest/v1/customers#CustomerPostalAddress)`)` The customer's postal address information. |\n| `phoneNumber` | `string` The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |\n| `language` | `string` The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |\n\nCustomerPostalAddress\n---------------------\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"countryCode\": string, \"addressLine2\": string, \"region\": string, \"addressLine3\": string, \"locality\": string, \"postalCode\": string, \"addressLine1\": string, \"organizationName\": string, \"contactName\": string } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `countryCode` | `string` This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |\n| `addressLine2` | `string` Address line 2 of the address. |\n| `region` | `string` Name of the region. An example of a region value is `NY` for the state of New York. |\n| `addressLine3` | `string` Address line 3 of the address. |\n| `locality` | `string` Name of the locality. An example of a locality value is the city of `San Francisco`. |\n| `postalCode` | `string` The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element. |\n| `addressLine1` | `string` A customer's physical address. The address can be composed of one to three lines. |\n| `organizationName` | `string` The company or company division name. |\n| `contactName` | `string` The customer contact's name. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------|-----------------------|\n| ### [get](/workspace/admin/directory/reference/rest/v1/customers/get) | Retrieves a customer. |\n| ### [patch](/workspace/admin/directory/reference/rest/v1/customers/patch) | Patches a customer. |\n| ### [update](/workspace/admin/directory/reference/rest/v1/customers/update) | Updates a customer. |"]]
