Google Chat에서 이름이 지정된 스페이스 만들기

이 가이드에서는 Google Chat API의 Space 리소스에서 create() 메서드를 사용하여 이름이 지정된 스페이스를 만드는 방법을 설명합니다.

이름이 지정된 스페이스 (여기서 spaceType은 SPACE임)는 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업하는 공간입니다. 이름이 지정된 스페이스에는 Chat 앱이 포함될 수 있습니다. 이름이 지정된 스페이스에는 관리 설정을 적용하고, 설명을 추가하고, 사용자 및 앱을 추가하거나 삭제할 수 있는 스페이스 관리자가 있습니다.

채팅 메시지 또는 그룹 메시지를 비롯한 다양한 유형의 Chat 스페이스를 만들려면 Space 리소스에서 setUp() 메서드를 사용하여 스페이스를 만들고 동시에 멤버를 추가하세요. 자세한 내용은 스페이스 설정을 참고하세요.

이름이 지정된 스페이스를 만든 후에는 인증된 사용자만 스페이스의 구성원이 됩니다. 스페이스에 멤버를 추가하려면 추가하려는 각 사용자 또는 앱의 Membership 리소스에서 create() 메서드를 호출합니다. 또는 setUp() 메서드를 사용하여 이름이 지정된 스페이스를 만들고 동시에 멤버를 추가할 수 있습니다.

기본 요건

Node.js

Python

자바

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

자바

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 앱으로 이름이 지정된 스페이스 만들기

앱 인증에는 일회성 관리자 승인이 필요합니다.

앱 인증을 사용하여 스페이스에 사용자를 초대하거나 추가하려면 요청에 다음을 전달하세요.

  • 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: customer/{customer} 형식의 스페이스 도메인의 고객 ID입니다. 여기서 {customer}는 Admin SDK 고객 리소스의 ID입니다. Chat 앱과 동일한 Google Workspace 조직에 스페이스를 만들려면 customers/my_customer를 사용하세요.

  4. 작업 디렉터리에서 샘플을 빌드하고 실행합니다.

    python3 chat_space_create_named_app.py

Google Chat에서 스페이스 열기

스페이스로 이동하려면 스페이스의 리소스 ID를 사용하여 스페이스의 URL을 빌드합니다. Google Chat 응답 본문의 스페이스 name에서 리소스 ID를 찾을 수 있습니다. 예를 들어 스페이스의 name이 spaces/1234567인 경우 https://mail.google.com/chat/u/0/#chat/space/1234567 URL을 사용하여 스페이스로 이동할 수 있습니다.

제한사항 및 고려사항

  • 앱 인증을 사용하여 스페이스를 만들면 인증된 Chat 앱이 스페이스의 멤버로 추가되지만 사용자 인증과 달리 스페이스 관리자로 추가되지는 않습니다. 기본적으로 모든 스페이스 구성원은 Chat 앱을 삭제할 수 있습니다. 스페이스 관리자만 Chat 앱을 삭제하도록 허용하려면 permissionSettings.manageApps을 managersAllowed로 설정하세요.