Method: chromeosdevices.list

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 Users.

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 seguinte é 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/admin-sdk/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, bem como 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 em questão.

etag

string

ETag do recurso.

chromeosdevices[]

object (ChromeOsDevice)

Uma lista de objetos de dispositivo ChromeOS.

nextPageToken

string

Token usado para acessar a próxima página deste 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 A data e a hora em que o dispositivo Chrome foi sincronizado pela última vez com as configurações da 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 o <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 deve ser aplicada à lista de dispositivos.

Enums
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.