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

更新成員資格。