REST Resource: spaces.members

資源：Membership

代表 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

ID。伺服器指派的會員資源名稱。

格式：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 應用程式以使用者身分進行驗證，輸出內容會填入 user name 和 type。
groupMember

object (Group)

(選用步驟) 成員資格對應的 Google 群組。

如要讀取或變更 Google 群組的成員資格，必須驗證使用者身分。

MembershipState

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

列舉
MEMBERSHIP_STATE_UNSPECIFIED 預設值。請勿使用。
JOINED 使用者會加入聊天室，並可參與聊天室活動。
INVITED 使用者已受邀加入聊天室，但尚未加入。
NOT_A_MEMBER 使用者不屬於該聊天室，且沒有待處理的聊天室加入邀請。

MembershipRole

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

列舉
MEMBERSHIP_ROLE_UNSPECIFIED 預設值。users：對方不是聊天室成員，但可以邀請。對於 Google Groups，系統一律會指派這個角色 (日後可能會使用其他列舉值)。
ROLE_MEMBER

聊天室成員。在 Chat 使用者介面中，這個角色稱為「成員」。

使用者具備基本權限，例如傳送訊息至討論空間。管理員和擁有者可以在聊天室中授予成員額外權限，包括：

  • 新增或移除成員。
  • 修改聊天室詳細資料。
  • 開啟或關閉記錄功能。
  • 使用 @all 提及聊天室中的所有人。
  • 管理聊天室中安裝的 Chat 應用程式和 Webhook。

在即時訊息和未命名的群組對話中，所有人都具備這個角色。
ROLE_MANAGER

聊天室擁有者。在即時通訊使用者介面中，這個角色稱為「擁有者」。

使用者擁有聊天室的完整權限，可管理聊天室，包括：

  • 將其他聊天室成員的角色變更為成員、管理員或擁有者。
  • 刪除聊天室。

僅支援 SpaceType.SPACE (已命名的聊天室)。

詳情請參閱「進一步瞭解聊天室擁有者或管理員角色」。
ROLE_ASSISTANT_MANAGER

聊天室管理員。在即時通訊使用者介面中，這個角色稱為「管理員」。

使用者具備 ROLE_MEMBER 的所有基本權限，且擁有者可授予部分管理權限。根據預設，管理員具備的權限和擁有者大致相同，差別只在於管理員無法：

  • 刪除聊天室。
  • 將其他聊天室成員設為擁有者。
  • 變更擁有者的角色。

管理員權限預設包括但不限於：

  • 將其他成員設為管理員。
  • 刪除聊天室中的訊息。
  • 管理聊天室權限。
  • 如果管理員在聊天室設定中具備「管理成員」權限，就會收到加入聊天室的要求通知。
  • 將聊天室設為可自由加入。

僅支援 SpaceType.SPACE (已命名的聊天室)。

詳情請參閱「管理聊天室設定」。

群組

Google Chat 中的 Google 群組。

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

string

Google 群組的資源名稱。

代表 Cloud Identity Groups API 中的群組。

格式：groups/{group}

方法

create

 為通話 Chat 應用程式、使用者或 Google 群組建立成員資格。

delete

 刪除會員資格。

get

 傳回會員方案的詳細資料。

list

 列出聊天室中的成員。

patch

 更新會員方案。