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 應用程式是以使用者身分進行驗證,輸出內容會填入「使用者」nametype

groupMember

object (Group)

成員對應的 Google 網路論壇。僅支援讀取作業。我們目前不支援其他作業,例如建立或更新會籍。

MembershipState

指定成員與聊天室的關係。我們日後可能會支援其他會員狀態。

列舉
MEMBERSHIP_STATE_UNSPECIFIED 預設值。請勿使用。
JOINED 使用者將加入聊天室,也可以加入聊天室。
INVITED 使用者已收到加入聊天室的邀請,但尚未加入。
NOT_A_MEMBER 使用者不是聊天室的成員,而且也沒有待處理的加入聊天室邀請。

MembershipRole

代表使用者在 Chat 聊天室中允許的操作。日後可能會新增更多列舉值。

列舉
MEMBERSHIP_ROLE_UNSPECIFIED 預設值。users:你不是聊天室成員,但可以收到邀請。針對 Google Groups:他們一律會獲派這個角色 (日後可使用的其他列舉值)。
ROLE_MEMBER 聊天室成員。使用者擁有基本權限,例如傳送訊息到聊天室。在 1:1 和未命名的群組對話中,所有人都具備這個角色。
ROLE_MANAGER 聊天室管理員。使用者俱備所有基本權限,以及可管理聊天室的管理員權限,例如新增或移除成員。只有在 SpaceType.SPACE 中才能使用。

群組

Google Chat 中的 Google 群組。

JSON 表示法
{
  "name": string
}
欄位
name

string

Google 群組的資源名稱。

代表 Cloud Identity Groups API 中的群組

格式:groups/{group}

方法

create

為呼叫應用程式建立使用者成員資格或應用程式成員資格。

delete

刪除會員資格。

get

傳回會員相關詳細資料。

list

列出聊天室中的成員。

patch

更新會員資格。