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 Chat.

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

string

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

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

פורמט: groups/{group}

שיטות

create

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

delete

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

get

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

list

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

patch

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