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 שאליה מתייחסת החברות.

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

 יוצרים מינוי אנושי או מינוי לאפליקציה לשיחות.

delete

 מוחק מינוי.

get

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

list

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

patch

 עדכון המינוי.