このガイドでは、membership
リソースで list
メソッドを使用する方法について説明します
スペース内のメンバーをページ分けされたフィルタ可能なリストとして一覧表示する Google Chat API
1 スペースでメンバー全員が管理できます。メンバーシップの一覧表示
アプリの認証
Chat 用アプリに登録されているスペースのメンバーが
ただし、以下を含む Chat アプリのメンバーシップは除外されます。
あります。メンバーシップの一覧表示
ユーザー認証
認証されたユーザーがアクセスできるスペースのメンバーを一覧表示します。
「
Membership
リソース
人間のユーザーまたは Google Chat アプリのどちらが招待されているかを表します。
その場から離れることがなくなります。
前提条件
Python
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 環境を設定します。
<ph type="x-smartling-placeholder">
- </ph>
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- Python Google API クライアント ライブラリ。
- Google Chat API での認証方法に基づいてアクセス認証情報を作成する
request:
<ph type="x-smartling-placeholder">
- </ph>
- Chat ユーザーとして認証するには、
OAuth クライアント ID を作成する
認証情報を JSON ファイルとして保存し、
client_secrets.json
をローカル ディレクトリに移動します。 - Chat 用アプリとして認証するには、
サービス アカウントの作成
認証情報を JSON ファイルとして保存し、
credentials.json
。
- Chat ユーザーとして認証するには、
OAuth クライアント ID を作成する
認証情報を JSON ファイルとして保存し、
- <ph type="x-smartling-placeholder"></ph> ユーザーとして認証するか、ユーザーとして認証するかに基づいて、承認スコープを選択します。 Chat アプリ。
ユーザー認証を使用してスペースのメンバーを一覧表示する
スペースでユーザー、Google グループ、Chat アプリを一覧表示する 使用する場合は、リクエストで次の要素を渡します。
- あり
ユーザー認証、
chat.memberships.readonly
またはchat.memberships
承認を指定する あります。 - 呼び出し
list
メソッド 日付membership
リソース。 - Google グループを一覧表示するには、クエリ パラメータ
showGroups
をtrue
に設定します。
次の例では、ユーザーに表示される Google グループ、ユーザー、アプリのメンバーを 表示されます。
Python
- 作業ディレクトリに、
chat_member_list_user.py
という名前のファイルを作成します。 chat_member_list_user.py
に次のコードを含めます。from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists Google Group, human, and app members in a specified space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # Set this parameter to list Google Groups. showGroups = 'true' ).execute() # Prints the list of memberships. print(result) if __name__ == '__main__': main()
コードで
SPACE
をスペース名に置き換えます。スペースには こちらのspaces.list
メソッド スペースの URL から取得できます。作業ディレクトリでサンプルをビルドして実行します。
python3 chat_member_list_user.py
Google Chat API は、Google グループ、ユーザー、アプリのメンバーのリストを 割り当てることができます。
アプリの認証を使用してスペースのメンバーを一覧表示する
スペース内のユーザーと Chat アプリを一覧表示するには 渡すには、リクエストで次の内容を渡します。
- あり
アプリの認証、
chat.bot
承認スコープを指定します。 - 呼び出し
list
メソッド 日付member
リソース。 - Google グループを一覧表示するには、クエリ パラメータ
showGroups
をtrue
に設定します。
次の例では、スペースの管理者ではなく、人間のスペースのメンバーのうち、 次の操作を行います。
Python
- 作業ディレクトリに、
chat_member_list_app.py
という名前のファイルを作成します。 chat_member_list_app.py
に次のコードを含めます。from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # An optional filter that returns only human space members. filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"' ).execute() print(result)
コードで
SPACE
をスペース名に置き換えます。スペースには こちらのspaces.list
メソッド スペースの URL から取得できます。作業ディレクトリでサンプルをビルドして実行します。
python3 chat_member_list_app.py
Google Chat API が、人間のスペースのメンバー(スペースを除く)のリストを 管理者など)の権限を取り消す権限を有します。
ページ設定をカスタマイズする、またはリストをフィルタリングする
メンバーシップを一覧表示するには、次のクエリ パラメータを リストされたメンバーシップのページ設定のカスタマイズ、またはフィルタを行います。
pageSize
: 返されるメンバーシップの最大数。サービスは、 この値より小さい値が返されます指定しない場合、入力可能なスペースは 100 個までです。 返されます。最大値は 1,000 です。1,000 を超える値は自動的に 1,000 に変更されました。pageToken
: 前の list スペース呼び出しから受け取ったページトークン。 後続のページを取得するには、このトークンを指定します。ページネーションを行う際、 フィルタ値は、ページトークンを提供した呼び出しと一致する必要があります。Pod に 異なる値を使用すると、予期しない結果になる可能性があります。filter
: クエリフィルタ。要件 ユーザー認証。 サポートされているクエリの詳細については、spaces.members.list
メソッド。
関連トピック
- ユーザーまたは Chat アプリのメンバーシップに関する詳細情報を取得する。
- ユーザーまたは Chat アプリをスペースに招待または追加する。
- Google Chat スペースでユーザーのメンバーシップを更新する。
- スペースからユーザーまたは Chat アプリを削除する。