REST Resource: customers
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Cliente
| Representación JSON |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| Campos |
id |
string
El ID único de la cuenta de Google Workspace del cliente. (Solo lectura)
|
customerDomain |
string
Es la cadena de nombre de dominio principal del cliente. No incluyas el prefijo www cuando crees un cliente nuevo.
|
kind |
string
Identifica el recurso como un cliente. Valor: admin#directory#customer
|
etag |
string
ETag del recurso.
|
alternateEmail |
string
La dirección de correo electrónico de contacto secundaria del cliente Esta dirección de correo electrónico no puede estar en el mismo dominio que el customerDomain.
|
customerCreationTime |
string
La hora de creación del cliente (solo lectura)
|
postalAddress |
object (CustomerPostalAddress)
La información de la dirección postal del cliente
|
phoneNumber |
string
Es el número de teléfono de contacto del cliente en formato E.164.
|
language |
string
Es el código de idioma ISO 639-2 del cliente. Consulta la página Códigos de idioma para ver la lista de códigos admitidos. La API aceptará códigos de idioma válidos fuera del conjunto admitido, pero es posible que se genere un comportamiento inesperado. El valor predeterminado es en.
|
CustomerPostalAddress
| Representación JSON |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| Campos |
countryCode |
string
Esta es una propiedad obligatoria. Para obtener información sobre countryCode, consulta los elementos de los códigos de país ISO 3166.
|
addressLine2 |
string
Es la línea 2 de la dirección.
|
region |
string
Nombre de la región. Un ejemplo de un valor de región es NY para el estado de Nueva York.
|
addressLine3 |
string
Es la línea de dirección 3 de la dirección.
|
locality |
string
Es el nombre de la localidad. Un ejemplo de un valor de localidad es la ciudad de San Francisco.
|
postalCode |
string
Corresponde al código postal, Un ejemplo de postalCode es un código postal, como 10009. Esto se hace de acuerdo con http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
La dirección física de un cliente La dirección puede estar compuesta de una a tres líneas.
|
organizationName |
string
El nombre de la empresa o división de la empresa.
|
contactName |
string
El nombre del contacto del cliente.
|
Métodos |
|
|
Recupera un cliente. |
|
|
Aplica parches a un cliente. |
|
|
Actualiza un cliente. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-24 (UTC)
[null,null,["Última actualización: 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. |"]]
