Method: chromeosdevices.list

アカウント内の Chrome OS デバイスのページ分割されたリストを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

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

クエリ パラメータ

パラメータ
maxResults

integer

ページあたりの結果数の上限です。値は 300 を超えないようにしてください。
orderBy

enum (OrderBy)

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

string

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

string

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

enum (Projection)

レスポンスにプロパティの完全リストまたはサブセットのみのどちらが含まれるかを指定します。
query

string

chromeosdevices.list クエリ演算子で指定された形式の検索文字列。
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)

Chrome OS デバイス オブジェクトのリスト。
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 降順。