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 زمان ایجاد مشتری (Readonly) |
postalAddress | object ( CustomerPostalAddress ) اطلاعات آدرس پستی مشتری |
phoneNumber | string شماره تلفن تماس مشتری با فرمت E.164 . |
language | string کد زبان ISO 639-2 مشتری. برای مشاهده لیست کدهای پشتیبانی شده به صفحه کدهای زبان مراجعه کنید. کدهای زبان معتبر خارج از مجموعه پشتیبانی شده توسط API پذیرفته می شود اما ممکن است منجر به رفتار غیرمنتظره شود. مقدار پیش فرض en است. |
آدرس پستی مشتری
| نمایندگی 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 نام مخاطب مشتری |
روش ها |
|---|
| مشتری را بازیابی می کند. |
| مشتری را وصله می کند. |
| یک مشتری را به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-28 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-28 بهوقت ساعت هماهنگ جهانی."],[],[],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. |"]]
