REST Resource: customers
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: Kunde
| JSON-Darstellung |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| Felder |
id |
string
Die eindeutige ID für das Google Workspace-Konto des Kunden. (Lesezugriff)
|
customerDomain |
string
Der String mit dem primären Domainnamen des Kunden. Fügen Sie beim Erstellen eines neuen Kunden kein Präfix vom Typ www hinzu.
|
kind |
string
Die Ressource wird als Kunde identifiziert. Wert: admin#directory#customer
|
etag |
string
ETag der Ressource.
|
alternateEmail |
string
Die alternative E-Mail-Adresse des Kunden. Diese E-Mail-Adresse darf nicht derselben Domain wie das customerDomain-Tag angehören.
|
customerCreationTime |
string
Der Erstellungszeitpunkt des Kunden (Lesezugriff)
|
postalAddress |
object (CustomerPostalAddress)
Die Postanschrift des Kunden.
|
phoneNumber |
string
Die Telefonnummer des Kunden im E.164.
|
language |
string
Der ISO 639-2-Sprachcode des Kunden. Eine Liste der unterstützten Codes finden Sie auf der Seite Sprachcodes. Gültige Sprachcodes, die nicht zu den unterstützten gehören, werden von der API akzeptiert, können aber zu unerwartetem Verhalten führen. Der Standardwert ist en.
|
CustomerPostalAddress
| JSON-Darstellung |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| Felder |
countryCode |
string
Dieses Attribut ist erforderlich. Informationen zu countryCode finden Sie unter ISO 3166-Ländercode-Elemente.
|
addressLine2 |
string
Die zweite Zeile der Adresse.
|
region |
string
Name der Region. Ein Beispiel für einen Regionswert ist NY für den US-Bundesstaat New York.
|
addressLine3 |
string
Die dritte Zeile der Adresse.
|
locality |
string
Name der Ortschaft. Ein Beispiel für einen Ortswert ist die Stadt San Francisco.
|
postalCode |
string
Die Postleitzahl. Ein Beispiel für eine Postleitzahl ist 10009. Dies entspricht der Spezifikation unter http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
Die physische Adresse eines Kunden. Die Adresse kann aus einer bis drei Zeilen bestehen.
|
organizationName |
string
Der Name des Unternehmens oder der Unternehmensabteilung.
|
contactName |
string
Der Name des Kundenkontakts.
|
Methoden |
|
|
Ruft einen Kunden ab. |
|
|
Patches einen Kunden. |
|
|
Aktualisiert einen Kunden. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-24 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]
