REST Resource: chromeosdevices

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: ChromeOsDevice

Google Chrome デバイスは Chrome OS 上で動作します。一般的な API タスクについて詳しくは、デベロッパー ガイドをご覧ください。

JSON 表現
{
  "deviceId": string,
  "serialNumber": string,
  "status": string,
  "lastSync": string,
  "supportEndDate": string,
  "annotatedUser": string,
  "annotatedLocation": string,
  "notes": string,
  "model": string,
  "meid": string,
  "orderNumber": string,
  "willAutoRenew": boolean,
  "osVersion": string,
  "platformVersion": string,
  "firmwareVersion": string,
  "macAddress": string,
  "bootMode": string,
  "lastEnrollmentTime": string,
  "kind": string,
  "recentUsers": [
    {
      "type": string,
      "email": string
    }
  ],
  "activeTimeRanges": [
    {
      "activeTime": integer,
      "date": string
    }
  ],
  "ethernetMacAddress": string,
  "annotatedAssetId": string,
  "etag": string,
  "diskVolumeReports": [
    {
      "volumeInfo": [
        {
          "volumeId": string,
          "storageTotal": string,
          "storageFree": string
        }
      ]
    }
  ],
  "systemRamTotal": string,
  "cpuStatusReports": [
    {
      "reportTime": string,
      "cpuUtilizationPercentageInfo": [
        integer
      ],
      "cpuTemperatureInfo": [
        {
          "temperature": integer,
          "label": string
        }
      ]
    }
  ],
  "cpuInfo": [
    {
      "model": string,
      "architecture": string,
      "maxClockSpeedKhz": integer,
      "logicalCpus": [
        {
          "maxScalingFrequencyKhz": integer,
          "currentScalingFrequencyKhz": integer,
          "idleDuration": string,
          "cStates": [
            {
              "displayName": string,
              "sessionDuration": string
            }
          ]
        }
      ]
    }
  ],
  "deviceFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "systemRamFreeReports": [
    {
      "reportTime": string,
      "systemRamFreeInfo": [
        string
      ]
    }
  ],
  "lastKnownNetwork": [
    {
      "ipAddress": string,
      "wanIpAddress": string
    }
  ],
  "autoUpdateExpiration": string,
  "ethernetMacAddress0": string,
  "dockMacAddress": string,
  "manufactureDate": string,
  "orgUnitPath": string,
  "tpmVersionInfo": {
    "family": string,
    "specLevel": string,
    "manufacturer": string,
    "tpmModel": string,
    "firmwareVersion": string,
    "vendorSpecific": string
  },
  "screenshotFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "orgUnitId": string,
  "osUpdateStatus": {
    object (OsUpdateStatus)
  },
  "firstEnrollmentTime": string,
  "lastDeprovisionTimestamp": string,
  "deprovisionReason": enum (DeprovisionReason)
}
フィールド
deviceId

string

Chrome デバイスの一意の ID。

serialNumber

string

デバイスが有効になったときに入力された Chrome デバイスのシリアル番号。この値は、[Chrome OS デバイス] タブの管理コンソールのシリアル番号と同じです。

status

string

デバイスのステータス。

有効な値は次のとおりです。

  • ACTIVE: デバイスがドメインに登録されている。
  • DELINQUENT: ドメインの年間ライセンスの有効期限が切れており、デバイスにポリシーと設定が適用されなくなっています。新しいライセンスを購入すると、デバイスは ACTIVE 状態に戻ります。
  • PRE_PROVISIONED: デバイスはゼロタッチ登録に登録されています。PRE_PROVISIONED デバイスを別の組織部門に移動したり、削除したりできます。登録が完了すると、デバイスは ACTIVE になります。
  • DEPROVISIONED: デバイスをドメインに登録できなくなりました。注文はキャンセルされました。デバイスの設定がデバイスにキャッシュされています。デバイスが再度有効化されると、新しく有効化したデバイスに最新のシステム設定が適用されます。
  • DISABLED: デバイスは管理者によって無効にされているため、使用できません。
  • INACTIVE: デバイスがドメインに登録されていない。
  • RETURN_ARRIVED: このデバイス交換のリクエストを承りました。
  • RETURN_REQUESTED: このデバイスの交換をリクエストしました。
  • SHIPPED: デバイスは Google の在庫から発送されます。(非推奨)
  • UNKNOWN: デバイスのステータスを特定できません。
lastSync

string

デバイスが管理コンソールのポリシー設定と最後に同期された日時です。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式(YYYY-MM-DDThh:mm:ssTZD 形式)です。例: 2010-04-05T17:30:04+01:00

supportEndDate

string

デバイスのサポート終了日。これは、Google から直接購入したデバイスにのみ適用されます。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式(YYYY-MM-DDThh:mm:ssTZD 形式)です。例: 2010-04-05T17:30:04+01:00

annotatedUser

string

管理者が指定したデバイスのユーザー。100 文字以内で指定してください。空の値も使用できます。

annotatedLocation

string

管理者が指定したデバイスの住所または場所。最大文字数は 200 文字です。空の値も使用できます。

notes

string

管理者によって追加された、このデバイスに関する注意事項。このプロパティは、list メソッドの query パラメータで検索できます。最大文字数は 500 文字です。空の値も使用できます。

model

string

デバイスのモデル情報。デバイスにこの情報がない場合、このプロパティはレスポンスに含まれません。

meid

string

モバイル デバイス上の 3G モバイルカードのモバイル機器識別子(MEID)または国際移動体装置識別番号(IMEI)MEID/IMEI は通常、デバイスを携帯通信会社の後払いサービスプランに追加するときに使用されます。デバイスにこの情報がない場合、このプロパティはレスポンスに含まれません。MEID/IMEI リストをエクスポートする方法の詳細については、デベロッパー ガイドをご覧ください。

orderNumber

string

デバイスの注文番号注文番号は Google から直接購入したデバイスにのみ適用されます。

willAutoRenew

boolean

サポート終了日以降にデバイスのサポートを自動更新するかどうかを指定します。これは読み取り専用のプロパティです。

osVersion

string

Chrome デバイスのオペレーティング システムのバージョン。

platformVersion

string

Chrome デバイスのプラットフォーム バージョン。

firmwareVersion

string

Chrome デバイスのファームウェア バージョン。

macAddress

string

デバイスのワイヤレス MAC アドレス。このような情報がデバイスにない場合、レスポンスには含まれません。

bootMode

string

デバイスの起動モード。使用できる値は次のとおりです。

  • Verified: デバイスは有効なバージョンの Chrome OS を搭載しています。
  • Dev: デバイスのデベロッパー ハードウェア スイッチが有効になっています。デバイスを起動すると、コマンドライン シェルが表示されます。デベロッパーの切り替えの例については、Chromebook デベロッパー情報をご覧ください。
lastEnrollmentTime

string

デバイスが最後に登録された日時。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式(YYYY-MM-DDThh:mm:ssTZD 形式)です。例: 2010-04-05T17:30:04+01:00。自動登録と手動登録について詳しくは、Chrome ヘルプセンターをご覧ください。

kind

string

リソースのタイプ。Chromeosdevices リソースの値は admin#directory#chromeosdevice です。

recentUsers[]

object

最近のデバイス ユーザーのリスト(最終ログイン時間の降順)。

recentUsers[].type

string

ユーザーのタイプ。

有効な値は次のとおりです。

  • USER_TYPE_MANAGED: ユーザーはドメインによって管理されています。
  • USER_TYPE_UNMANAGED: ユーザーはドメインによって管理されていません。
recentUsers[].email

string

ユーザーのメールアドレス。これは、ユーザータイプが USER_TYPE_MANAGED の場合にのみ存在します。

activeTimeRanges[]

object

有効な期間のリスト(読み取り専用)。

activeTimeRanges[].activeTime

integer

使用時間(ミリ秒)。

activeTimeRanges[].date

string

使用日。

ethernetMacAddress

string

イーサネット ネットワーク インターフェース上のデバイスの MAC アドレス。

annotatedAssetId

string

管理者が指定する、または登録時に指定されたアセット ID。

etag

string

リソースの ETag。

diskVolumeReports[]

object

マウントされたボリューム、接続されたボリュームに関するディスク容量やその他の情報のレポート。

diskVolumeReports[].volumeInfo[]

object

ディスク ボリューム

diskVolumeReports[].volumeInfo[].volumeId

string

ボリューム ID

diskVolumeReports[].volumeInfo[].storageTotal

string (int64 format)

合計ディスク容量(バイト単位)

diskVolumeReports[].volumeInfo[].storageFree

string (int64 format)

空きディスク容量(バイト単位)

systemRamTotal

string (int64 format)

デバイスの RAM の合計(バイト

cpuStatusReports[]

object

CPU 使用率と温度のレポート(読み取り専用)

cpuStatusReports[].reportTime

string

レポートを受信した日時。

cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer

cpuStatusReports[].cpuTemperatureInfo[]

object

CPU 温度サンプルのリスト。

cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

温度(摂氏)。

cpuStatusReports[].cpuTemperatureInfo[].label

string

CPU ラベル

cpuInfo[]

object

デバイスの CPU 仕様に関する情報。

cpuInfo[].model

string

CPU モデル名。

cpuInfo[].architecture

string

CPU アーキテクチャ。

cpuInfo[].maxClockSpeedKhz

integer

最大 CPU クロック速度(kHz)。

cpuInfo[].logicalCpus[]

object

論理 CPU の情報

cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

ポリシーによる CPU の実行を許可する最大頻度。

cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

CPU が動作している現在の周波数。

cpuInfo[].logicalCpus[].idleDuration

string (Duration format)

前回の起動からのアイドル時間。

小数点以下 9 桁までの値で、末尾が「s」の秒数です。例: "3.5s"

cpuInfo[].logicalCpus[].cStates[]

object

C-States は、CPU の消費電力状態を示します。詳しくは、CPU メーカーが公開しているドキュメントをご覧ください。

cpuInfo[].logicalCpus[].cStates[].displayName

string

都道府県名。

cpuInfo[].logicalCpus[].cStates[].sessionDuration

string (Duration format)

前回の再起動からの経過時間。

小数点以下 9 桁までの値で、末尾が「s」の秒数です。例: "3.5s"

deviceFiles[]

object

ダウンロードするデバイス ファイルのリスト(読み取り専用)

deviceFiles[].name

string

ファイル名

deviceFiles[].type

string

ファイル形式

deviceFiles[].downloadUrl

string

ファイルのダウンロード URL

deviceFiles[].createTime

string

ファイルが作成された日時

systemRamFreeReports[]

object

使用可能な RAM メモリ容量のレポート(読み取り専用)

systemRamFreeReports[].reportTime

string

レポートを受信した日時。

systemRamFreeReports[].systemRamFreeInfo[]

string (int64 format)

lastKnownNetwork[]

object

最後に検出されたネットワークを含む(読み取り専用)

lastKnownNetwork[].ipAddress

string

IP アドレス。

lastKnownNetwork[].wanIpAddress

string

WAN IP アドレス。

autoUpdateExpiration

string (int64 format)

(読み取り専用)デバイスが Chrome の更新またはサポートを停止するためのタイムスタンプ。

ethernetMacAddress0

string

(読み取り専用)Chromebook の内部イーサネット ポートとオンボード ネットワーク(イーサネット)インターフェースで使用される MAC アドレス。形式は 12 桁の 16 進数で、区切り文字は大文字になりません。これは一部のデバイスのみが対象です。

dockMacAddress

string

(読み取り専用)デバイスが接続されているドッキング ステーション用の内蔵 MAC アドレス。ドックで使用するメディアのアクセス制御アドレス(MAC アドレス)を、工場出荷時に設定します。これは MAC パススルー デバイス ポリシー専用に予約されています。形式は 12 桁の 16 進数で、区切り文字は大文字になりません。これは一部のデバイスのみが対象です。

manufactureDate

string

(読み取り専用)デバイスが製造された日付(yyyy-mm-dd)。

orgUnitPath

string

デバイスに関連付けられた組織部門の名前を含む完全な親パス。パス名では大文字と小文字が区別されません。親組織部門が最上位の組織である場合、それはスラッシュ(/)として表されます。このプロパティは API を使用して更新できます。デバイスの組織構造を作成する方法について詳しくは、管理者向けヘルプセンターをご覧ください。

tpmVersionInfo

object

Trusted Platform Module(TPM)(読み取り専用)

tpmVersionInfo.family

string

TPM ファミリー。Google では TPM 2.0 スタイルのエンコードを使用しています。例:
TPM 1.2: "1.2" から 312e3200 へ
TPM 2.0: "2.0" から 322e3000 へ

tpmVersionInfo.specLevel

string

TPM の仕様レベル。TPM 2.0 のライブラリ仕様と TPM 1.2 のメイン仕様をご覧ください。

tpmVersionInfo.manufacturer

string

TPM メーカーコード。

tpmVersionInfo.tpmModel

string

TPM のモデル番号。

tpmVersionInfo.firmwareVersion

string

TPM ファームウェアのバージョン。

tpmVersionInfo.vendorSpecific

string

ベンダー固有の情報(ベンダー ID など)。

screenshotFiles[]

object

ダウンロードするスクリーンショット ファイルのリスト。タイプは常に「SCREENSHOT_FILE」です。(読み取り専用)

screenshotFiles[].name

string

ファイル名

screenshotFiles[].type

string

ファイル形式

screenshotFiles[].downloadUrl

string

ファイルのダウンロード URL

screenshotFiles[].createTime

string

ファイルが作成された日時

orgUnitId

string

組織部門の一意の ID。orgUnitPath は、人が読める形式の orgUnitId バージョンです。orgUnitPath はパス内の組織部門の名前を変更することで変わる可能性がありますが、orgUnitId を 1 つの組織部門で変更することはできません。このプロパティは API を使用して更新できます。デバイスの組織構造を作成する方法について詳しくは、管理者向けヘルプセンターをご覧ください。

osUpdateStatus

object (OsUpdateStatus)

デバイスの OS アップデートのステータス。

firstEnrollmentTime

string

デバイスが初めて登録された日時。

lastDeprovisionTimestamp

string

(読み取り専用)デバイスが最後にデプロビジョニングされた日時。

deprovisionReason

enum (DeprovisionReason)

(読み取り専用)デプロビジョニングの理由。

OS の更新ステータス

現在の OS アップデート ステータスに関する情報が含まれています。

JSON 表現
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
フィールド
state

enum (UpdateState)

OS アップデートの更新状態。

targetOsVersion

string

ダウンロードおよび適用される OS イメージの新しいプラットフォーム バージョン。更新ステータスが UPDATE_STATUS_Downloads_IN_PROGRESS または UPDATE_STATUS_NEED_REBOOT の場合にのみ設定されます。一部のエッジケース(更新エンジンが再起動されずに再起動されるなど)では、ダミーの「0.0.0.0」が UPDATE_STATUS_NEED_REBOOT になる場合があります。

targetKioskAppVersion

string

保留中の更新済みキオスクアプリで必要な新しいプラットフォーム バージョン。

updateTime

string

最後の正常な OS アップデートの日時。

updateCheckTime

string

前回の更新チェックの日時。

rebootTime

string

前回の再起動の日時。

UpdateState

OS アップデートの更新状態。

列挙型
UPDATE_STATE_UNSPECIFIED 更新状態が指定されていません。
UPDATE_STATE_NOT_STARTED 保留中の更新がありますが、まだ開始されていません。
UPDATE_STATE_DOWNLOAD_IN_PROGRESS 保留中のアップデートをダウンロードしています。
UPDATE_STATE_NEED_REBOOT デバイスにアップデートをインストールする準備ができましたが、再起動する必要があります。

デプロビジョニングの理由

デバイスがデプロビジョニングされた理由。

列挙型
DEPROVISION_REASON_UNSPECIFIED デプロビジョニングの理由は不明です。
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT デバイスが同じモデルのデバイスに置き換えられました。
DEPROVISION_REASON_UPGRADE デバイスはアップグレードされました。
DEPROVISION_REASON_DOMAIN_MOVE デバイスのドメインが変更されました。
DEPROVISION_REASON_SERVICE_EXPIRATION デバイスのサービスが期限切れになりました。
DEPROVISION_REASON_OTHER デバイスは、サポートが終了した古い理由によりデプロビジョニングされました。
DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT デバイスを、別のモデルのデバイスと交換した。
DEPROVISION_REASON_RETIRING_DEVICE デバイスの使用が終了しました。
DEPROVISION_REASON_UPGRADE_TRANSFER デバイスの永久ライセンスは、新しいデバイスに移行されました。
DEPROVISION_REASON_NOT_REQUIRED 理由は不要です。たとえば、ライセンスがお客様のライセンス プールに戻された場合です。
DEPROVISION_REASON_REPAIR_CENTER デバイスは修理サービス センターからデプロビジョニングされました。

Methods

action

Chrome OS デバイスに影響するアクションを実行します。

get

Chrome OS デバイスのプロパティを取得します。

list

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

moveDevicesToOu

組織部門に複数の Chrome OS デバイスを移動または挿入します。

patch

デバイスの更新可能なプロパティ(annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId など)を更新します。

update

デバイスの更新可能なプロパティ(annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId など)を更新します。