REST Resource: customers
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: לקוח
| ייצוג ב-JSON |
{
"id": string,
"customerDomain": string,
"kind": string,
"etag": string,
"alternateEmail": string,
"customerCreationTime": string,
"postalAddress": {
object (CustomerPostalAddress)
},
"phoneNumber": string,
"language": string
} |
| שדות |
id |
string
המזהה הייחודי של חשבון Google Workspace של הלקוח. (לקריאה בלבד)
|
customerDomain |
string
מחרוזת שם הדומיין הראשי של הלקוח. אל תכללו את הקידומת www כשיוצרים לקוח חדש.
|
kind |
string
מזהה את המשאב כלקוח. ערך: admin#directory#customer
|
etag |
string
ה-ETag של המשאב.
|
alternateEmail |
string
כתובת האימייל המשנית ליצירת קשר עם הלקוח. כתובת האימייל הזו לא יכולה להיות בדומיין של customerDomain
|
customerCreationTime |
string
שעת היצירה של הלקוח (לקריאה בלבד)
|
postalAddress |
object (CustomerPostalAddress)
פרטי הכתובת למשלוח דואר של הלקוח.
|
phoneNumber |
string
מספר הטלפון ליצירת קשר עם הלקוח בפורמט E.164.
|
language |
string
קוד השפה של הלקוח לפי תקן ISO 639-2. ברשימת הקודים הנתמכים שבדף קודי שפות. ה-API יקבל קודי שפות תקינים מחוץ לקבוצה הנתמכת, אבל הם עלולים להוביל להתנהגות לא צפויה. ערך ברירת המחדל הוא en.
|
CustomerPostalAddress
| ייצוג ב-JSON |
{
"countryCode": string,
"addressLine2": string,
"region": string,
"addressLine3": string,
"locality": string,
"postalCode": string,
"addressLine1": string,
"organizationName": string,
"contactName": string
} |
| שדות |
countryCode |
string
זהו מאפיין חובה. מידע על countryCode זמין במאמר רכיבי קודי המדינות לפי תקן ISO 3166.
|
addressLine2 |
string
שורת הכתובת 2 של הכתובת.
|
region |
string
שם האזור. דוגמה לערך של אזור היא NY עבור מדינת ניו יורק.
|
addressLine3 |
string
שורת הכתובת 3 של הכתובת.
|
locality |
string
שם הרשות המוניציפאלית. דוגמה לערך של יישוב היא העיר San Francisco.
|
postalCode |
string
המיקוד. דוגמה למיקוד היא מיקוד של מדינה, כמו 10009. זה בהתאם ל-http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
הכתובת הפיזית של הלקוח. הכתובת יכולה להיות מורכבת משורה אחת עד שלוש שורות.
|
organizationName |
string
שם החברה או שם המחלקה בחברה.
|
contactName |
string
שם איש הקשר של הלקוח.
|
Methods |
|
|
אחזור לקוח. |
|
|
תיקון לקוח. |
|
|
עדכון לקוח. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-24 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
