REST Resource: users.availability

משאב: זמינות

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

ייצוג JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
שדות
name

string

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

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

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

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

enum (State)

פלט בלבד. סטטוס הזמינות הנוכחי של המשתמש.
customStatus

object (CustomStatus)

אופציונלי. הסטטוס המותאם אישית של המשתמש.
מטא-נתונים נוספים שמשויכים לסטטוס הזמינות של המשתמש. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

פלט בלבד. מטא-נתונים אם סטטוס המשתמש מוגדר ל'לא להפריע'.
סוף השדות הבלעדיים.

מדינה (State)

מייצג את מצב הזמינות הנוכחי של המשתמש.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. המצב לא צוין.
ACTIVE המשתמש פעיל כרגע, על סמך הפעילות האחרונה שלו.
IDLE המשתמש לא פעיל כרגע. הסטטוס הזה מציין תקופה של חוסר פעילות אחרי שהסטטוס היה ACTIVE, לפני שהסטטוס משתנה ל-AWAY.
AWAY המשתמש לא נמצא כרגע. אפשר להגדיר את זה אוטומטית אחרי תקופה של חוסר פעילות במצב ACTIVE או IDLE, או שהמשתמש יכול להגדיר את זה ידנית. כשמגדירים את המצב הזה באופן ידני באמצעות availability.markAsAway, הוא נשמר ללא קשר לפעילות המשתמש.
DO_NOT_DISTURB המשתמש במצב 'נא לא להפריע', שהוגדר באופן ידני.

DoNotDisturbMetadata

מטא-נתונים שמשויכים לDO_NOT_DISTURB מצב הזמינות, שמציינים מתי תוקף המצב יפוג.

ייצוג JSON 
{
  "expirationTime": string
}
שדות
expirationTime

string (Timestamp format)

פלט בלבד. חותמת זמן של התקופה שבה המשתמש צריך להיות מסומן כ'לא להפריע'. התאריך יכול להיות עד שנה אחת בעתיד.

CustomStatus

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

ייצוג JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
שדות
text

string

חובה. הטקסט של הסטטוס בהתאמה אישית. הערך הזה יהיה מחרוזת באורך של עד 64 תווים.
emoji

object (Emoji)

חובה. האמוג'י של הסטטוס בהתאמה אישית. יש תמיכה רק באמוג'י Unicode, ולא באמוג'י בהתאמה אישית.
תאריך התפוגה של הסטטוס בהתאמה אישית. אפשר לציין את התאריך והשעה המדויקים או את משך הזמן עד שהתוקף יפוג. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
expireTime

string (Timestamp format)

חותמת הזמן שבה הסטטוס בהתאמה אישית יפוג.
ttl

string (Duration format)

קלט בלבד. משך הזמן עד שהסטטוס בהתאמה אישית יפוג.
סוף השדות הבלעדיים.

Methods

get

 הפונקציה מחזירה מידע על הזמינות של משתמש אנושי ב-Google Chat.

markAsActive

 מסמן את המשתמש כACTIVE ב-Google Chat.

markAsAway

 מסמן את המשתמש כAWAY ב-Google Chat.

markAsDoNotDisturb

 מסמן את המשתמש כDO_NOT_DISTURB ב-Google Chat.

patch

 עדכון של פרטי הזמינות של משתמש אנושי.