REST Resource: customers
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Risorsa: cliente
| Rappresentazione JSON |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| Campi |
id |
string
L'ID univoco dell'account Google Workspace del cliente. (sola lettura)
|
customerDomain |
string
La stringa del nome di dominio principale del cliente. Non includere il prefisso www quando crei un nuovo cliente.
|
kind |
string
Identifica la risorsa come cliente. Valore: admin#directory#customer
|
etag |
string
ETag della risorsa.
|
alternateEmail |
string
L'indirizzo email di contatto secondario del cliente. Questo indirizzo email non può trovarsi nello stesso dominio del customerDomain
|
customerCreationTime |
string
L'ora di creazione del cliente (sola lettura)
|
postalAddress |
object (CustomerPostalAddress)
I dati dell'indirizzo postale del cliente.
|
phoneNumber |
string
Il numero di telefono di contatto del cliente in formato E.164.
|
language |
string
Il codice lingua ISO 639-2 del cliente. Consulta la pagina Codici lingua per l'elenco dei codici supportati. I codici lingua validi al di fuori dell'insieme supportato saranno accettati dall'API, ma potrebbero comportare un comportamento imprevisto. Il valore predefinito è en.
|
CustomerPostalAddress
| Rappresentazione JSON |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| Campi |
countryCode |
string
Questa è una proprietà obbligatoria. Per informazioni su countryCode, consulta gli elementi dei codici paese ISO 3166.
|
addressLine2 |
string
La riga 2 dell'indirizzo.
|
region |
string
Nome della regione. Un esempio di valore di regione è NY per lo stato di New York.
|
addressLine3 |
string
La riga 3 dell'indirizzo.
|
locality |
string
Nome della località. Un esempio di valore di località è la città di San Francisco.
|
postalCode |
string
Il codice postale. Un esempio di codice postale è un codice postale, ad esempio 10009. Questo è conforme a - http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
L'indirizzo fisico di un cliente. L'indirizzo può essere composto da una a tre righe.
|
organizationName |
string
Il nome dell'azienda o della divisione aziendale.
|
contactName |
string
Il nome del contatto del cliente.
|
Metodi |
|
|
Recupera un cliente. |
|
|
Esegue il patching di un cliente. |
|
|
Aggiorna un cliente. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-24 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]
