REST Resource: customers
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
منبع: شرکت
یک فروشنده، فروشنده یا مشتری در 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) فقط خروجی شناسه شرکت. توسط سرور اختصاص داده شده است. |
companyName | string مورد نیاز. نام شرکت. به عنوان مثال XYZ Corp. در پورتال ثبت نام بدون لمس برای کارکنان شرکت نمایش داده می شود. |
skipWelcomeEmail | boolean فقط ورودی اگر روی true تنظیم شود، ایمیل خوش آمدگویی برای مشتری ارسال نخواهد شد. توصیه میشود در صورتی که دستگاهها با سرویس DEVICE_PROTECTION اضافی درخواست میشوند، ایمیل خوشآمدگویی را نادیده بگیرید، زیرا مشتری ایمیلهای جداگانهای را در زمان ادعای دستگاه دریافت میکند. اگر مشتری Zero-touch نباشد، این قسمت نادیده گرفته می شود. |
languageCode | string فقط ورودی محلی ترجیحی مشتری به عنوان کد زبان BCP47 نشان داده شده است. این فیلد در ورودی تایید میشود و درخواستهای حاوی کدهای زبان پشتیبانینشده رد میشوند. کدهای زبان پشتیبانی شده: عربی (ar) چینی (هنگ کنگ) (zh-HK) چینی (ساده شده) (zh-CN) چینی (سنتی) (zh-TW) چک (cs) دانمارکی (da) هلندی (nl) انگلیسی ( بریتانیا) (en-GB) انگلیسی (ایالات متحده) (en-US) فیلیپینی (fil) فنلاندی (fi) فرانسوی (fr) آلمانی (de) عبری (iw) هندی (hi) مجارستانی (hu) اندونزیایی (id) ایتالیایی (id) آن) ژاپنی (ja) کره ای (ko) نروژی (بوکمال) (نه) لهستانی (pl) پرتغالی (برزیل) (pt-BR) پرتغالی (پرتغال) (pt-PT) روسی (ru) اسپانیایی (es) اسپانیایی (لاتین) آمریکا) (es-419) سوئدی (sv) تایلندی (th) ترکی (tr) اوکراینی (بریتانیا) ویتنامی (vi) |
googleWorkspaceAccount | object ( GoogleWorkspaceAccount ) فقط خروجی حساب Google Workspace مرتبط با این مشتری. فقط برای شرکت های مشتری استفاده می شود. |
حساب GoogleWorkspace
یک مشتری Google Workspace.
نمایندگی JSON |
---|
{
"customerId": string,
"preProvisioningTokens": [
string
]
} |
فیلدها |
---|
customerId | string مورد نیاز. شناسه مشتری |
preProvisioningTokens[] | string فقط خروجی توکنهای پیشپروری که قبلاً برای ادعای دستگاهها استفاده میشدند. |
روش ها |
---|
| حساب های مشتریان کاربر را فهرست می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]