REST Resource: chromeosdevices

リソース: ChromeOsDevice

Google Chrome デバイスは ChromeOS で動作します。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)
}
フィールド
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 モバイルカードの Mobile Equipment Identifier（MEID）または International Mobile Equipment Identity（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: デバイスは有効なバージョンの 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-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

トラステッド プラットフォーム モジュール（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 は組織部門ごとに変更できません。このプロパティは、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 の種類。

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 デバイスに年間のキオスク アップグレードが適用されている。

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 ChromeOS の種類が指定されていません。
CHROME_OS_FLEX ChromeOS タイプ: ChromeOS Flex。
CHROME_OS ChromeOS タイプ: ChromeOS

メソッド

action
(deprecated)

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

get

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

list

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

moveDevicesToOu

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

patch

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

update

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