Method: chromeosdevices.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recupera una lista paginada de dispositivos ChromeOS dentro de una cuenta.
Solicitud HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros |
customerId |
string
El ID único de la cuenta de Google Workspace del cliente. Como administrador de la cuenta, también puedes usar el alias my_customer para representar el customerId de tu cuenta. El customerId también se muestra como parte del recurso Usuarios.
|
Parámetros de consulta
Parámetros |
maxResults |
integer
Cantidad máxima de resultados que se mostrarán. El valor no debe exceder los 300.
|
orderBy |
enum (OrderBy )
Es la propiedad del dispositivo que se usará para ordenar los resultados.
|
orgUnitPath |
string
Es la ruta de acceso completa de la unidad organizativa (menos el / inicial) o su ID único.
|
pageToken |
string
El parámetro de consulta pageToken se usa para solicitar la siguiente página de resultados de la búsqueda. El parámetro de consulta pageToken de la solicitud de seguimiento es el nextPageToken de tu respuesta anterior.
|
projection |
enum (Projection )
Determina si la respuesta contiene la lista completa de propiedades o solo un subconjunto.
|
query |
string
Cadena de búsqueda en el formato que se indica en https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder )
Si se devuelven resultados en orden ascendente o descendente. Se debe usar con el parámetro orderBy .
|
includeChildOrgunits |
boolean
Muestra los dispositivos de todas las unidades organizativas secundarias, así como la unidad organizativa especificada. Si se establece como verdadero, se debe proporcionar "orgUnitPath".
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
Indica el tipo de recurso.
|
etag |
string
ETag del recurso.
|
chromeosdevices[] |
object (ChromeOsDevice )
Es una lista de objetos de dispositivos ChromeOS.
|
nextPageToken |
string
Es el token que se usa para acceder a la siguiente página de este resultado. Para acceder a la página siguiente, usa el valor de este token en la cadena de consulta pageToken de esta solicitud.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Para obtener más información, consulta la Guía de autorización.
OrderBy
Enumeraciones |
ANNOTATED_LOCATION |
Es la ubicación del dispositivo Chrome que anota el administrador. |
ANNOTATED_USER |
Es el usuario de la Chromebook que anota el administrador. |
LAST_SYNC |
Indica la fecha y hora en que se sincronizó el dispositivo Chrome por última vez con la configuración de la política en la Consola del administrador. |
NOTES |
Son las notas del dispositivo Chrome que anota el administrador. |
SERIAL_NUMBER |
El número de serie del dispositivo Chrome que se ingresó cuando se habilitó el dispositivo |
STATUS |
Estado del dispositivo Chrome Para obtener más información, consulta <a chromeosdevices. |
Proyección
Es el tipo de proyección que se mostrará en los dispositivos.
Enumeraciones |
BASIC |
Solo incluye los campos de metadatos básicos (p. ej., deviceId, serialNumber, status y user). |
FULL |
Incluye todos los campos de metadatos |
SortOrder
Es el orden de clasificación que se debe aplicar a la lista de dispositivos.
Enumeraciones |
ASCENDING |
Orden ascendente. |
DESCENDING |
Orden descendente. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]