Method: chromeosdevices.list

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

HTTP 要求

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

客戶 Google Workspace 帳戶的專屬 ID。身為帳戶管理員，您也可以使用 my_customer 別名來代表帳戶的 customerId。customerId 也會做為使用者資源的一部分傳回。

查詢參數

參數
maxResults

integer

要傳回的結果數上限。
orderBy

enum (OrderBy)

用於排序結果的裝置屬性。
orgUnitPath

string

機構單位的完整路徑 (省略開頭的 /) 或其專屬 ID。
pageToken

string

pageToken 查詢參數用於要求下一頁的查詢結果。後續要求的 pageToken 查詢參數為先前回應中的 nextPageToken。
projection

enum (Projection)

將傳回的資訊傳回一組所選欄位。
query

string

搜尋格式，格式為 https://developers.google.com/admin-sdk/directory/v1/list-query-Otortors
sortOrder

enum (SortOrder)

要以遞增或遞減順序傳回結果。必須與 orderBy 參數搭配使用。
includeChildOrgunits

boolean

傳回所有子機構單位和指定機構單位中的裝置。如果設為 True，就必須提供「orgUnitPath」。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "chromeosdevices": [
    {
      object (ChromeOsDevice)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

資源種類。
etag

string

資源的 ETag。
chromeosdevices[]

object (ChromeOsDevice)

Chrome OS 裝置物件清單。
nextPageToken

string

用於存取這個結果下一頁的權杖。如要存取下一頁，請在這項要求的 pageToken 查詢字串中使用這個權杖的值。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.directory.device.chromeos
  • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly

詳情請參閱授權指南。

OrderBy

列舉
ANNOTATED_LOCATION 管理員註記的 Chrome 裝置位置。
ANNOTATED_USER 由管理員加註的 Chromebook 使用者。
LAST_SYNC Chrome 裝置上次與管理控制台政策設定同步處理的日期和時間。
NOTES 管理員註記的 Chrome 裝置附註。
SERIAL_NUMBER 啟用裝置時所輸入的 Chrome 裝置序號。
STATUS Chrome 裝置狀態。詳情請參閱 <a 觸控螢幕裝置。

投影

要為裝置顯示的投影類型。

列舉
BASIC 只包含基本的中繼資料欄位 (例如 deviceId、serialNumber、status 和 user)
FULL 包含所有中繼資料欄位

SortOrder

應套用至裝置清單的排序順序。

列舉
ASCENDING 遞增順序。
DESCENDING 遞減順序。