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)
}
欄位
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，或在註冊過程中指定的資產 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 狀態表示 CPU 的耗電量狀態。詳情請參閱 CPU 製造商發布的說明文件。
cpuInfo[].logicalCpus[].cStates[].displayName

string

狀態名稱。
cpuInfo[].logicalCpus[].cStates[].sessionDuration

string (Duration format)

上次重新啟動後處於狀態的時間。

持續時間以秒為單位，最多 9 個小數位數，結尾為「s」。例如："3.5s"。
deviceFiles[]

object

要下載的裝置檔案清單 (唯讀)
deviceFiles[].name

string

「File name」
deviceFiles[].type

string

檔案類型
deviceFiles[].downloadUrl

string

檔案下載網址
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) 位數的十六進制數字，不含任何分隔符號 (大寫字母)。這項功能僅適用於部分裝置。
dockMacAddress

string

(唯讀) 裝置所連接的媒體插槽座的內建 MAC 位址。原廠設定會設定指派給座架使用的媒體存取控制位址 (MAC 位址)。這個 ID 是專為 MAC 通過裝置政策保留。格式為十二 (12) 位數的十六進制數字，不含任何分隔符號 (大寫字母)。這項功能僅適用於部分裝置。
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

「File name」
screenshotFiles[].type

string

檔案類型
screenshotFiles[].downloadUrl

string

檔案下載網址
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 升級轉移。您會在一年內將這部 ChromeOS Flex 裝置替換為 Chromebook。
DEPROVISION_REASON_NOT_REQUIRED 您不一定要提供原因。例如，授權會退回客戶的授權集區。
DEPROVISION_REASON_REPAIR_CENTER 裝置已由維修服務中心取消佈建。只有退貨授權期間須由維修服務中心設定。

DeviceLicenseType

這部裝置的授權類型。

列舉
DEVICE_LICENSE_TYPE_UNSPECIFIED 授權類型不明。
ENTERPRISE 裝置隨附永久 Chrome Enterprise 升級版。
ENTERPRISE_UPGRADE 裝置搭載的是獨立年約 Chrome Enterprise 升級版。
EDUCATION_UPGRADE 裝置搭載永久獨立 Chrome Education 升級版。
EDUCATION 裝置隨附永久 Chrome Education 升級版。
KIOSK_UPGRADE 裝置搭載的是年約 Kiosk 升級版。

BacklightInfo

裝置背光的相關資訊。

JSON 表示法 
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
欄位
path

string

僅供輸出。到系統上的這個背光燈路徑。如果呼叫端需要與其他資訊建立關聯，則相當實用。
maxBrightness

integer

僅供輸出。背光的最大亮度。
brightness

integer

僅供輸出。背光的目前亮度，介於 0 和最大亮度之間。

FanInfo

裝置風扇的相關資訊。

JSON 表示法 
{
  "speedRpm": integer
}
欄位
speedRpm

integer

僅供輸出。風扇速度 (RPM)。

ChromeOsType

裝置的 ChromeOS 類型。

列舉
CHROME_OS_TYPE_UNSPECIFIED 未指定 ChromeOS 類型。
CHROME_OS_FLEX Chrome OS Type Chrome OS Flex。
CHROME_OS ChromeOS 類型：ChromeOS。

方法

action
(deprecated)

 請改用 BatchChangeChromeOsDeviceStatus。

get

 擷取 Chrome OS 裝置的屬性。

list

 擷取帳戶內的 Chrome OS 裝置分頁清單。

moveDevicesToOu

 將多個 Chrome OS 裝置移動或插入至特定機構單位。

patch

 更新裝置的可更新屬性，例如 annotatedUser、annotatedLocation、notes、orgUnitPath 或 annotatedAssetId。

update

 更新裝置的可更新屬性，例如 annotatedUser、annotatedLocation、notes、orgUnitPath 或 annotatedAssetId。