スペースを一覧表示する

このガイドでは、次の Space リソースにある list リソースを使用する方法について説明します。 スペースを一覧表示できます。スペースを一覧表示すると、ページ分けされたフィルタ可能な スペースのリストを表示します。

Space リソース ユーザーと Chat アプリがメッセージを送信し、 ファイルの共有、共同編集を行えますスペースにはいくつかのタイプがあります。

  • ダイレクト メッセージ(DM)とは、2 人のユーザーまたはユーザー間の会話で、 作成することもできます。
  • グループ チャットとは、3 人以上のユーザーと Chat 用アプリ。
  • 名前付きスペースは、メッセージの送信、ファイルの共有、 考えています

スペースのリスト表示 アプリの認証 Chat アプリがアクセスできるスペースが一覧表示されます。リスティング スペースで ユーザー認証 認証されたユーザーがアクセスできるスペースを一覧表示します。

前提条件

Python

  • Python 3.6 以降
  • pip パッケージ管理ツール
  • 最新の Google クライアント ライブラリ。インストールまたは更新する手順は次のとおりです。 コマンドライン インターフェースで次のコマンドを実行します。
    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

Node.js

  • Node.js 14 以降
  • npm パッケージ管理ツール
  • 最新の Google クライアント ライブラリ。インストールまたは更新する手順は次のとおりです。 コマンドライン インターフェースで次のコマンドを実行します。
    npm install @google-cloud/local-auth @googleapis/chat
    

ユーザー認証付きのスペースを一覧表示する

Google Chat のスペースを一覧表示するには、 request:

次の例では、名前付きスペースとグループ チャットが一覧表示されます(ダイレクト メッセージは含まれません)。 メッセージ(フィルタで除外されたもの)を表示します。

Python

  1. 作業ディレクトリに、chat_space_list.py という名前のファイルを作成します。
  2. chat_space_list.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.spaces.readonly"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then lists named spaces and group chats (but not direct messages)
        visible to the authenticated user.
        '''
    
        # 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().list(
    
              # An optional filter that returns named spaces or unnamed group chats,
              # but not direct messages (DMs).
              filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
    
          ).execute()
    
        # Prints the returned list of spaces.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 作業ディレクトリでサンプルをビルドして実行します。

    python3 chat_space_list.py
    

Node.js

  1. 作業ディレクトリに、list-spaces.js という名前のファイルを作成します。
  2. list-spaces.js に次のコードを含めます。

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * List Chat spaces.
    * @return {!Promise<!Object>}
    */
    async function listSpaces() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.readonly',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.list({
        filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
      });
    }
    
    listSpaces().then(console.log);
    
  3. 作業ディレクトリでサンプルを実行します。

    node list-spaces.js
    

Chat API は 名前付きスペースとグループ チャットのページ分けされた配列

アプリの認証を使用してスペースを一覧表示する

Google Chat のスペースを一覧表示するには、 request:

次の例では、名前付きスペースとグループ チャットが一覧表示されます(ダイレクト メッセージは含まれません)。 Chat 用アプリに表示されます。

Python

  1. 作業ディレクトリに、chat_space_list_app.py という名前のファイルを作成します。
  2. chat_space_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().list(
    
            # An optional filter that returns named spaces or unnamed
            # group chats, but not direct messages (DMs).
            filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
    
        ).execute()
    
    print(result)
    
  3. 作業ディレクトリでサンプルをビルドして実行します。

    python3 chat_space_list_app.py
    

Node.js

  1. 作業ディレクトリに、app-list-spaces.js という名前のファイルを作成します。
  2. app-list-spaces.js に次のコードを含めます。

    const chat = require('@googleapis/chat');
    
    /**
    * List Chat spaces.
    * @return {!Promise<!Object>}
    */
    async function listSpaces() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.bot',
      ];
    
      const auth = new chat.auth.GoogleAuth({
        scopes,
        keyFilename: 'credentials.json',
      });
    
      const authClient = await auth.getClient();
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.list({
        filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
      });
    }
    
    listSpaces().then(console.log);
    
  3. 作業ディレクトリでサンプルを実行します。

    node app-list-spaces.js
    

Chat API は、スペースのページ分けされた配列を返します。

ページ設定をカスタマイズする、またはリストをフィルタリングする

Google Chat のスペースを一覧表示するには、次のオプションの 次のクエリ パラメータを使用すると、リストされたスペースのページ分けをカスタマイズしたり、リストされたスペースをフィルタしたりできます。

  • pageSize: 返されるスペースの最大数。サービスは、 この値より小さくなります指定しない場合、最大で 100 個のスペースが返されます。「 最大値は 1,000 です。1,000 を超える値は自動的に 1,000。
  • pageToken: 前の list スペース呼び出しから受け取ったページトークン。 後続のページを取得するには、このトークンを指定します。ページネーションを行う際、 フィルタ値は、ページトークンを提供した呼び出しと一致する必要があります。引数を渡すことで、 値が異なると、予期しない結果になる可能性があります。
  • filter: クエリフィルタ。サポートされているクエリの詳細については、 spaces.list メソッド