אחזור רשימה מחולקת לדפים של מכשירי Chrome OS בחשבון.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
| customerId | 
 המזהה הייחודי של חשבון Google Workspace של הלקוח. כאדמינים של החשבון, אתם יכולים גם להשתמש בכתובת החלופית  | 
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
| maxResults | 
 המספר המקסימלי של תוצאות להחזרה. הערך לא יכול להיות גדול מ-300. | 
| orderBy | 
 מאפיין המכשיר שמשמש למיון התוצאות. | 
| orgUnitPath | 
 הנתיב המלא של היחידה הארגונית (ללא  | 
| pageToken | 
 פרמטר השאילתה  | 
| projection | 
 קובע אם התשובה מכילה את רשימת הנכסים המלאה או רק קבוצת משנה. | 
| query | 
 מחרוזת חיפוש בפורמט שמופיע בכתובת https://developers.google.com/workspace/admin/directory/v1/list-query-operators | 
| sortOrder | 
 האם להציג את התוצאות בסדר עולה או יורד. חובה להשתמש בו עם הפרמטר  | 
| includeChildOrgunits | 
 הפונקציה מחזירה מכשירים מכל היחידות הארגוניות המשניות, וגם מהיחידה הארגונית שצוינה. אם הערך מוגדר כ-true, צריך לספק את 'orgUnitPath'. | 
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON | 
|---|
| {
  "kind": string,
  "etag": string,
  "chromeosdevices": [
    {
      object ( | 
| שדות | |
|---|---|
| kind | 
 סוג המשאב. | 
| etag | 
 ה-ETag של המשאב. | 
| chromeosdevices[] | 
 רשימה של אובייקטים של מכשירי Chrome OS. | 
| nextPageToken | 
 אסימון המשמש לגישה לדף הבא של התוצאה הזו. כדי לגשת לדף הבא, צריך להשתמש בערך האסימון הזה במחרוזת השאילתה  | 
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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. מידע נוסף זמין במאמר chromeosdevices. | 
היטל
סוג התחזית שמוצגת לגבי המכשירים.
| טיפוסים בני מנייה (enum) | |
|---|---|
| BASIC | כולל רק את שדות המטא-נתונים הבסיסיים (למשל, deviceId, serialNumber, status ו-user) | 
| FULL | כולל את כל שדות המטא-נתונים | 
SortOrder
סדר המיון שצריך להחיל על רשימת המכשירים.
| טיפוסים בני מנייה (enum) | |
|---|---|
| ASCENDING | סדר עולה. | 
| DESCENDING | בסדר יורד. |