Method: users.availability.get

הפונקציה מחזירה מידע על הזמינות של משתמש אנושי ב-Google Chat. לדוגמה, אפשר להשתמש בזה כדי לבדוק אם משתמש מחובר או לא, או כדי לאחזר את הודעת הסטטוס המותאמת אישית שלו.

השיטה הזו מאחזרת רק את הזמינות של המשתמש המאומת.

נדרש אימות משתמש עם אחת מהרשאות הגישה הבאות:

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability

בקשת HTTP

GET https://chat.googleapis.com/v1/{name=users/*/availability}

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

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

פרמטרים
name

string

חובה. שם המשאב של נתוני הזמינות שרוצים לאחזר.

פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK directory API. לדוגמה, users/123456789.

אפשר להשתמש בכתובת האימייל של המשתמש או ב-me שלו גם ככתובת אימייל חלופית כדי להתייחס למתקשר. לדוגמה, users/user@example.com או users/me.

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Availability.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/chat.users.availability
  • https://www.googleapis.com/auth/chat.users.availability.readonly

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