REST Resource: customers
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: Company
ゼロタッチ販売パートナー API とお客様 API の販売パートナー、ベンダー、またはお客様。
JSON 表現 |
{
"name": string,
"companyId": string,
"companyName": string,
"skipWelcomeEmail": boolean,
"languageCode": string,
"googleWorkspaceAccount": {
object (GoogleWorkspaceAccount )
}
} |
フィールド |
name |
string
出力専用。会社の API リソース名。形式は customers/[CUSTOMER_ID] です。サーバーによって割り当てられます。
|
companyId |
string (int64 format)
出力専用。会社の ID。サーバーによって割り当てられます。
|
companyName |
string
必須。会社の名前。(例: XYZ Corp)。ゼロタッチ登録ポータルで会社の従業員に表示されます。
|
skipWelcomeEmail |
boolean
入力のみのtrue に設定した場合、ウェルカム メールは顧客に送信されません。追加の DEVICE_PROTECTION サービスを使用してデバイスの申請を行う場合は、デバイスの申請時にお客様に個別のメールが届くため、ウェルカム メールはスキップすることをおすすめします。ゼロタッチのお客様でない場合、このフィールドは無視されます。
|
languageCode |
string
入力のみのBCP47 言語コードで表される、顧客の優先言語 / 地域。このフィールドは入力時に検証され、サポートされていない言語コードを含むリクエストは拒否されます。サポート対象の言語コード: アラビア語(ar) 中国語(香港) 中国語(繁体) 中国語(繁体) 中国語(簡体)(zh-CN) 中国語(繁体)(zh-TW) チェコ語(cs) デンマーク語(da) オランダ語(nl) 英語(UK)(en-GB) 英語(US)(en-US) フィリピン語( fil) フィンランド語(fi) フランス語(fr)
|
googleWorkspaceAccount |
object (GoogleWorkspaceAccount )
出力専用。このお客様に関連付けられている Google Workspace アカウント。顧客の会社に対してのみ使用します。
|
GoogleWorkspaceAccount
JSON 表現 |
{
"customerId": string,
"preProvisioningTokens": [
string
]
} |
フィールド |
customerId |
string
必須。お客様 ID。
|
preProvisioningTokens[] |
string
出力専用。デバイスの登録に以前使用されていた事前プロビジョニング トークン。
|
メソッド |
|
ユーザーの顧客アカウントを一覧表示します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eThis document describes the \u003ccode\u003eCompany\u003c/code\u003e resource, representing a reseller, vendor, or customer in the zero-touch reseller and customer APIs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCompany\u003c/code\u003e resource includes fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecompanyId\u003c/code\u003e, \u003ccode\u003ecompanyName\u003c/code\u003e, \u003ccode\u003eskipWelcomeEmail\u003c/code\u003e, \u003ccode\u003elanguageCode\u003c/code\u003e, and a nested \u003ccode\u003egoogleWorkspaceAccount\u003c/code\u003e object, all of which are detailed in the provided table.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGoogleWorkspaceAccount\u003c/code\u003e resource, which is related to a company, is defined by a \u003ccode\u003ecustomerId\u003c/code\u003e and an array of \u003ccode\u003epreProvisioningTokens\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe document outlines a method for listing customer accounts via the \u003ccode\u003elist\u003c/code\u003e method, found under the \u003ccode\u003eMethods\u003c/code\u003e section.\u003c/p\u003e\n"]]],["The provided content outlines the structure and attributes of \"Company\" and \"GoogleWorkspaceAccount\" resources within a zero-touch system. A Company resource includes details like `name`, `companyId`, `companyName`, and settings like `skipWelcomeEmail` and `languageCode`. A GoogleWorkspaceAccount links to a Google Workspace customer via `customerId` and `preProvisioningTokens`. The only mentioned action is listing customer accounts via the `list` method, retrieving Company resource data.\n"],null,["# REST Resource: customers\n\n- [Resource: Company](#Company)\n - [JSON representation](#Company.SCHEMA_REPRESENTATION)\n- [GoogleWorkspaceAccount](#GoogleWorkspaceAccount)\n - [JSON representation](#GoogleWorkspaceAccount.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Company\n-----------------\n\nA reseller, vendor, or customer in the zero-touch reseller and customer APIs.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"companyId\": string, \"companyName\": string, \"skipWelcomeEmail\": boolean, \"languageCode\": string, \"googleWorkspaceAccount\": { object (/zero-touch/reference/customer/rest/v1/customers#GoogleWorkspaceAccount) } } ``` |\n\n| Fields ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The API resource name of the company in the format `customers/[CUSTOMER_ID]`. Assigned by the server. |\n| `companyId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The ID of the company. Assigned by the server. |\n| `companyName` | `string` Required. The name of the company. For example *XYZ Corp*. Displayed to the company's employees in the zero-touch enrollment portal. |\n| `skipWelcomeEmail` | `boolean` Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer. |\n| `languageCode` | `string` Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) |\n| `googleWorkspaceAccount` | `object (`[GoogleWorkspaceAccount](/zero-touch/reference/customer/rest/v1/customers#GoogleWorkspaceAccount)`)` Output only. The Google Workspace account associated with this customer. Only used for customer Companies. |\n\nGoogleWorkspaceAccount\n----------------------\n\nA Google Workspace customer.\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"customerId\": string, \"preProvisioningTokens\": [ string ] } ``` |\n\n| Fields ||\n|---------------------------|-------------------------------------------------------------------------------------|\n| `customerId` | `string` Required. The customer ID. |\n| `preProvisioningTokens[]` | `string` Output only. The pre-provisioning tokens previously used to claim devices. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------|-------------------------------------|\n| ### [list](/zero-touch/reference/customer/rest/v1/customers/list) | Lists the user's customer accounts. |"]]