Method: chromeosdevices.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère une liste paginée des appareils Chrome OS 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. customerId est également renvoyé dans 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 la 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 https://developers.google.com/workspace/admin/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 du 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. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]