REST Resource: chromeosdevices

資源:ChromeOsDevice

Google Chrome 裝置搭載 Chrome 作業系統。如要進一步瞭解常見的 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)
    }
  ]
}
欄位
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-State 表示 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

string (int64 format)

(唯讀) 裝置停止接收 Chrome 更新或支援的時間戳記

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

「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)

僅供輸出。包含裝置的背光資訊。

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 與最大亮度之間。

方法

action
(deprecated)

請改用 BatchChangeChromeOsDeviceStatus

get

擷取 Chrome OS 裝置的屬性。

list

擷取帳戶中的 Chrome 作業系統裝置清單。

moveDevicesToOu

將多個 Chrome 作業系統裝置移動或插入至同一個機構單位。

patch

更新裝置的可更新屬性,例如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId

update

更新裝置的可更新屬性,例如 annotatedUserannotatedLocationnotesorgUnitPathannotatedAssetId