REST Resource: customers
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: Customer
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
住所の 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
お客様の住所。住所は 1 ~ 3 行で入力できます。
|
organizationName |
string
会社または会社の部門名。
|
contactName |
string
お客様の連絡先の名前。
|
メソッド |
|
顧客を取得します。 |
|
お客様にパッチを適用します。 |
|
顧客を更新します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 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. |"]]