Method: chromeosdevices.list

Ruft eine paginierte Liste von ChromeOS-Geräten 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 darzustellen. Die customerId wird auch als Teil der Users-Ressource zurückgegeben.

Suchparameter

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 das führende /) oder die 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 Eigenschaften oder nur einen Teil enthält.

query

string

Suchstring im Format, das unter chromeosdevices.list query operators angegeben ist.

sortOrder

enum (SortOrder)

Gibt an, ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Muss mit dem Parameter orderBy verwendet werden.

includeChildOrgunits

boolean

Gibt Geräte aus allen untergeordneten Organisationseinheiten sowie der angegebenen Organisationseinheit zurück. Wenn dieser Wert auf „true“ 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 mit Chrome OS-Geräteobjekten.

nextPageToken

string

Token für den Zugriff auf die nächste Seite dieses Ergebnisses. Wenn Sie auf die nächste Seite zugreifen möchten, verwenden Sie den Wert dieses Tokens im Abfragestring pageToken dieser Anfrage.

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

OrderBy

Enums
ANNOTATED_LOCATION Standort des Chrome-Geräts, wie vom Administrator angegeben.
ANNOTATED_USER Der vom Administrator festgelegte Chromebook-Nutzer.
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 angegeben.
SERIAL_NUMBER Die Seriennummer des Chrome-Geräts, die bei der Aktivierung des Geräts eingegeben wurde.
STATUS Status des Chrome-Geräts. Weitere Informationen finden Sie unter <a chromeosdevices.

Prognose

Der Typ 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 Umfasst alle Metadatenfelder

SortOrder

Die Sortierreihenfolge, die auf die Geräteliste angewendet werden soll.

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.