スペースを作成する

このガイドでは、Google Chat API の Space リソースの create メソッドを使用して名前付きスペースを作成する方法について説明します。

Space リソースは、ユーザーと Chat アプリがメッセージの送信、ファイル共有、コラボレーションを行う場所を表します。スペースには次の種類があります。

  • ダイレクト メッセージ(DM)は、2 人のユーザー間の会話、またはユーザーと Chat アプリ間の会話です。
  • グループ チャットとは、3 人以上のユーザーと Chat アプリの間で交わされる会話のことです。
  • 名前付きスペースは、メッセージの送信、ファイルの共有、共同編集を行う永続的な場所です。

名前付きスペースとは、ユーザーがメッセージの送信、ファイルの共有、共同編集を行う場所です。名前付きスペースには Chat アプリを含めることができます。名前付きスペースには、管理設定や説明の適用、ユーザーやアプリの追加と削除を行えるスペース管理者など、名前のないグループ会話やダイレクト メッセージにはない追加機能が含まれます。名前付きスペースを作成すると、そのスペースのメンバーは認証済みユーザーのみです。スペースには、他のユーザーやアプリは含まれません。スペースを作成する Chat アプリも含まれません。ユーザーを追加するには、Member リソースに対して create メソッドを呼び出して、スペースにメンバーシップを作成します。方法については、メンバーシップを作成するをご覧ください。

複数のメンバーを含む名前付きスペースを作成するには(3 人以上のユーザーによる名前のないグループ チャット、2 人間のダイレクト メッセージの会話、ユーザーと Chat API を呼び出す Chat アプリによる会話)はスペースを設定します。

前提条件

Python

  • Python 3.6 以降
  • pip パッケージ管理ツール
  • Python 用の最新の Google クライアント ライブラリ。これらをインストールまたは更新するには、コマンドライン インターフェースで次のコマンドを実行します。

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • Google Chat API が有効で構成された Google Cloud プロジェクト。手順については、Google Chat アプリを作成するをご覧ください。
  • Chat アプリ用に認可が構成されています。スペースを作成するには、承認スコープが chat.spaces.create または chat.spacesユーザー認証が必要です。

Node.js

  • Node.js と npm
  • Node.js 用の最新の Google クライアント ライブラリ。これらをインストールするには、コマンドライン インターフェースで次のコマンドを実行します。

    npm install @google-cloud/local-auth @googleapis/chat
    
  • Google Chat API が有効で構成された Google Cloud プロジェクト。手順については、Google Chat アプリを作成するをご覧ください。
  • Chat アプリ用に認可が構成されています。スペースを作成するには、承認スコープが chat.spaces.create または chat.spacesユーザー認証が必要です。

名前付きスペースを作成する

名前付きスペースを作成するには、リクエストに以下を渡します。

  • chat.spaces.create または chat.spaces 承認スコープを指定します。
  • Space リソースcreate メソッドを呼び出します。
  • spaceTypeSPACE に設定します。
  • displayName を、ユーザーに表示されるスペースの名前に設定します。次の例では、displayNameAPI-made に設定されています。
  • 必要に応じて、spaceDetails(ユーザーに表示されるスペースの説明とガイドラインのセット)などのスペース属性を設定します。

名前付きスペースを作成する方法は次のとおりです。

Python

  1. 作業ディレクトリに、chat_space_create_named.py という名前のファイルを作成します。
  2. chat_space_create_named.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.create"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then creates a Chat 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().create(
    
          # Details about the space to create.
          body = {
    
            # To create a named space, set spaceType to SPACE.
            'spaceType': 'SPACE',
    
            # The user-visible name of the space.
            'displayName': 'API-made'
          }
    
          ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 作業ディレクトリで、サンプルをビルドして実行します。

    python3 chat_space_create_named.py
    

Node.js

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

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Creates a new chat space.
    * @return {!Promise<!Object>}
    */
    async function createSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.create',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.create(
          {requestBody: {spaceType: 'SPACE', displayName: 'API-made'}});
    }
    
    createSpace().then(console.log);
    
  3. 作業ディレクトリでサンプルを実行します。

    node create-space.js
    

名前付きスペースが作成されます。スペースに移動するには、スペースのリソース ID を使用してスペースの URL を作成します。リソース ID は、Google Chat のレスポンス本文のスペース name で確認できます。たとえば、スペースの namespaces/1234567 の場合、https://mail.google.com/chat/u/0/#chat/space/1234567 という URL を使用してスペースに移動できます。