REST Resource: customers
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: Client
Représentation JSON |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress )
},
"phoneNumber": string,
"language": string
} |
Champs |
id |
string
Identifiant unique du compte Google Workspace du client. (Lecture seule)
|
customerDomain |
string
Chaîne de nom de domaine principal du client. N'incluez pas le préfixe www lorsque vous créez un client.
|
kind |
string
Identifie la ressource en tant que client. Valeur : admin#directory#customer
|
etag |
string
ETag de la ressource.
|
alternateEmail |
string
Adresse e-mail secondaire du client. Cette adresse e-mail ne peut pas être sur le même domaine que l'customerDomain
|
customerCreationTime |
string
Date/Heure de création du client (lecture seule)
|
postalAddress |
object (CustomerPostalAddress )
Informations sur l'adresse postale du client.
|
phoneNumber |
string
Numéro de téléphone de contact du client au format E.164.
|
language |
string
Code de langue ISO 639-2 du client. Consultez la page Codes de langue pour obtenir la liste des codes acceptés. Les codes de langue valides en dehors de l'ensemble accepté seront acceptés par l'API, mais peuvent entraîner un comportement inattendu. La valeur par défaut est en .
|
CustomerPostalAddress
Représentation JSON |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
Champs |
countryCode |
string
Il s'agit d'une propriété obligatoire. Pour en savoir plus sur countryCode , consultez les éléments des codes pays ISO 3166.
|
addressLine2 |
string
Deuxième ligne de l'adresse.
|
region |
string
Nom de la région. Par exemple, NY correspond à l'État de New York.
|
addressLine3 |
string
Troisième ligne de l'adresse.
|
locality |
string
Nom de la localité. La ville San Francisco est un exemple de valeur de localité.
|
postalCode |
string
Code postal. Un exemple de code postal est un code postal, par exemple 10009 . Conformément à la page http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
Adresse physique du client. L'adresse peut être composée d'une à trois lignes.
|
organizationName |
string
Nom de l'entreprise ou de la division de l'entreprise.
|
contactName |
string
Nom du contact client.
|
Méthodes |
|
Récupère un client. |
|
Applique un correctif à un client. |
|
Met à jour un client. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/24 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]