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

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

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

MembershipRole

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

טיפוסים בני מנייה (enums)
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.

פורמט: קבוצות/{group}

שיטות

create

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

delete

מחיקת המינוי.

get

הצגת פרטים על המינוי.

list

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

patch

מעדכנים את המינוי.