REST Resource: chromeosdevices

Resource: 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),
  "diskSpaceUsage": {
    object (ByteUsage)
  },
  "osVersionCompliance": enum (Compliance)
}
欄位
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) 或國際行動裝置識別碼 (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)

上次開機後經過的閒置時間。

時間長度以秒為單位，最多可有 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

檔案名稱
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 位址)。這項設定專供 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

檔案名稱
screenshotFiles[].type

string

檔案類型
screenshotFiles[].downloadUrl

string

檔案下載網址
screenshotFiles[].createTime

string

檔案建立日期和時間
orgUnitId

string

機構單位的專屬 ID。orgUnitPath 是 orgUnitId 的可讀版本。雖然機構單位路徑中的機構單位名稱可以變更，但機構單位 ID 無法變更。您可以使用 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 版本的裝置政策遵循狀態。

OsUpdateStatus

包含目前 OS 更新狀態的相關資訊。

JSON 表示法 
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
欄位
state

enum (UpdateState)

作業系統更新的更新狀態。
targetOsVersion

string

正在下載及套用新平台版本的 OS 映像檔。只有在更新狀態為 UPDATE_STATUS_DOWNLOAD_IN_PROGRESS 或 UPDATE_STATUS_NEED_REBOOT 時，才會設定這個值。請注意，在某些特殊情況下，這可能是 UPDATE_STATUS_NEED_REBOOT 的虛擬「0.0.0.0」，例如更新引擎在未重新啟動的情況下重新啟動。
targetKioskAppVersion

string

待更新 Kiosk 應用程式的新必要平台版本。
updateTime

string

上次成功更新作業系統的日期和時間。
updateCheckTime

string

上次檢查更新的日期和時間。
rebootTime

string

上次重新啟動的日期和時間。

UpdateState

作業系統更新的更新狀態。

列舉
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 維修服務中心已取消佈建這部裝置，只能在退貨授權 (RMA) 期間由維修服務中心設定。

DeviceLicenseType

這部裝置的授權類型。

列舉
DEVICE_LICENSE_TYPE_UNSPECIFIED 授權類型不明。
ENTERPRISE 裝置隨附永久 Chrome Enterprise 升級版。
ENTERPRISE_UPGRADE

裝置具備獨立 Chrome Enterprise 升級版的年約授權。
EDUCATION_UPGRADE

裝置具有永久獨立的 Chrome Education 升級版授權。
EDUCATION 裝置隨附永久 Chrome Education 升級版。
KIOSK_UPGRADE 裝置具備年約 Kiosk 升級授權。
ENTERPRISE_UPGRADE_PERPETUAL 指出裝置正在使用獨立的永久 Chrome Enterprise 升級授權或 Chrome Enterprise 授權。
ENTERPRISE_UPGRADE_FIXED_TERM 表示裝置正在使用獨立的固定期限 Chrome Enterprise 升級版或 Chrome Enterprise 授權。
EDUCATION_UPGRADE_PERPETUAL 表示裝置正在使用獨立的永久 Chrome Education 升級版(又稱 Chrome EDU 永久授權)。
EDUCATION_UPGRADE_FIXED_TERM 表示裝置正在使用獨立的固定期限 Chrome Education 升級版(又稱 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 未指定 ChromeOS 類型。
CHROME_OS_FLEX Chrome OS 類型：Chrome OS Flex。
CHROME_OS 輸入「ChromeOS」。

ByteUsage

代表資料容量，以及目前使用的位元組數。

JSON 表示法 
{
  "capacityBytes": string,
  "usedBytes": string
}
欄位
capacityBytes

string (int64 format)

僅供輸出。總容量值 (以位元組為單位)。
usedBytes

string (int64 format)

僅供輸出。目前的使用量值 (以位元組為單位)。

法規遵循

OS 版本的裝置政策遵循狀態。

列舉
COMPLIANCE_UNSPECIFIED 未指定法規遵循狀態。
COMPLIANT 法規遵循狀態為「符合規定」。
PENDING 法規遵循狀態為待處理。
NOT_COMPLIANT 法規遵循狀態為「不符合規定」。

方法

action
(deprecated)

 請改用 BatchChangeChromeOsDeviceStatus。

get

 擷取 ChromeOS 裝置的屬性。

list

 擷取帳戶中 ChromeOS 裝置的分頁清單。

moveDevicesToOu

 將多部 ChromeOS 裝置移至或插入特定機構單位。

patch

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

update

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