Method: chromeosdevices.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يستردّ هذه الوظيفة قائمة مفصّلة بأجهزة ChromeOS ضمن حساب معيّن.
طلب HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
customerId |
string
المعرّف الفريد لحساب العميل على Google Workspace. بصفتك مشرف حساب، يمكنك أيضًا استخدام العنوان البديل my_customer لتمثيل customerId حسابك. يتم أيضًا عرض customerId كجزء من مرجع المستخدمين.
|
مَعلمات طلب البحث
| المعلمات |
maxResults |
integer
تعرض هذه المَعلمة أكبر عدد ممكن من النتائج. يجب ألا تتجاوز القيمة 300.
|
orderBy |
enum (OrderBy)
وهي سمة الجهاز التي يمكن استخدامها لترتيب النتائج.
|
orgUnitPath |
string
المسار الكامل للوحدة التنظيمية (باستثناء الرمز / البادئ) أو المعرّف الفريد لها
|
pageToken |
string
تُستخدَم مَعلمة طلب البحث pageToken في طلب الصفحة التالية من نتائج طلب البحث. مَعلمة طلب البحث pageToken لطلب المتابعة هي nextPageToken من استجابتك السابقة.
|
projection |
enum (Projection)
تحدِّد ما إذا كانت الاستجابة تحتوي على القائمة الكاملة للسمات أو مجموعة فرعية فقط.
|
query |
string
سلسلة البحث بالتنسيق الوارد في https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder)
لاختيار عرض النتائج إما بترتيب تصاعدي أو تنازلي. ويجب استخدامها مع المَعلمة orderBy.
|
includeChildOrgunits |
boolean
عرض الأجهزة من جميع الوحدات التنظيمية الفرعية، بالإضافة إلى الوحدة التنظيمية المحدّدة في حال ضبط هذه القيمة على "صحيح"، يجب تقديم "orgUnitPath".
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice)
}
],
"nextPageToken": string
} |
| الحقول |
kind |
string
نوع المرجع
|
etag |
string
علامة ETag للمورد
|
chromeosdevices[] |
object (ChromeOsDevice)
قائمة بعناصر أجهزة ChromeOS
|
nextPageToken |
string
الرمز المميّز المستخدَم للوصول إلى الصفحة التالية من هذه النتيجة للوصول إلى الصفحة التالية، استخدِم قيمة هذا الرمز المميّز في سلسلة طلب البحث pageToken لهذا الطلب.
|
نطاقات التفويض
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
OrderBy
| عمليات التعداد |
ANNOTATED_LOCATION |
موقع جهاز Chrome الجغرافي كما وضَّح المشرف |
ANNOTATED_USER |
مستخدم جهاز Chromebook كما وضَح المشرف. |
LAST_SYNC |
يشير هذا الحقل إلى تاريخ ووقت آخر مزامنة لجهاز Chrome مع إعدادات السياسات في "وحدة تحكّم المشرف". |
NOTES |
ملاحظات جهاز Chrome كما وضَح المشرف |
SERIAL_NUMBER |
الرقم التسلسلي لجهاز Chrome الذي تم إدخاله عند تفعيل الجهاز. |
STATUS |
حالة جهاز Chrome لمزيد من المعلومات، يُرجى الاطّلاع على <a chromeosdevices. |
الإسقاط
نوع العرض الذي سيتم عرضه على الأجهزة
| عمليات التعداد |
BASIC |
تتضمّن حقول البيانات الوصفية الأساسية فقط (مثل deviceId وserialNumber وstatus وuser) |
FULL |
تتضمّن جميع حقول البيانات الوصفية |
SortOrder
ترتيب الفرز الذي يجب تطبيقه على قائمة الأجهزة
| عمليات التعداد |
ASCENDING |
ترتيب تصاعدي |
DESCENDING |
ترتيب تنازلي |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: chromeosdevices.list\n\nRetrieves a paginated list of Chrome OS devices within an account.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. Value should not exceed 300. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#OrderBy)`)` Device property to use for sorting results. |\n| `orgUnitPath` | `string` The full path of the organizational unit (minus the leading `/`) or its unique ID. |\n| `pageToken` | `string` The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#Projection)`)` Determines whether the response contains the full list of properties or only a subset. |\n| `query` | `string` Search string in the format given at \u003chttps://developers.google.com/workspace/admin/directory/v1/list-query-operators\u003e |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#SortOrder)`)` Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. |\n| `includeChildOrgunits` | `boolean` Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"chromeosdevices\": [ { object (/workspace/admin/directory/reference/rest/v1/chromeosdevices#ChromeOsDevice) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `chromeosdevices[]` | `object (`[ChromeOsDevice](/workspace/admin/directory/reference/rest/v1/chromeosdevices#ChromeOsDevice)`)` A list of Chrome OS Device objects. |\n| `nextPageToken` | `string` Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.device.chromeos`\n- `\n https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ANNOTATED_LOCATION` | Chrome device location as annotated by the administrator. |\n| `ANNOTATED_USER` | Chromebook user as annotated by administrator. |\n| `LAST_SYNC` | The date and time the Chrome device was last synchronized with the policy settings in the Admin console. |\n| `NOTES` | Chrome device notes as annotated by the administrator. |\n| `SERIAL_NUMBER` | The Chrome device serial number entered when the device was enabled. |\n| `STATUS` | Chrome device status. For more information, see the \\\u003ca [chromeosdevices](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices.html). |\n\nProjection\n----------\n\nThe type of projection to show for the devices.\n\n| Enums ||\n|---------|------------------------------------------------------------------------------------------|\n| `BASIC` | Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |\n| `FULL` | Includes all metadata fields |\n\nSortOrder\n---------\n\nThe sorting order that should be applied to the device list.\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]
