REST Resource: customers
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
المرجع: الشركة
مورِّد أو مورِّد أو عميل في مورِّد برنامج "إعداد الأجهزة الجوّالة للمؤسسات دفعةً واحدة" وواجهات برمجة تطبيقات العملاء
| تمثيل JSON |
{
"name": string,
"companyId": string,
"companyName": string,
"skipWelcomeEmail": boolean,
"languageCode": string,
"googleWorkspaceAccount": {
object (GoogleWorkspaceAccount)
}
} |
| الحقول |
name |
string
النتائج فقط. اسم مورد واجهة برمجة التطبيقات للشركة بالتنسيق customers/[CUSTOMER_ID]. تم تعيينها من قِبل الخادم.
|
companyId |
string (int64 format)
النتائج فقط. رقم تعريف الشركة. تم تعيينها من قِبل الخادم.
|
companyName |
string
مطلوب. اسم الشركة. على سبيل المثال، XYZ Corp. يتم عرضه لموظفي الشركة في بوابة "إعداد الأجهزة الجوّالة للمؤسّسات دفعةً واحدة".
|
skipWelcomeEmail |
boolean
الإدخال فقط. في حال ضبط هذه السياسة على "صحيح"، لن يتم إرسال رسالة الترحيب الإلكترونية إلى العميل. يُنصح بتخطّي رسالة الترحيب الإلكترونية إذا تمت المطالبة بالأجهزة مع خدمة DEVICE_PROTECTION إضافية، لأنّ العميل سيتلقّى رسائل إلكترونية منفصلة في وقت المطالبة بالجهاز. يتم تجاهل هذا الحقل إذا لم يكن برنامج "إعداد الأجهزة الجوّالة للمؤسسات دفعةً واحدة".
|
languageCode |
string
الإدخال فقط. اللغة المفضّلة للعميل والتي يتم تمثيلها كرمز لغة BCP47 يتم التحقّق من صحة هذا الحقل عند الإدخال، وسيتم رفض الطلبات التي تحتوي على رموز لغة غير متوافقة.
|
googleWorkspaceAccount |
object (GoogleWorkspaceAccount)
النتائج فقط. حساب Google Workspace المرتبط بهذا العميل. يُستخدَم فقط لشركات العملاء.
|
GoogleWorkspaceAccount
| تمثيل JSON |
{
"customerId": string,
"preProvisioningTokens": [
string
]
} |
| الحقول |
customerId |
string
مطلوب. الرقم التعريفي للعميل
|
preProvisioningTokens[] |
string
النتائج فقط. الرموز المميّزة للإدارة المُسبَقة التي تم استخدامها سابقًا للمطالبة بالأجهزة.
|
الطُرق |
|
|
يسرد حسابات العملاء التابعة للمستخدم. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة 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. |"]]
