REST Resource: spaces.members

משאב: חברות

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

ייצוג ב-JSON 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,

  // Union field memberType can be only one of the following:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
  // End of list of possible types for union field memberType.
}
שדות
name

string

מזהה. שם המשאב של המינוי, שהוקצה על ידי השרת.

פורמט: spaces/{space}/members/{member}
state

enum (MembershipState)

פלט בלבד. סטטוס החברות.
role

enum (MembershipRole)

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

אפשר להשתמש בשדה הזה כקלט רק ב-members.patch.
createTime

string (Timestamp format)

זה שינוי אופציונלי. לא ניתן לשינוי. מועד היצירה של החברות, למשל מועד ההצטרפות של חבר או מועד ההזמנה שלו למרחב משותף. השדה הזה מיועד לפלט בלבד, למעט כשמשתמשים בו כדי לייבא חברויות היסטוריות במרחבים משותפים במצב ייבוא.
deleteTime

string (Timestamp format)

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

object (User)

זה שינוי אופציונלי. המשתמש או האפליקציה ב-Google Chat שהמינוי תואם אליהם. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט מאכלס את המשתמש name ו-type.
groupMember

object (Group)

זה שינוי אופציונלי. קבוצת Google שהמינוי תואם אליה.

כדי לקרוא את החברים בקבוצות Google או לשנות את הסטטוס שלהם, צריך אימות משתמשים.

MembershipState

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

טיפוסים בני מנייה (enum)
MEMBERSHIP_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
JOINED המשתמש יתווסף למרחב המשותף ויוכל להשתתף בו.
INVITED המשתמש הוזמן להצטרף למרחב המשותף, אבל עדיין לא הצטרף אליו.
NOT_A_MEMBER המשתמש לא שייך למרחב המשותף ואין לו הזמנה בהמתנה להצטרפות למרחב המשותף.

MembershipRole

מייצג את הפעולות המותרות של משתמש במרחב משותף ב-Chat. יכול להיות שיתווספו עוד ערכים של enum בעתיד.

טיפוסים בני מנייה (enum)
MEMBERSHIP_ROLE_UNSPECIFIED ערך ברירת המחדל. עבור users: המשתמש לא חבר במרחב המשותף, אבל אפשר להזמין אותו. עבור Google Groups: תמיד מוקצה להם התפקיד הזה (יכול להיות שבעתיד נעשה שימוש בערכים אחרים של enum).
ROLE_MEMBER חברים במרחב המשותף. למשתמש יש הרשאות בסיסיות, כמו שליחת הודעות למרחב המשותף. בשיחות אישיות ובשיחות קבוצתיות ללא שם, כל המשתתפים הם 'חברים בקבוצה'.
ROLE_MANAGER מנהל/ת המרחב המשותף. למשתמש יש את כל ההרשאות הבסיסיות וגם הרשאות ניהול שמאפשרות לו לנהל את המרחב המשותף, כמו הוספה או הסרה של משתמשים. התכונה נתמכת רק ב-SpaceType.SPACE.

קבוצה

קבוצת Google ב-Google Chat.

ייצוג ב-JSON 
{
  "name": string
}
שדות
name

string

שם המשאב של קבוצת Google.

מייצג קבוצה ב-Cloud Identity Groups API.

פורמט: groups/{group}

Methods

create

 יוצרת חברות באפליקציית Chat שבה מתבצעת השיחה, במשתמש או בקבוצת Google.

delete

 מחיקה של מינוי.

get

 הפונקציה מחזירה פרטים על מינוי.

list

 הצגת רשימה של החברים במרחב המשותף.

patch

 עדכון של מינוי.