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

מספר התוצאות המקסימלי שיוחזר.
orderBy

enum (OrderBy)

מאפיין מכשיר לשימוש למיון התוצאות.
orgUnitPath

string

הנתיב המלא של היחידה הארגונית (פחות ה-/ המובילים) או המזהה הייחודי שלה.
pageToken

string

פרמטר השאילתה pageToken משמש לבקשת הדף הבא של תוצאות השאילתה. פרמטר השאילתה pageToken של בקשת ההמשך הוא nextPageToken מהתגובה הקודמת שלך.
projection

enum (Projection)

להגביל מידע שמוחזר לקבוצה של שדות נבחרים.
query

string

מחרוזת חיפוש בפורמט שמצוין ב-https://developers.google.com/admin-sdk/directory/v1/list-query-operators
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

טיפוסים בני מנייה (enums)
ANNOTATED_LOCATION מיקום מכשיר Chrome כפי שצוין על ידי האדמין.
ANNOTATED_USER משתמש Chromebook כפי שציין מנהל המערכת.
LAST_SYNC התאריך והשעה שבהם מכשיר Chrome סונכרן לאחרונה עם הגדרות המדיניות שבמסוף Admin.
NOTES מכשיר Chrome מוסיף הערות כפי שנרשמו על ידי האדמין.
SERIAL_NUMBER המספר הסידורי של מכשיר ה-Chrome שהוזן כשהמכשיר הופעל.
STATUS הסטטוס של מכשיר ה-Chrome. למידע נוסף, ניתן לעיין ב <a chromeosdevices.

תחזית

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

טיפוסים בני מנייה (enums)
BASIC השדה הזה כולל רק את שדות המטא-נתונים הבסיסיים (למשל, deviceId, מספר סידורי, סטטוס ומשתמש).
FULL כולל את כל שדות המטא-נתונים

SortOrder

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

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