REST Resource: spaces.members

リソース: Membership

ユーザーまたは Chat アプリがスペースに招待されているか、スペースの一部であるか、参加していないかなど、Google 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

メンバーとスペースの関係を指定します。他のメンバーシップの状態は、今後サポートされる可能性があります。

列挙型
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

 呼び出し元の Chat アプリ、ユーザー、または Google グループのメンバーシップを作成します。

delete

 メンバーシップを削除します。

get

 メンバーシップに関する詳細を返します。

list

 スペースのメンバーを一覧表示します。

patch

 メンバーシップを更新します。