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

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

Space 리소스 는 사람과 채팅 앱이 메시지를 보낼 수 있는 위치를 나타냅니다. 파일 공유, 공동작업 등이 가능합니다 다음과 같은 여러 유형의 스페이스가 있습니다.

  • 채팅 메시지 (DM)는 사용자 2명 또는 상대방과 채팅 앱
  • 그룹 채팅은 세 명 이상의 사용자와 채팅 앱
  • 이름이 지정된 스페이스는 사용자가 메시지를 보내고, 파일을 공유하고, 협업할 수 있습니다

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

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

기본 요건

Python

Node.js

스페이스 설정하기

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

  • chat.spaces.create 또는 chat.spaces 승인 범위를 지정합니다.
  • 먼저 setup 메서드 (Space 리소스에 있음)
  • 실제 사용자를 스페이스 멤버로 추가하려면 users/{user}를 지정합니다. 여기서 {user} {person_id}person 또는 user 사용할 수 있습니다. 예를 들어 People API 담당자가 resourceName님이 people/123456789인 경우 다음 방법으로 사용자를 스페이스에 추가할 수 있습니다. member.name 멤버십이 users/123456789인 멤버십을 포함합니다.
  • 그룹을 스페이스 참여자로 추가하려면 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인 경우 멤버십 만들기를 선택합니다.

다음 예시에서는 이름이 지정된 스페이스를 만들고 스페이스에 멤버십을 만듭니다. 그룹 1개 및 실제 사용자 3명 (인증된 사용자와 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 users and groups 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'
                  }
                },
                {
                  'groupMember': {
                    'name': 'groups/11223344'
                  }
                }
            ]
          }
    
          ).execute()
    
        # Prints details about the created space.
        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'}},
            {groupMember: {name: 'groups/11223344'}},
          ]
        }
      });
    }
    
    setupSpace().then(console.log);
    
  3. 작업 디렉터리에서 샘플을 실행합니다.

    node setup-space.js
    

그룹 1개와 설정되어 있는지 확인합니다.

스페이스로 이동하려면 스페이스의 리소스 ID를 사용하여 스페이스의 URL을 만듭니다. Google Chat 응답에서 name 스페이스의 리소스 ID를 가져올 수 있습니다. 본문입니다. 예를 들어 스페이스의 name이(가) spaces/1234567인 경우 다음과 같이 할 수 있습니다. 다음 URL을 사용하여 스페이스에 추가합니다. https://mail.google.com/chat/u/0/#chat/space/1234567입니다.