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),
  "deviceLicenseType": enum (DeviceLicenseType)
}
フィールド
deviceId

string

Chrome デバイスの一意の ID です。

serialNumber

string

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

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(Mobile Equipment Identifier)または IMEI(International Mobile Equipment Identity)。MEID/IMEI は通常、携帯通信会社の後払いサービスプランにデバイスを追加するときに使用されます。デバイスにこの情報がない場合、このプロパティはレスポンスに含まれません。MEID または IMEI のリストをエクスポートする方法について詳しくは、デベロッパー ガイドをご覧ください。

orderNumber

string

デバイスの注文番号です。注文番号が付いているのは、Google から直接購入したデバイスのみです。

willAutoRenew

boolean

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

osVersion

string

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

platformVersion

string

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

firmwareVersion

string

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

macAddress

string

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

bootMode

string

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

  • Verified: デバイスは有効なバージョンの ChromeOS で動作しています。
  • 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)

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

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

cpuInfo[].logicalCpus[].cStates[]

object

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

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

string

州の名前。

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

string (Duration format)

前回の再起動以降の状態での経過時間。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

deviceFiles[]

object

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

deviceFiles[].name

string

ファイル名

deviceFiles[].type

string

File type

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

トラステッド プラットフォーム モジュール(TPM)(読み取り専用)

tpmVersionInfo.family

string

TPM ファミリー。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

File type

screenshotFiles[].downloadUrl

string

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

screenshotFiles[].createTime

string

ファイルの作成日時

orgUnitId

string

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

osUpdateStatus

object (OsUpdateStatus)

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

firstEnrollmentTime

string

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

lastDeprovisionTimestamp

string

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

deprovisionReason

enum (DeprovisionReason)

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

deviceLicenseType

enum (DeviceLicenseType)

出力のみ。デバイスのライセンスの種類。

OsUpdateStatus

現在の OS 更新ステータスに関する情報が含まれています。

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

enum (UpdateState)

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

targetOsVersion

string

ダウンロードされて適用される OS イメージの新しいプラットフォーム バージョン。アップデート ステータスが UPDATE_STATUS_DOWNLOAD_IN_PROGRESS または UPDATE_STATUS_NEED_REBOOT の場合にのみ設定されます。これは、アップデート エンジンが再起動なしで再起動されるなどのエッジケースでは、UPDATE_STATUS_NEED_REBOOT のダミー「0.0.0.0」である可能性があることに注意してください。

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 デバイスはアップデートをインストールする準備ができていますが、再起動する必要があります。

DeprovisionReason

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

列挙型
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 修理サービス センターによってデバイスのプロビジョニングが解除されました。

DeviceLicenseType

このデバイスのライセンスの種類。

列挙型
DEVICE_LICENSE_TYPE_UNSPECIFIED ライセンスの種類が不明です。
ENTERPRISE デバイスには Chrome Enterprise Upgrade の永久ライセンスがバンドルされています。
ENTERPRISE_UPGRADE デバイスには、単体の Chrome Enterprise Upgrade の年間ライセンスが適用されている。
EDUCATION_UPGRADE デバイスには、単体の Chrome Education Upgrade の永久ライセンスが適用されている。
EDUCATION デバイスには Chrome Education Upgrade の永久ライセンスがバンドルされています。
KIOSK_UPGRADE デバイスに Kiosk Upgrade の年間ライセンスが適用されている。

Methods

action

ChromeOS デバイスに影響する操作を行います。

get

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

list

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

moveDevicesToOu

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

patch

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

update

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