Method: chromeosdevices.list

アカウント内の ChromeOS デバイスのページネーション付きリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

お客様の Google Workspace アカウントの一意の ID。アカウント管理者は、my_customer エイリアスを使用してアカウントの customerId を表すこともできます。customerId は、ユーザー リソースの一部としても返されます。

クエリ パラメータ

パラメータ
maxResults

integer

返される結果の最大数。値は 300 以下にする必要があります。
orderBy

enum (OrderBy)

結果の並べ替えに使用するデバイス プロパティ。
orgUnitPath

string

組織部門のフルパス（先頭の / を除く）または一意の ID。
pageToken

string

pageToken クエリ パラメータは、クエリ結果の次のページをリクエストする際に使用します。次のリクエストの pageToken クエリ パラメータは、前のレスポンスの nextPageToken です。
projection

enum (Projection)

レスポンスにプロパティの全リストを含めるか、サブセットのみを含めるかを指定します。
query

string

https://developers.google.com/admin-sdk/directory/v1/list-query-operators に記載されている形式の検索文字列
sortOrder

enum (SortOrder)

結果を昇順または降順のどちらで返すかを指定します。orderBy パラメータと一緒に使用する必要があります。
includeChildOrgunits

boolean

指定された組織部門だけでなく、すべての子組織部門のデバイスを返します。true に設定した場合は、「orgUnitPath」を指定する必要があります。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "kind": string,
  "etag": string,
  "chromeosdevices": [
    {
      object (ChromeOsDevice)
    }
  ],
  "nextPageToken": string
}
フィールド
kind

string

リソースの種類。
etag

string

リソースの ETag。
chromeosdevices[]

object (ChromeOsDevice)

ChromeOS Device オブジェクトのリスト。
nextPageToken

string

この結果の次のページにアクセスするために使用されるトークン。次のページにアクセスするには、このリクエストの pageToken クエリ文字列でこのトークンの値を使用します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、認可ガイドをご覧ください。

OrderBy

列挙型
ANNOTATED_LOCATION 管理者によってアノテーションが付けられた、Chrome デバイスの位置情報。
ANNOTATED_USER 管理者によってアノテーションが付けられた、Chromebook のユーザー。
LAST_SYNC Chrome デバイスが管理コンソールのポリシー設定と最後に同期された日時です。
NOTES 管理者によってアノテーションが付けられた、Chrome デバイスに関するメモ。
SERIAL_NUMBER デバイスの有効化時に入力した Chrome デバイスのシリアル番号。
STATUS Chrome デバイスのステータス。詳しくは、<a chromeosdevices をご覧ください。

予測

デバイスに表示する投影のタイプ。

列挙型
BASIC 基本的なメタデータ フィールド（deviceId、serialNumber、status、user など）のみを含む
FULL すべてのメタデータ フィールドが含まれます

SortOrder

デバイスリストに適用する並べ替え順序。

列挙型
ASCENDING 昇順。
DESCENDING 降順。