Method: chromeosdevices.list

מאחזר רשימה עם חלוקה לדפים של מכשירי Chrome OS בחשבון.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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

מחרוזת חיפוש בפורמט שמופיע באופרטורים של שאילתות ב-chromeosdevices.list.
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)

רשימה של אובייקטים של מכשירי ChromeOS.
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 סונכרן לאחרונה עם הגדרות המדיניות במסוף Admin.
NOTES הערות על מכשיר Chrome שהאדמין הוסיף.
SERIAL_NUMBER המספר הסידורי של מכשיר Chrome שהוזן כשהמכשיר הופעל.
STATUS הסטטוס של מכשיר Chrome. מידע נוסף זמין במאמר בנושא <a chromeosdevices.

היטל

סוג ההקרנה שיוצג למכשירים.

טיפוסים בני מנייה (enum)
BASIC כולל רק את שדות המטא-נתונים הבסיסיים (למשל deviceId,‏ serialNumber,‏ status ו-user)
FULL כולל את כל שדות המטא-נתונים

SortOrder

סדר המיון שצריך להחיל על רשימת המכשירים.

טיפוסים בני מנייה (enum)
ASCENDING סדר עולה.
DESCENDING סדר יורד.