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

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

名前付きスペース（spaceType が SPACE の場合）は、ユーザーがメッセージを送信したり、ファイルを共有したり、共同作業を行ったりする場所です。名前付きスペースには Chat 用アプリを含めることができます。名前付きスペースには、管理設定や説明の適用、ユーザーやアプリの追加と削除を行うことができるスペースの管理者がいます。

さまざまなタイプの Chat スペース（ダイレクト メッセージやグループ メッセージなど）を作成するには、Space リソースの setUp() メソッドを使用して、スペースを作成し、同時にメンバーを追加します。詳しくは、スペースを設定するをご覧ください。

名前付きスペースを作成すると、そのスペースの唯一のメンバーは認証済みユーザーになります。スペースにメンバーを追加するには、追加するユーザーまたはアプリごとに Membership リソースの create() メソッドを呼び出します。または、setUp() メソッドを使用して、名前付きスペースを作成し、同時にメンバーを追加することもできます。

前提条件

Node.js

Python

Java

Apps Script

ユーザーとして名前付きスペースを作成する

ユーザー認証を使用して名前付きスペースを作成するには、リクエストで次の値を渡します。

  • chat.spaces.create または chat.spaces 認証スコープを指定します。
  • 次のフィールドを持つ Space のインスタンスとして space を渡して、CreateSpace() メソッドを呼び出します。
    • spaceTypeを SPACEに設定しました。
    • displayName は、ユーザーに表示されるスペースの名前に設定されます。
    • 必要に応じて、次のような他の属性を設定します。
      • spaceDetails - スペースのユーザーに表示される説明とガイドラインのセット。
      • predefinedPermissionSettings - スペースの事前定義された権限。たとえば、すべてのメンバーまたはスペース管理者のみがメッセージを投稿できるように構成できます。

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

Node.js

chat/client-libraries/cloud/create-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.create'];

// This sample shows how to create a named space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    }
  };

  // Make the request
  const response = await chatClient.createSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/create_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"]

def create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

    # Make the request
    response = client.create_space(request)

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.create";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

  // Handle the response
  console.log(response);
}

Chat 用アプリとして名前付きスペースを作成する

アプリの認証には、1 回限りの管理者による承認が必要です。

アプリ認証を使用してユーザーをスペースに招待または追加するには、リクエストで次の情報を渡します。

  • chat.app.spaces.create または chat.app.spaces 認証スコープを指定します。
  • Space リソースで create メソッドを呼び出します。
  • spaceType を SPACE に設定します。
  • displayName をスペースのユーザーに表示される名前に設定します。次の例では、displayName は API-made に設定されています。
  • customer フィールドを使用して、Google Workspace ドメインの顧客 ID を指定します。
  • 必要に応じて、spaceDetails（ユーザーに表示される説明とスペースのガイドラインのセット）など、他のスペース属性を設定します。

API キーを作成する

デベロッパー プレビュー API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー バージョンを使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

  1. Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。

    [認証情報] に移動

  2. [認証情報を作成] > [API キー] をクリックします。
  3. 新しい API キーが表示されます。
    • [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
    • [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳しくは、API キーの制限を適用するをご覧ください。

Chat API を呼び出すスクリプトを作成する

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

Python

  1. 作業ディレクトリに chat_space_create_named_app.py という名前のファイルを作成します。

  2. chat_space_create_named_app.py に次のコードを含めます。

    from google.oauth2 import service_account
from apiclient.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.app.spaces.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

  3. コードで、次のように置き換えます。

    • API_KEY: Chat API のサービス エンドポイントを構築するために作成した API キー。

    • CUSTOMER: スペースのドメインの顧客 ID（customer/{customer} 形式）。ここで、{customer} は Admin SDK の顧客リソースの ID です。Chat 用アプリと同じ Google Workspace 組織にスペースを作成するには、customers/my_customer を使用します。

  4. 作業ディレクトリで、サンプルをビルドして実行します。

    python3 chat_space_create_named_app.py

Google Chat でスペースを開く

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

制限事項と考慮事項

  • アプリ認証を使用してスペースを作成すると、認証を行う Chat 用アプリがスペースのメンバーとして追加されますが、ユーザー認証とは異なり、スペース管理者としては追加されません。デフォルトでは、すべてのスペース メンバーが Chat 用アプリを削除できます。スペース管理者のみが Chat 用アプリを削除できるようにするには、permissionSettings.manageApps を managersAllowed に設定します。