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

משתתף במרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא 'חבר/ה'.

למשתמש יש הרשאות בסיסיות, כמו שליחת הודעות במרחב. מנהלים ובעלים יכולים להעניק למשתתפים הרשאות נוספות במרחב, כולל:

  • מוסיפים או מסירים חברים.
  • לשנות את הפרטים של המרחב.
  • להפעיל או להשבית את ההיסטוריה.
  • לתייג את כולם במרחב באמצעות @all.
  • ניהול אפליקציות ו-webhook ב-Chat שהותקנו במרחב.

בצ'אטים ישירים ובשיחות קבוצתיות ללא שם, לכולם יש את התפקיד הזה.
ROLE_MANAGER

הבעלים של המרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא 'בעלים'.

למשתמש יש את כל ההרשאות במרחב לניהול המרחב, כולל:

  • לשנות את התפקיד של משתתפים אחרים במרחב למשתתף, מנהל או בעלים.
  • למחוק את המרחב.

התכונה נתמכת רק ב-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

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