Method: chromeosdevices.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Получает постраничный список устройств Chrome OS в учетной записи.
HTTP-запрос
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
customerId | string Уникальный идентификатор аккаунта Google Workspace клиента. Как администратор учетной записи вы также можете использовать псевдоним my_customer для представления customerId вашей учетной записи. customerId также возвращается как часть ресурса Users . |
Параметры запроса
Параметры |
---|
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 Возврат устройств из всех дочерних подразделений, а также из указанного организационного подразделения. Если для этого параметра установлено значение true, необходимо указать «orgUnitPath». |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice )
}
],
"nextPageToken": string
} |
Поля |
---|
kind | string Это такой ресурс. |
etag | string ETag ресурса. |
chromeosdevices[] | object ( ChromeOsDevice ) Список объектов устройств Chrome OS. |
nextPageToken | string Токен, используемый для доступа к следующей странице этого результата. Чтобы получить доступ к следующей странице, используйте значение этого токена в строке запроса pageToken этого запроса. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/admin.directory.device.chromeos
-
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Дополнительную информацию см. в руководстве по авторизации .
Заказ по
Перечисления |
---|
ANNOTATED_LOCATION | Местоположение устройства Chrome, указанное администратором. |
ANNOTATED_USER | Пользователь Chromebook, указанный администратором. |
LAST_SYNC | Дата и время последней синхронизации устройства Chrome с настройками политики в консоли администратора. |
NOTES | Заметки об устройстве Chrome с комментариями администратора. |
SERIAL_NUMBER | Серийный номер устройства Chrome, введенный при включении устройства. |
STATUS | Статус устройства Chrome. Дополнительную информацию см. в разделе <a chromeosdevices . |
Проекция
Тип проекции, отображаемой для устройств.
Перечисления |
---|
BASIC | Включает только основные поля метаданных (например, идентификатор устройства, серийный номер, статус и пользователь). |
FULL | Включает все поля метаданных |
Сортировать
Порядок сортировки, который следует применять к списку устройств.
Перечисления |
---|
ASCENDING | Восходящий порядок. |
DESCENDING | Нисходящий порядок. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],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. |"]]