Method: chromeosdevices.list

ดึงข้อมูลรายการอุปกรณ์ Chrome OS แบบแบ่งหน้าภายในบัญชี

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
customerId

string

รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในฐานะผู้ดูแลระบบบัญชี คุณสามารถใช้อีเมลแทน my_customer เพื่อแสดง customerId ของบัญชีได้เช่นกัน ระบบจะแสดงผล customerId เป็นส่วนหนึ่งของทรัพยากรผู้ใช้ด้วย

พารามิเตอร์การค้นหา

พารามิเตอร์
maxResults

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง ค่าต้องไม่เกิน 300
orderBy

enum (OrderBy)

พร็อพเพอร์ตี้อุปกรณ์ที่จะใช้จัดเรียงผลลัพธ์
orgUnitPath

string

เส้นทางแบบเต็มที่ไปยังหน่วยขององค์กร (ไม่รวม / ที่อยู่ด้านหน้า) หรือรหัสที่ไม่ซ้ำกัน
pageToken

string

ระบบจะใช้พารามิเตอร์การค้นหา pageToken ในการขอหน้าถัดไปของผลการค้นหา พารามิเตอร์การค้นหา pageToken ของคําขอติดตามคือ nextPageToken จากการตอบกลับก่อนหน้าของคุณ
projection

enum (Projection)

ระบุว่าการตอบกลับมีรายการพร็อพเพอร์ตี้ทั้งหมดหรือเพียงบางส่วน
query

string

สตริงการค้นหาในรูปแบบที่ระบุไว้ใน https://developers.google.com/workspace/admin/directory/v1/list-query-operators
sortOrder

enum (SortOrder)

แสดงผลลัพธ์ตามลําดับจากน้อยไปมากหรือมากไปน้อย ต้องใช้ร่วมกับพารามิเตอร์ orderBy
includeChildOrgunits

boolean

แสดงผลอุปกรณ์จากหน่วยขององค์กรย่อยทั้งหมด รวมถึงหน่วยขององค์กรที่ระบุ หากตั้งค่านี้เป็น "จริง" จะต้องระบุ "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

Enum
ANNOTATED_LOCATION ตำแหน่งอุปกรณ์ Chrome ตามที่ผู้ดูแลระบบกำกับเนื้อหาไว้
ANNOTATED_USER ผู้ใช้ Chromebook ตามที่ผู้ดูแลระบบกำกับเนื้อหาไว้
LAST_SYNC วันที่และเวลาที่อุปกรณ์ Chrome ทำการซิงค์กับการตั้งค่านโยบายในคอนโซลผู้ดูแลระบบครั้งล่าสุด
NOTES หมายเหตุเกี่ยวกับอุปกรณ์ Chrome ที่ผู้ดูแลระบบกำกับเนื้อหาไว้
SERIAL_NUMBER หมายเลขซีเรียลของอุปกรณ์ Chrome ที่ป้อนเมื่อเปิดใช้อุปกรณ์
STATUS สถานะอุปกรณ์ Chrome ดูข้อมูลเพิ่มเติมได้ที่ <a chromeosdevices

การฉายภาพ

ประเภทการฉายภาพที่จะแสดงสำหรับอุปกรณ์

Enum
BASIC รวมเฉพาะฟิลด์ข้อมูลเมตาพื้นฐาน (เช่น deviceId, serialNumber, status และ user)
FULL รวมช่องข้อมูลเมตาทั้งหมด

SortOrder

ลําดับการจัดเรียงที่ควรใช้กับรายการอุปกรณ์

Enum
ASCENDING เรียงลำดับจากน้อยไปมาก
DESCENDING เรียงลำดับจากมากไปน้อย