Google Chat 스페이스 만들기 및 회원 추가하기

이 가이드에서는 Google Chat API의 Space 리소스에서 setUp() 메서드를 사용하여 Chat 스페이스를 만들고 구성원을 추가하는 방법을 설명합니다.

Space 리소스는 사용자와 Chat 앱이 메시지를 보내고, 파일을 공유하고, 공동작업할 수 있는 공간을 나타냅니다. 스페이스에는 다음과 같은 여러 유형이 있습니다.

  • 채팅 메시지 (DM)는 두 사용자 간 또는 사용자와 채팅 앱 간의 대화입니다.
  • 그룹 채팅은 3명 이상의 사용자와 Chat 앱 간의 대화입니다.
  • 이름이 지정된 스페이스는 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업하는 지속적인 공간입니다.

setUp() 메서드를 사용하여 다음을 수행할 수 있습니다.

  • 초기 구성원이 있는 명명된 스페이스를 만듭니다.
  • 두 사용자 간에 채팅 메시지 (DM)를 만듭니다.
  • 여러 사용자 간에 그룹 메시지를 설정합니다.

스페이스를 설정할 때는 다음 사항을 고려하세요.

  • 호출 (인증된) 사용자가 스페이스에 자동으로 추가되므로 요청에서 사용자의 멤버십을 지정할 필요가 없습니다.
  • 채팅 메시지 (DM)를 만들 때 두 사용자 간에 DM이 있으면 DM이 반환됩니다. 그렇지 않으면 DM이 생성됩니다.
  • 그룹 채팅을 만들 때 요청에 제공된 멤버십이 그룹 채팅에 추가되지 않으면(예: 권한 문제) 호출 사용자가 포함된 빈 그룹 채팅이 생성될 수 있습니다.
  • 스레드형 답글이 있는 스페이스를 설정하거나 Google Workspace 조직 외부의 사용자를 추가할 수 없습니다.
  • 요청에 제공된 중복 회원 (호출 사용자 포함)은 요청 오류가 발생하는 대신 필터링됩니다.
  • Google Workspace 관리자가 Google Workspace 조직 전체에 Chat 앱을 설치하면 Google Chat에서 설치된 Chat 앱과 조직의 각 사용자 간에 DM을 생성하므로 프로그래매틱 방식으로 DM을 설정할 필요가 없습니다. 대신 스페이스를 나열하여 모든 DM을 반환하거나 채팅 메시지 찾기를 사용하여 특정 DM에 관한 세부정보를 가져옵니다.

기본 요건

Node.js

Python

자바

Apps Script

스페이스 설정하기

스페이스를 설정하려면 요청에 다음을 전달하세요.

  • chat.spaces.create 또는 chat.spaces 승인 범위를 지정합니다.
  • SetUpSpace() 메서드를 호출합니다.
  • displayName 또는 spaceType과 같은 필요한 모든 필드가 있는 Space의 인스턴스로 space를 전달합니다.
  • memberships를 Membership 인스턴스 배열로 전달합니다. 각 인스턴스에 대해 다음을 수행합니다.
    • users/{user}를 지정하여 사람 사용자를 스페이스 구성원으로 추가합니다. 여기서 {user}는 People API의 person에 대한 {person_id}이거나 Directory API의 user ID입니다. 예를 들어 People API 사용자 resourceName이 people/123456789인 경우 users/123456789을 member.name로 사용하여 멤버십을 포함하여 사용자를 스페이스에 추가할 수 있습니다.
    • groups/{group}를 지정하여 그룹을 스페이스 구성원으로 추가합니다. 여기서 {group}은 멤버십을 만들려는 그룹 ID입니다. 그룹 ID는 Cloud ID API를 사용하여 가져올 수 있습니다. 예를 들어 Cloud ID API에서 이름이 groups/123456789인 그룹을 반환하는 경우 membership.groupMember.name을 groups/123456789로 설정합니다. Google 그룹은 그룹 채팅이나 채팅 메시지에 추가할 수 없으며 이름이 지정된 스페이스에만 추가할 수 있습니다.

호출하는 사용자와 다른 실제 사용자 간에 DM을 만들려면 요청에 실제 사용자의 멤버십을 지정하세요.

호출하는 사용자와 호출하는 앱 간에 DM을 만들려면 space.singleUserBotDm을 true로 설정하고 멤버십을 지정하지 마세요. 이 메서드는 통화 앱과의 DM을 설정하는 데만 사용할 수 있습니다. 통화 앱을 스페이스의 구성원 또는 두 명의 실제 사용자 간 기존 DM에 추가하려면 멤버십 만들기를 참고하세요.

다음 예에서는 명명된 스페이스를 만들고 두 명의 실제 사용자 (인증된 사용자 및 다른 사용자 한 명)에 대해 스페이스 멤버십을 하나 만듭니다.

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()

자바

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을 빌드합니다. Google Chat 응답 본문의 스페이스 name에서 리소스 ID를 가져올 수 있습니다. 예를 들어 스페이스의 name이 spaces/1234567인 경우 다음 URL을 사용하여 스페이스로 이동할 수 있습니다. https://mail.google.com/chat/u/0/#chat/space/1234567