초기 멤버로 스페이스 설정하기

이 가이드에서는 Google Chat API의 Space 리소스에서 setup 메서드를 사용하여 Google Chat 스페이스를 설정하는 방법을 설명합니다. 스페이스를 설정하면 스페이스가 생성되고 지정된 사용자가 스페이스에 추가됩니다.

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

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

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

• 호출 (인증된) 사용자가 스페이스에 자동으로 추가되므로 요청에서 사용자의 멤버십을 지정할 필요가 없습니다.
• 채팅 메시지 (DM)를 만들 때 두 사용자 간에 채팅 메시지가 있는 경우 해당 DM이 반환됩니다. 그렇지 않으면 DM이 생성됩니다.
• 그룹 채팅을 만들 때 요청에 제공된 멤버십이 그룹 채팅에 성공적으로 추가되지 않으면 (예: 권한 문제) 빈 그룹 채팅 (호출한 사용자만 포함)이 생성될 수 있습니다.
• 대화목록 답장으로 스페이스를 설정하거나 Google Workspace 외부 사용자를 추가할 수 없습니다.
• 요청에 제공된 중복 멤버십 (호출한 사용자 포함)은 요청 오류가 발생하는 대신 필터링됩니다.

기본 요건

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.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.spaces.create 또는 chat.spaces 승인 범위의 사용자 인증이 필요합니다.

스페이스 설정하기

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

• chat.spaces.create 또는 chat.spaces 승인 범위를 지정합니다.
• Space 리소스에서 setup 메서드를 호출합니다.
• 실제 사용자를 스페이스 구성원으로 추가하려면 users/{user}를 지정합니다. 여기서 {user}는 People API의 person {person_id} 또는 Directory API의 user ID입니다. 예를 들어 People API 사용자 resourceName가 people/123456789이면 users/123456789 멤버십을 member.name로 포함하여 스페이스에 사용자를 추가할 수 있습니다.
• 호출하는 사용자와 다른 실제 사용자 간에 DM을 만들려면 요청에 실제 사용자의 멤버십을 지정합니다.
• 통화 사용자와 통화 앱 간에 DM을 만들려면 Space.singleUserBotDm를 true로 설정하고 멤버십을 지정하지 않습니다. 이 메서드는 통화 앱으로 DM을 설정할 때만 사용할 수 있습니다. 통화 앱을 스페이스의 구성원 또는 두 실제 사용자 간의 기존 DM으로 추가하려면 멤버십 만들기를 참고하세요.

다음 예에서는 이름이 지정된 스페이스를 만들고 실제 사용자 3명(인증된 사용자 1명, 지정된 다른 사용자 2명)의 스페이스 멤버십을 만듭니다.

Python

1. 작업 디렉터리에서 chat_space_setup.py라는 파일을 만듭니다.

2. chat_space_setup.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 sets up a Chat space by creating a space and adding members.
       '''
   
       # 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().setup(
   
         # Details about the space to set up.
         body = {
   
           # Attributes of the space to set up, like space type and display name.
           'space': {
   
               # To set up a named space, set spaceType to SPACE.
               'spaceType': 'SPACE',
   
               # The user-visible name of the space
               'displayName': 'API-setup'
           },
   
           # The people and app to add to the space.
           #
           # The authenticated user is automatically added to the space,
           # and doesn't need to be specified in the memberships array.
           'memberships': [
               {
                 'member': {
                   'name':'users/123456789',
                   'type': 'HUMAN'
                 }
               },
               {
                 'member': {
                   'name':'users/987654321',
                   'type': 'HUMAN'
                 }
               }
           ]
         }
   
         ).execute()
   
       # Prints details about the created membership.
       print(result)
   
   if __name__ == '__main__':
       main()
   

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

   python3 chat_space_setup.py
   

Node.js

1. 작업 디렉터리에서 setup-space.js라는 파일을 만듭니다.

2. setup-space.js에 다음 코드를 포함합니다.

   const chat = require('@googleapis/chat');
   const {authenticate} = require('@google-cloud/local-auth');
   
   /**
   * Sets up a new Chat space with users.
   * @return {!Promise<!Object>}
   */
   async function setupSpace() {
     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.setup({
       requestBody: {
         space: {
           spaceType: 'SPACE',
           displayName: 'API-made',
         },
         memberships: [
           {member: {name: 'users/123456789', type: 'HUMAN'}},
           {member: {name: 'users/987654321', type: 'HUMAN'}},
         ]
       }
     });
   }
   
   setupSpace().then(console.log);
   

3. 작업 디렉터리에서 샘플을 실행합니다.

   node setup-space.js
   

인증된 사용자를 포함하여 실제 사용자 3명이 있는 이름이 지정된 Chat 스페이스가 설정됩니다.

스페이스로 이동하려면 스페이스의 리소스 ID를 사용하여 스페이스의 URL을 작성합니다. Google Chat 응답 본문의 name 스페이스에서 리소스 ID를 가져올 수 있습니다. 예를 들어 스페이스의 name가 spaces/1234567이면 https://mail.google.com/chat/u/0/#chat/space/1234567 URL을 사용하여 해당 스페이스로 이동할 수 있습니다.

관련 주제

• 스페이스 만들기
• 스페이스 세부정보 확인하기
• 스페이스 나열
• 스페이스 업데이트하기
• 스페이스 삭제하기
• 채팅 메시지 스페이스를 찾습니다.