Method: chromeosdevices.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera uma lista paginada de dispositivos Chrome OS em uma conta.
Solicitação HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
customerId |
string
O ID exclusivo da conta do Google Workspace do cliente. Como administrador da conta, você também pode usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso de usuários.
|
Parâmetros de consulta
| Parâmetros |
maxResults |
integer
Número máximo de resultados a serem retornados. O valor não pode exceder 300.
|
orderBy |
enum (OrderBy)
Propriedade do dispositivo que será usada para classificar os resultados.
|
orgUnitPath |
string
O caminho completo da unidade organizacional (menos o / inicial) ou o ID exclusivo dela.
|
pageToken |
string
O parâmetro de consulta pageToken é usado para solicitar a próxima página de resultados da consulta. O parâmetro de consulta pageToken da solicitação subsequente é o nextPageToken da resposta anterior.
|
projection |
enum (Projection)
Determina se a resposta contém a lista completa de propriedades ou apenas um subconjunto.
|
query |
string
String de pesquisa no formato indicado em https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder)
Se os resultados serão retornados em ordem crescente ou decrescente. Precisa ser usado com o parâmetro orderBy.
|
includeChildOrgunits |
boolean
Retorna dispositivos de todas as unidades organizacionais filhas, além da unidade organizacional especificada. Se esse valor for definido como "true", "orgUnitPath" precisa ser fornecido.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:
| Representação JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice)
}
],
"nextPageToken": string
} |
| Campos |
kind |
string
Tipo de recurso.
|
etag |
string
ETag do recurso.
|
chromeosdevices[] |
object (ChromeOsDevice)
Uma lista de objetos de dispositivo Chrome OS.
|
nextPageToken |
string
Token usado para acessar a próxima página desse resultado. Para acessar a próxima página, use o valor desse token na string de consulta pageToken desta solicitação.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Para mais informações, consulte o guia de autorização.
OrderBy
| Enums |
ANNOTATED_LOCATION |
Local do dispositivo Chrome conforme anotado pelo administrador. |
ANNOTATED_USER |
Usuário do Chromebook conforme anotado pelo administrador. |
LAST_SYNC |
Data e hora da última sincronização do dispositivo Chrome com as configurações de política no Admin Console. |
NOTES |
Observações do dispositivo Chrome, conforme anotado pelo administrador. |
SERIAL_NUMBER |
O número de série do dispositivo Chrome inserido quando o dispositivo foi ativado. |
STATUS |
Status do dispositivo Chrome. Para mais informações, consulte <a chromeosdevices. |
Projeção
O tipo de projeção a ser mostrado para os dispositivos.
| Enums |
BASIC |
Inclui apenas os campos de metadados básicos (por exemplo, deviceId, serialNumber, status e user) |
FULL |
Inclui todos os campos de metadados |
SortOrder
A ordem de classificação que será aplicada à lista de dispositivos.
| Enums |
ASCENDING |
Ordem crescente. |
DESCENDING |
Ordem decrescente. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]
