Method: mobiledevices.list

אחזור רשימה מחולקת לדפים של כל המכשירים הניידים שבבעלות המשתמש בחשבון. כדי לאחזר רשימה שכוללת מכשירים בבעלות החברה, צריך להשתמש ב-Devices API של Cloud Identity. הזמן הקצוב לתפוגה של השיטה הזו הוא 60 דקות. מידע נוסף זמין במאמר פתרון בעיות שקשורות לקודי שגיאה.

בקשת HTTP

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

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

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

פרמטרים
customerId

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. כאדמינים של החשבון, אתם יכולים גם להשתמש בכתובת החלופית my_customer כדי לייצג את customerId של החשבון. הערך customerId מוחזר גם כחלק ממשאב המשתמשים.

פרמטרים של שאילתה

פרמטרים
maxResults

integer

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

enum (OrderBy)

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

string

אסימון לציון הדף הבא ברשימה
projection

enum (Projection)

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

string

מחרוזת חיפוש בפורמט שמופיע בכתובת https://developers.google.com/workspace/admin/directory/v1/search-operators
sortOrder

enum (SortOrder)

האם להציג את התוצאות בסדר עולה או יורד. חובה להשתמש בו עם הפרמטר orderBy.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "kind": string,
  "etag": string,
  "mobiledevices": [
    {
      object (MobileDevice)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

סוג המשאב.
etag

string

ה-ETag של המשאב.
mobiledevices[]

object (MobileDevice)

רשימה של אובייקטים מסוג Mobile Device.
nextPageToken

string

אסימון המשמש לגישה לדף הבא של התוצאה הזו.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין במדריך ההרשאות.

OrderBy

טיפוסים בני מנייה (enum)
DEVICE_ID המספר הסידורי של מכשיר נייד עם Google Sync. במכשירי Android, זהו מזהה ייחודי שנוצר על ידי תוכנה.
EMAIL כתובת האימייל של הבעלים של המכשיר.
LAST_SYNC תאריך ושעת הסנכרון האחרון של הגדרות המדיניות במכשיר.
MODEL הדגם של המכשיר הנייד.
NAME שם המשתמש של הבעלים של המכשיר.
OS מערכת ההפעלה של המכשיר.
STATUS סטטוס המכשיר.
TYPE סוג המכשיר.

היטל

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

SortOrder

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