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),
  "backlightInfo": [
    {
      object (BacklightInfo)
    }
  ],
  "autoUpdateThrough": string,
  "extendedSupportEligible": boolean,
  "extendedSupportStart": string,
  "extendedSupportEnabled": boolean,
  "fanInfo": [
    {
      object (FanInfo)
    }
  ],
  "chromeOsType": enum (ChromeOsType),
  "diskSpaceUsage": {
    object (ByteUsage)
  },
  "osVersionCompliance": enum (Compliance),
  "bluetoothAdapterInfo": [
    {
      object (BluetoothAdapterInfo)
    }
  ]
}
フィールド
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)

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

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
cpuInfo[].logicalCpus[].cStates[]

object

C-State は、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

ファイル形式
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
(deprecated)

string (int64 format)

（読み取り専用）デバイスが Chrome のアップデートやサポートの受信を停止するタイムスタンプ。代わりに「autoUpdateThrough」を使用してください。
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 ファミリー。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)

（読み取り専用）デプロビジョニングの理由。
deviceLicenseType

enum (DeviceLicenseType)

出力専用。デバイスのライセンスの種類。
backlightInfo[]

object (BacklightInfo)

出力専用。デバイスのバックライト情報が含まれます。
autoUpdateThrough

string

出力専用。デバイスが Chrome のアップデートやサポートの受信を停止するタイムスタンプ。
extendedSupportEligible

boolean

出力専用。デバイスで延長サポートのオプトインが必要かどうか。
extendedSupportStart

string

出力専用。自動更新の延長サポート ポリシーが開始されるデバイスの日付。
extendedSupportEnabled

boolean

出力専用。デバイスで延長サポート ポリシーが有効になっているかどうか。
fanInfo[]

object (FanInfo)

出力専用。デバイスのファンに関する情報。
chromeOsType

enum (ChromeOsType)

出力専用。デバイスの ChromeOS のタイプ。
diskSpaceUsage

object (ByteUsage)

出力専用。デバイスで使用可能なディスク容量と、現在使用しているディスク容量。
osVersionCompliance

enum (Compliance)

出力専用。OS バージョンのデバイス ポリシーの準拠ステータス。
bluetoothAdapterInfo[]

object (BluetoothAdapterInfo)

出力専用。デバイスの Bluetooth アダプタに関する情報。

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

ChromeOS デバイスのプロビジョニングを解除した理由。

列挙型
DEPROVISION_REASON_UNSPECIFIED プロビジョニング解除の理由は不明です。
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT 同じモデルに交換します。交換保証（RMA）があり、保証対象となる故障したデバイスを同じデバイスのモデルに交換する場合。
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 ChromeOS Flex をアップグレード（移行）します。1 年以内に Chromebook に交換する ChromeOS Flex デバイスである場合。
DEPROVISION_REASON_NOT_REQUIRED 理由の入力は必須ではありませんでした。たとえば、ライセンスがお客様のライセンス プールに戻された場合などです。
DEPROVISION_REASON_REPAIR_CENTER デバイスは修理サービス センターによってプロビジョニング解除されました。RMA の際に修理サービス センターのみが設定できます。

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 の年間ライセンスが適用されている。
ENTERPRISE_UPGRADE_PERPETUAL デバイスがスタンドアロンの永久 Chrome Enterprise Upgrade（Chrome Enterprise ライセンス）を使用していることを示します。
ENTERPRISE_UPGRADE_FIXED_TERM デバイスがスタンドアロンの期間限定 Chrome Enterprise Upgrade（Chrome Enterprise ライセンス）を使用していることを示します。
EDUCATION_UPGRADE_PERPETUAL デバイスがスタンドアロンの永久 Chrome Education Upgrade（Chrome EDU 永久ライセンス）を使用していることを示します。
EDUCATION_UPGRADE_FIXED_TERM デバイスがスタンドアロンの期間限定 Chrome Education Upgrade（Chrome EDU 期間限定ライセンス）を使用していることを示します。

BacklightInfo

デバイスのバックライトに関する情報。

JSON 表現 
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
フィールド
path

string

出力専用。システム上のこのバックライトへのパス。電話口のお客様が他の情報と関連付ける必要がある場合に便利です。
maxBrightness

integer

出力専用。バックライトの最大輝度。
brightness

integer

出力専用。バックライトの現在の明るさ（0 ～ maxBrightness）。

FanInfo

デバイスのファンに関する情報。

JSON 表現 
{
  "speedRpm": integer
}
フィールド
speedRpm

integer

出力専用。ファンの速度（RPM）。

ChromeOsType

デバイスの ChromeOS のタイプ。

列挙型
CHROME_OS_TYPE_UNSPECIFIED Chrome OS のタイプが指定されていません。
CHROME_OS_FLEX Chrome OS のタイプ: Chrome OS Flex。
CHROME_OS Chrome OS の種類: [Chrome OS] を選択します。

ByteUsage

現在の使用量（バイト単位）を含むデータ容量を表します。

JSON 表現 
{
  "capacityBytes": string,
  "usedBytes": string
}
フィールド
capacityBytes

string (int64 format)

出力専用。合計容量の値（バイト単位）。
usedBytes

string (int64 format)

出力専用。現在の使用量（バイト単位）。

コンプライアンス

OS バージョンのデバイス ポリシーの準拠ステータス。

列挙型
COMPLIANCE_UNSPECIFIED コンプライアンス ステータスが指定されていません。
COMPLIANT コンプライアンス ステータスが準拠している。
PENDING コンプライアンス ステータスが保留中です。
NOT_COMPLIANT コンプライアンス ステータスが準拠していない。

BluetoothAdapterInfo

デバイスの Bluetooth アダプタに関する情報。

JSON 表現 
{
  "address": string,
  "numConnectedDevices": integer
}
フィールド
address

string

出力専用。アダプターの MAC アドレス。
numConnectedDevices

integer

出力専用。このアダプターに接続されているデバイスの数。

メソッド

action
(deprecated)

 代わりに BatchChangeChromeOsDeviceStatus を使用してください。

get

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

list

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

moveDevicesToOu

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

patch

 annotatedUser、annotatedLocation、notes、orgUnitPath、annotatedAssetId など、デバイスの更新可能なプロパティを更新します。

update

 annotatedUser、annotatedLocation、notes、orgUnitPath、annotatedAssetId など、デバイスの更新可能なプロパティを更新します。