Method: chromeosdevices.list

Récupère une liste paginée des appareils Chrome OS au sein d'un compte.

Requête HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Identifiant unique du compte Google Workspace du client. En tant qu'administrateur de compte, vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. Le customerId est également renvoyé dans le cadre de la ressource Users.

Paramètres de requête

Paramètres
maxResults

integer

Nombre maximal de résultats sur une page. La valeur ne doit pas dépasser 300.

orderBy

enum (OrderBy)

Propriété de l'appareil à utiliser pour trier les résultats.

orgUnitPath

string

Chemin complet de l'unité organisationnelle (sans le / initial) ou son ID unique.

pageToken

string

Le paramètre de requête pageToken permet de demander la page suivante des résultats de requête. Le paramètre de requête pageToken de la requête suivante correspond au nextPageToken de votre réponse précédente.

projection

enum (Projection)

Détermine si la réponse contient la liste complète des propriétés ou uniquement un sous-ensemble de cette liste.

query

string

Chaîne de recherche au format indiqué sur la page https://developers.google.com/admin-sdk/directory/v1/list-query-operators

sortOrder

enum (SortOrder)

Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant. Doit être utilisé avec le paramètre orderBy.

includeChildOrgunits

boolean

Renvoie les appareils de toutes les unités organisationnelles enfants, ainsi que de l'unité organisationnelle spécifiée. Si cette valeur est définie sur "true", "orgUnitPath" doit être fourni.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON
{
  "kind": string,
  "etag": string,
  "chromeosdevices": [
    {
      object (ChromeOsDevice)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource

etag

string

ETag de la ressource.

chromeosdevices[]

object (ChromeOsDevice)

Liste d'objets "ChromeOSDevice".

nextPageToken

string

Jeton utilisé pour accéder à la page suivante de ce résultat. Pour accéder à la page suivante, utilisez la valeur de ce jeton dans la chaîne de requête pageToken de cette requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/admin.directory.device.chromeos
  • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly

Pour en savoir plus, consultez le guide d'autorisation.

OrderBy

Enums
ANNOTATED_LOCATION Emplacement de l'appareil Chrome (annoté par l'administrateur).
ANNOTATED_USER Utilisateur Chromebook annoté par l'administrateur.
LAST_SYNC Date et heure de la dernière synchronisation des paramètres de règles entre l'appareil Chrome et la console d'administration.
NOTES Notes sur l'appareil Chrome (annotées par l'administrateur).
SERIAL_NUMBER Numéro de série de l'appareil Chrome saisi lors de l'activation de l'appareil.
STATUS État de l'appareil Chrome Pour en savoir plus, consultez <a chromeosdevices.

Projection

Type de projection à afficher pour les appareils.

Enums
BASIC N'inclut que les champs de métadonnées de base (par exemple, deviceId, serialNumber, status et user)
FULL Inclut tous les champs de métadonnées

SortOrder

Ordre de tri à appliquer à la liste des appareils.

Enums
ASCENDING par ordre croissant.
DESCENDING Ordre décroissant.