このガイドでは、Google Chat API の Membership
リソースの get()
メソッドを使用して、スペースのメンバーシップの詳細を取得する方法について説明します。
Google Workspace 管理者は、get()
メソッドを呼び出して、Google Workspace 組織内のメンバーシップの詳細を取得できます。
Membership
リソースは、人間のユーザーまたは Google Chat アプリがスペースに招待されているか、スペースに参加しているか、スペースに含まれていないかを表します。
アプリ認証で認証すると、Chat アプリは Google Chat でアクセスできるスペース(メンバーであるスペースなど)からメンバーシップを取得できますが、Chat アプリのメンバーシップ(自身のメンバーシップを含む)は除外されます。ユーザー認証による認証では、認証されたユーザーがアクセスできるスペースのメンバーシップが返されます。
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
- 認証済みユーザーまたは呼び出し元の Chat アプリがメンバーである Google Chat スペース。Chat アプリとして認証するには、Chat アプリをスペースに追加します。
Python
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Python の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストでの認証方法に基づいてアクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
- 認証されたユーザーまたは呼び出し元の Chat アプリがメンバーである Google Chat スペース。Chat アプリとして認証するには、Chat アプリをスペースに追加します。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Java Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、その認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、その認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
- 認証済みユーザーまたは呼び出し元の Chat アプリがメンバーである Google Chat スペース。Chat アプリとして認証するには、Chat アプリをスペースに追加します。
Apps Script
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- スタンドアロンの Apps Script プロジェクトを作成し、Advanced Chat Service をオンにします。
- このガイドでは、ユーザー認証またはアプリ認証のいずれかを使用する必要があります。Chat アプリとして認証するには、サービス アカウントの認証情報を作成します。手順については、Google Chat アプリとして認証と認可を行うをご覧ください。
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
- 認証済みユーザーまたは呼び出し元の Chat アプリがメンバーである Google Chat スペース。Chat アプリとして認証するには、Chat アプリをスペースに追加します。
メンバーシップの詳細を取得する
Google Chat のメンバーシップの詳細を取得するには、リクエストで次の情報を渡します。
- アプリ認証では、
chat.bot
認証スコープを指定します。ユーザー認証では、chat.memberships.readonly
またはchat.memberships
の認可スコープを指定します。ベスト プラクティスとして、アプリが機能する範囲で最も制限の厳しいスコープを選択します。 GetMembership()
メソッドを呼び出します。- 取得するメンバーシップの
name
を渡します。Google Chat のメンバーシップ リソースからメンバーシップ名を取得します。
ユーザー認証でメンバーシップを取得する
ユーザー認証でメンバーシップを取得する方法は次のとおりです。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MEMBER_NAME
: メンバーのname
の ID。ID を取得するには、ListMemberships()
メソッドを呼び出します。
Chat API は、指定されたメンバーシップの詳細を示す Membership
のインスタンスを返します。
アプリ認証でメンバーシップを取得する
アプリの認証を使用してメンバーシップを取得する方法は次のとおりです。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID を取得するには、ListSpaces()
メソッドを呼び出すか、スペースの URL を使用します。MEMBER_NAME
: メンバーのname
の ID。ID を取得するには、ListMemberships()
メソッドを呼び出します。
Chat API は、指定されたメンバーシップに関する詳細を示す Membership
のインスタンスを返します。
Google Workspace 管理者としてメンバーシップの詳細を取得する
Google Workspace 管理者は、GetMembership()
メソッドを呼び出して、Google Workspace 組織内の任意のユーザーのメンバーシップの詳細を取得できます。
Google Workspace 管理者としてこのメソッドを呼び出す手順は次のとおりです。
- ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドの呼び出しをサポートする認可スコープを指定します。
- リクエストで、クエリ パラメータ
useAdminAccess
をtrue
に指定します。
詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。
関連トピック
- スペースのメンバーを一覧表示する。
- ユーザーや Chat アプリをスペースに招待または追加する。
- Google Chat スペースでユーザーのメンバーシップを更新する。
- スペースからユーザーまたは Chat 用アプリを削除する。