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 الخاص بالعميل اطّلِع على صفحة رموز اللغات للحصول على قائمة الرموز المسموح بها. ستقبل واجهة برمجة التطبيقات رموز اللغات الصالحة خارج المجموعة المتوافقة، ولكن قد تؤدي إلى سلوك غير متوقّع. تكون القيمة التلقائية 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
تمثّل هذه السمة الرمز البريدي. مثال على postalCode هو الرمز البريدي مثل 10009. يتوافق ذلك مع - http: //portablecontacts.net/draft-spec.html#address_element.
|
addressLine1 |
string
العنوان الجغرافي للعميل يمكن أن يتألّف العنوان من سطر واحد إلى ثلاثة أسطر.
|
organizationName |
string
اسم الشركة أو قسم الشركة
|
contactName |
string
اسم جهة اتصال العميل.
|
الطُرق |
|
|
استرداد عميل |
|
|
تصحيح عميل |
|
|
تعديل معلومات عميل |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-24 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-24 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],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. |"]]
