Method: chromeosdevices.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ruft eine paginated Liste der ChromeOS-Geräte in einem Konto ab.
HTTP-Anfrage
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
customerId |
string
Die eindeutige ID für das Google Workspace-Konto des Kunden. Als Kontoadministrator können Sie auch den Alias my_customer verwenden, um die customerId Ihres Kontos zu repräsentieren. Die customerId wird auch als Teil der Ressource „Nutzer“ zurückgegeben.
|
Abfrageparameter
Parameter |
maxResults |
integer
Maximale Anzahl der zurückzugebenden Ergebnisse. Der Wert darf 300 nicht überschreiten.
|
orderBy |
enum (OrderBy )
Geräteeigenschaft, die zum Sortieren der Ergebnisse verwendet werden soll.
|
orgUnitPath |
string
Der vollständige Pfad der Organisationseinheit (ohne die führende / ) oder ihre eindeutige ID.
|
pageToken |
string
Der Abfrageparameter pageToken wird verwendet, um die nächste Seite mit Abfrageergebnissen anzufordern. Der Abfrageparameter pageToken der Folgeanfrage ist der Parameter nextPageToken der vorherigen Antwort.
|
projection |
enum (Projection )
Legt fest, ob die Antwort die vollständige Liste der Properties oder nur einen Teil enthält.
|
query |
string
Suchstring im Format, das unter https://developers.google.com/workspace/admin/directory/v1/list-query-operators angegeben ist
|
sortOrder |
enum (SortOrder )
Ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Muss mit dem Parameter orderBy verwendet werden.
|
includeChildOrgunits |
boolean
Geräte aus allen untergeordneten Organisationseinheiten sowie der angegebenen Organisationseinheit zurückgeben. Wenn dieser Wert auf „wahr“ gesetzt ist, muss „orgUnitPath“ angegeben werden.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
JSON-Darstellung |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice )
}
],
"nextPageToken": string
} |
Felder |
kind |
string
Art der Ressource.
|
etag |
string
ETag der Ressource.
|
chromeosdevices[] |
object (ChromeOsDevice )
Eine Liste von ChromeOS-Geräteobjekten.
|
nextPageToken |
string
Token, das für den Zugriff auf die nächste Seite dieses Ergebnisses verwendet wird. Verwenden Sie den Wert dieses Tokens im Abfragestring pageToken dieser Anfrage, um auf die nächste Seite zuzugreifen.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
OrderBy
Enums |
ANNOTATED_LOCATION |
Standort des Chrome-Geräts, wie vom Administrator angegeben. |
ANNOTATED_USER |
Chromebook-Nutzer, wie vom Administrator angegeben. |
LAST_SYNC |
Datum und Uhrzeit der letzten Synchronisierung des Chrome-Geräts mit den Richtlinieneinstellungen in der Admin-Konsole. |
NOTES |
Hinweise zum Chrome-Gerät, wie vom Administrator festgelegt. |
SERIAL_NUMBER |
Die Seriennummer des Chrome-Geräts, die beim Aktivieren des Geräts eingegeben wurde. |
STATUS |
Chrome-Gerätestatus Weitere Informationen finden Sie unter <a chromeosdevices. |
Projektion
Die Art der Projektion, die für die Geräte angezeigt werden soll.
Enums |
BASIC |
Enthält nur die grundlegenden Metadatenfelder (z.B. deviceId, serialNumber, status und user) |
FULL |
Alle Metadatenfelder einschließen |
SortOrder
Die Sortierreihenfolge, die auf die Geräteliste angewendet werden soll.
Enums |
ASCENDING |
Aufsteigende Reihenfolge. |
DESCENDING |
Absteigende Reihenfolge. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]