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 账号的唯一 ID。(只读)
|
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
地址的第二行。
|
region |
string
地区名称。区域值示例:NY (纽约州)。
|
addressLine3 |
string
地址的第三行。
|
locality |
string
地点的名称。市行政区值示例为 San Francisco 市。
|
postalCode |
string
邮政编码。postalCode 示例是邮政编码,例如 10009 。这符合 - http: //portablecontacts.net/draft-spec.html#address_element。
|
addressLine1 |
string
客户的实际地址。地址可以由 1 到 3 行组成。
|
organizationName |
string
公司或公司部门名称。
|
contactName |
string
客户联系人的姓名。
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-24。
[null,null,["最后更新时间 (UTC):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. |"]]