初期メンバーが含まれるスペースを設定する

このガイドでは、Google Chat API の Space リソースで setUp() メソッドを使用して、Google Chat スペースを設定する方法について説明します。スペースを設定すると、スペースが作成され、指定したユーザーが追加されます。

Space リソースは、ユーザーや Chat アプリがメッセージを送信したり、ファイルを共有したり、コラボレーションしたりできる場所を表します。スペースにはいくつかのタイプがあります。

  • ダイレクト メッセージ（DM）は、2 人のユーザー、またはユーザーと Chat アプリ間の会話です。
  • グループ チャットは、3 人以上のユーザーと Chat アプリとの間の会話です。
  • 名前付きスペースは、ユーザーがメッセージの送信、ファイルの共有、コラボレーションを行うための永続的な場所です。

スペースを設定する際は、次の点を考慮してください。

  • 呼び出し元（認証済み）ユーザーは自動的にスペースに追加されるため、リクエストでユーザーのメンバーシップを指定する必要はありません。
  • ダイレクト メッセージ（DM）を作成するときに、2 人のユーザー間に DM が存在する場合、その DM が返されます。それ以外の場合は、DM が作成されます。
  • グループ チャットを作成するときに、リクエストで指定されたメンバーシップがいずれもグループ チャットに正常に追加されなかった場合（権限の問題など）、空のグループ チャット（呼び出し元のユーザーのみを含む）が作成されることがあります。
  • スレッド返信を使用したスペースの設定や、Google Workspace の外部にいるユーザーの追加はできません。
  • リクエストで指定された重複するメンバーシップ（呼び出し元のユーザーを含む）は除外され、リクエスト エラーは発生しません。

前提条件

Node.js

Python

Java

Apps Script

スペースを設定する

スペースを設定するには、リクエストに次のものを渡します。

  • 認可スコープ chat.spaces.create または chat.spaces を指定します。
  • SetUpSpace() メソッドを呼び出します。
  • space を Space のインスタンスとして渡し、displayName や spaceType などの必要なフィールドをすべて指定します。
  • memberships を Membership インスタンスの配列として渡します。インスタンスごとに、次の操作を行います。
    • users/{user} を指定して、人間のユーザーを Space メンバーとして追加します。ここで、{user} は、People API の person の {person_id} か、Directory API の user の ID です。たとえば、People API のユーザー resourceName が people/123456789 の場合、member.name として users/123456789 を含むメンバーシップを追加することで、ユーザーをスペースに追加できます。
    • groups/{group} を指定して、グループをスペース メンバーとして追加します。ここで、{group} はメンバーシップを作成するグループ ID です。グループの ID は、Cloud Identity API を使用して取得できます。たとえば、Cloud Identity API が groups/123456789 という名前のグループを返す場合は、membership.groupMember.name を groups/123456789 に設定します。Google グループはグループ チャットや DM には追加できません。名前付きスペースにのみ追加できます。

呼び出し元のユーザーと別の人間ユーザーとの間で DM を作成するには、リクエストで人間ユーザーのメンバーシップを指定します。

呼び出し元ユーザーと呼び出し元アプリの間に DM を作成するには、space.singleUserBotDm を true に設定し、メンバーシップは指定しません。この方法は、通話アプリで DM を設定する場合にのみ使用できます。通話アプリをスペースのメンバーとして追加する場合や、2 人の人間ユーザー間の既存の DM に追加する場合は、メンバーシップを作成するをご覧ください。

次の例では、名前付きスペースを作成し、2 人の人間のユーザー（認証済みユーザーともう 1 人）のスペースにメンバーシップを 1 つ作成します。

Node.js

chat/client-libraries/cloud/set-up-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 set up a named space with one initial member
// 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'
    },
    memberships: [{
      member: {
        // Replace USER_NAME here.
        name: 'users/USER_NAME',
        type: 'HUMAN'
      }
    }]
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/set_up_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 set_up_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

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

    # Handle the response
    print(response)

set_up_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  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))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to set up a named space with one initial member 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 setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

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

サンプルを実行するには、次のように置き換えます。

  • DISPLAY_NAME: 新しいスペースの表示名。
  • USER_NAME: メンバーシップを含める他のユーザーの ID。

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