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 アプリがユーザーとして認証されると、出力にユーザー 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 スペースのメンバー。ユーザーには、スペースへのメッセージの送信などの基本的な権限が付与されます。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

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