Method: chromeosdevices.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
فهرست صفحه بندی شده ای از دستگاه های سیستم عامل Chrome را در یک حساب بازیابی می کند.
درخواست HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
customerId | string شناسه منحصر به فرد برای حساب Google Workspace مشتری. بهعنوان مدیر حساب، میتوانید از نام مستعار my_customer نیز برای نشان دادن customerId حساب خود استفاده کنید. customerId نیز به عنوان بخشی از منبع کاربران بازگردانده می شود. |
پارامترهای پرس و جو
پارامترها |
---|
maxResults | integer حداکثر تعداد نتایج برای بازگشت. ارزش نباید بیشتر از 300 باشد. |
orderBy | enum ( OrderBy ) ویژگی دستگاه برای استفاده برای مرتب سازی نتایج. |
orgUnitPath | string مسیر کامل واحد سازمانی (منهای پیشرو / ) یا شناسه منحصر به فرد آن. |
pageToken | string پارامتر پرس و جو pageToken برای درخواست صفحه بعدی نتایج پرس و جو استفاده می شود. پارامتر query 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 ) فهرستی از اشیاء دستگاه سیستم عامل Chrome. |
nextPageToken | string رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود. برای دسترسی به صفحه بعدی، از مقدار این نشانه در رشته query pageToken این درخواست استفاده کنید. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/admin.directory.device.chromeos
-
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
سفارش توسط
Enums |
---|
ANNOTATED_LOCATION | مکان دستگاه Chrome همانطور که توسط سرپرست شرح داده شده است. |
ANNOTATED_USER | کاربر Chromebook همانطور که توسط سرپرست شرح داده شده است. |
LAST_SYNC | تاریخ و ساعت آخرین همگام سازی دستگاه Chrome با تنظیمات خط مشی در کنسول مدیریت. |
NOTES | یادداشتهای دستگاه Chrome همانطور که توسط سرپرست شرح داده شده است. |
SERIAL_NUMBER | شماره سریال دستگاه Chrome که هنگام فعال شدن دستگاه وارد شده است. |
STATUS | وضعیت دستگاه کروم. برای اطلاعات بیشتر، <a chromeosdevices را ببینید. |
فرافکنی
نوع پروجکشن برای نمایش دستگاه ها.
Enums |
---|
BASIC | فقط شامل فیلدهای ابرداده اصلی (به عنوان مثال، شناسه دستگاه، شماره سریال، وضعیت، و کاربر) است. |
FULL | شامل تمام فیلدهای ابرداده است |
مرتب سازی
ترتیب مرتب سازی که باید در لیست دستگاه اعمال شود.
Enums |
---|
ASCENDING | ترتیب صعودی |
DESCENDING | ترتیب نزولی |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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. |"]]