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。アカウント管理者は、my_customer エイリアスを使用してアカウントの customerId を表すことができます。customerId は、Users リソースの一部としても返されます。

クエリ パラメータ

パラメータ
maxResults

integer

返される結果の最大数。

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)

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

詳しくは、OAuth 2.0 の概要をご覧ください。

OrderBy

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

予測

デバイスに表示する投影の種類。

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

SortOrder

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

列挙型
ASCENDING 昇順。
DESCENDING 降順。