REST Resource: spaces.members

リソース: Membership

ユーザーまたは Chat 用アプリがスペースに招待されているか、スペースに参加しているか、スペースから退出しているかなど、Google Chat のメンバーシップ関係を表します。

JSON 表現 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
フィールド
name

string

ID。サーバーによって割り当てられたメンバーシップのリソース名。

形式: spaces/{space}/members/{member}
state

enum (MembershipState)

出力専用。メンバーシップの状態。
role

enum (MembershipRole)

省略可。Chat スペース内のユーザーのロール。スペースで許可されるアクションを決定します。

このフィールドは、members.patch の入力としてのみ使用できます。
createTime

string (Timestamp format)

省略可。変更不可。メンバーシップの作成時間（メンバーがスペースに参加したときや、スペースへの参加を招待されたときなど）。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。
deleteTime

string (Timestamp format)

省略可。変更不可。メンバーシップの削除時間（メンバーがスペースから退出したときや削除されたときなど）。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。
affiliation

enum (Affiliation)

出力専用。スペースを所有する Workspace 組織に対するユーザーの関係。一般ユーザー アカウントが所有するスペースでは、すべてのメンバーの所属が EXTERNAL になります。
このメンバーシップに関連付けられているメンバー。今後、他のメンバー タイプがサポートされる可能性があります。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
member

object (User)

省略可。メンバーシップに対応する Google Chat ユーザーまたはアプリ。Chat 用アプリがユーザーとして認証されると、出力には user の name と type が入力されます。
groupMember

object (Group)

省略可。メンバーシップが対応する Google グループ。

Google グループのメンバーシップの読み取りまたは変更には、ユーザー認証が必要です。
相互に排他的なフィールドの終了。

MembershipState

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

列挙型
MEMBERSHIP_STATE_UNSPECIFIED デフォルト値。使用しないでください。
JOINED ユーザーがスペースに追加され、スペースに参加できるようになります。
INVITED ユーザーはスペースへの参加を招待されていますが、まだ参加していません。
NOT_A_MEMBER ユーザーがスペースに属しておらず、スペースに参加するための招待が保留されていない。

MembershipRole

Chat スペースでユーザーが許可されているアクションを表します。今後、列挙値が追加される可能性があります。

列挙型
MEMBERSHIP_ROLE_UNSPECIFIED デフォルト値。users の場合: スペースのメンバーではないが、招待できる。Google Groups の場合: 常にこのロールが割り当てられます（他の列挙値が今後使用される可能性があります）。
ROLE_MEMBER

スペースのメンバー。チャット UI では、このロールはメンバーと呼ばれます。

ユーザーは、スペースにメッセージを送信するなどの基本的な権限を持っています。管理者とオーナーは、スペースでメンバーに次の追加権限を付与できます。

  • メンバーを追加または削除します。
  • スペースの詳細を変更します。
  • 履歴をオンまたはオフにします。
  • @all を使用して、スペースのメンバー全員にメンションします。
  • スペースにインストールされている Chat 用アプリと Webhook を管理します。

ダイレクト メッセージと名前のないグループ会話では、全員にこの役割が割り当てられます。
ROLE_MANAGER

スペースのオーナー。チャット UI では、このロールはオーナーと呼ばれます。

ユーザーは、スペースを管理するためのスペース権限をすべて持っています。これには、次の権限が含まれます。

  • スペース内の他のメンバーのロールをメンバー、マネージャー、オーナーに変更する。
  • スペースを削除します。

SpaceType.SPACE（名前付きスペース）でのみサポートされています。

詳しくは、スペースのオーナーまたは管理者の役割についてをご覧ください。
ROLE_ASSISTANT_MANAGER

スペースの管理者。Chat UI では、このロールは「管理者」と呼ばれます。

ユーザーは ROLE_MEMBER のすべての基本権限を持ち、オーナーによって管理者権限のサブセットが付与されることがあります。デフォルトでは、マネージャーにはオーナーと同じ権限がありますが、以下の操作は行えません。

  • スペースを削除します。
  • 他のスペース メンバーをオーナーにする。
  • オーナーのロールを変更する。

デフォルトでは、管理者の権限には以下が含まれます（これらに限定されません）。

  • 他のメンバーをマネージャーにする。
  • スペースでメッセージを削除する。
  • スペースの権限を管理する。
  • スペースの設定で管理者が「メンバーを管理」権限を持っている場合、スペースへの参加リクエストの通知を受け取ります。
  • スペースを検索可能にします。

SpaceType.SPACE（名前付きスペース）でのみサポートされています。

詳しくは、スペースの設定を管理するをご覧ください。

グループ

Google Chat の Google グループ。

JSON 表現 
{
  "name": string
}
フィールド
name

string

Google グループのリソース名。

Cloud Identity Groups API のグループを表します。

形式: groups/{group}

所属

スペースを所有する Google Workspace 組織に対するユーザーの所属を表します。この列挙型には、今後さらに値が追加される可能性があります。

列挙型
AFFILIATION_UNSPECIFIED デフォルト値。この値は使用されません。
INTERNAL スペースを所有する Google Workspace 組織と同じ組織によって管理されているアカウント。
EXTERNAL スペースを所有する Google Workspace 組織の外部のアカウント（一般ユーザー向けアカウント、別の Workspace 組織が管理するアカウントなど）。
MANAGED_EXTERNAL スペースを所有する Workspace 組織によって管理されるアカウント。ただし、組織外のユーザー（ゲストユーザーなど）にプロビジョニングされます。ゲストについて詳しくは、https://support.google.com/chat/answer/16997417 をご覧ください。

メソッド

create

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

delete

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

get

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

list

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

patch

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