REST Resource: customers
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: Customer
| Representação JSON |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| Campos |
id |
string
O ID exclusivo da conta do Google Workspace do cliente. (somente leitura)
|
customerDomain |
string
A string de nome de domínio principal do cliente. Não inclua o prefixo www ao criar um novo cliente.
|
kind |
string
Identifica o recurso como um cliente. Valor: admin#directory#customer
|
etag |
string
ETag do recurso.
|
alternateEmail |
string
O endereço de e-mail secundário do contato do cliente. Esse endereço de e-mail não pode estar no mesmo domínio que o customerDomain
|
customerCreationTime |
string
O horário de criação do cliente (somente leitura)
|
postalAddress |
object (CustomerPostalAddress)
As informações do endereço postal do cliente.
|
phoneNumber |
string
O número de telefone de contato do cliente no formato E.164.
|
language |
string
O código de idioma ISO 639-2 do cliente. Consulte a página Códigos de idioma para ver a lista de códigos aceitos. Os códigos de idioma válidos fora do conjunto aceito serão aceitos pela API, mas podem levar a um comportamento inesperado. O valor padrão é en.
|
CustomerPostalAddress
| Representação JSON |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| Campos |
countryCode |
string
Esta é uma propriedade obrigatória. Para informações sobre countryCode, consulte os elementos do código de país ISO 3166.
|
addressLine2 |
string
Linha 2 do endereço.
|
region |
string
Nome da região Um exemplo de valor de região é NY para o estado de Nova York.
|
addressLine3 |
string
Linha de endereço 3 do endereço.
|
locality |
string
Nome da localidade. Um exemplo de valor de localidade é a cidade de San Francisco.
|
postalCode |
string
É o código postal. Um exemplo de postalCode é um CEP, como 10009. Isso está de acordo com - http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
Endereço físico de um cliente. O endereço pode ser composto de uma a três linhas.
|
organizationName |
string
O nome da empresa ou da divisão da empresa.
|
contactName |
string
O nome do contato do cliente.
|
Métodos |
|
|
Recupera um cliente. |
|
|
Adiciona patches a um cliente. |
|
|
Atualiza um cliente. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-24 UTC.
[null,null,["Última atualização 2025-07-24 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. |"]]
