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 アプリがユーザーとして認証されると、出力にはユーザー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}

Methods

create

呼び出し元のアプリに人間のメンバーシップまたはアプリ メンバーシップを作成します。

delete

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

get

メンバーシップの詳細を返します。

list

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

patch

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