REST Resource: customers
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource : Company
Un revendeur, un fournisseur ou un client dans les API revendeur et client d'enregistrement sans contact.
Représentation JSON |
{
"name": string,
"companyId": string,
"companyName": string,
"skipWelcomeEmail": boolean,
"languageCode": string,
"googleWorkspaceAccount": {
object (GoogleWorkspaceAccount )
}
} |
Champs |
name |
string
Uniquement en sortie. Nom de ressource d'API de l'entreprise au format customers/[CUSTOMER_ID] . Attribué par le serveur.
|
companyId |
string (int64 format)
Uniquement en sortie. Identifiant de l'entreprise. Attribué par le serveur.
|
companyName |
string
Obligatoire. Nom de l'entreprise. Par exemple, Société XYZ. Affiché aux employés de l'entreprise sur le portail d'enregistrement sans contact.
|
skipWelcomeEmail |
boolean
Uniquement en entrée. Si cette règle est définie sur "True", l'e-mail de bienvenue n'est pas envoyé au client. Nous vous recommandons d'ignorer l'e-mail de bienvenue si les appareils sont revendiqués par le service DEVICE_PROTECTION supplémentaire, car le client recevra des e-mails distincts au moment de la revendication de l'appareil. Ce champ est ignoré s'il ne s'agit pas d'un client sans contact.
|
languageCode |
string
Uniquement en entrée. Paramètres régionaux préférés du client représenté sous la forme d'un code de langue BCP47. Ce champ est validé à l'aide de la saisie et les requêtes contenant des codes de langue non pris en charge seront refusées.
|
googleWorkspaceAccount |
object (GoogleWorkspaceAccount )
Uniquement en sortie. Le compte Google Workspace associé à ce client. Utilisé uniquement pour les entreprises clientes.
|
GoogleWorkspaceAccount
Un client Google Workspace
Représentation JSON |
{
"customerId": string,
"preProvisioningTokens": [
string
]
} |
Champs |
customerId |
string
Obligatoire. Numéro client.
|
preProvisioningTokens[] |
string
Uniquement en sortie. Jetons de pré-provisionnement précédemment utilisés pour revendiquer des appareils.
|
Méthodes |
|
Liste les comptes client de l'utilisateur. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]