Google Chat 스페이스에서 사용자의 멤버십 업데이트하기

이 가이드에서는 Google Chat API의 membership 리소스에서 patch 메서드를 사용하여 스페이스 참여자를 스페이스 관리자로 변경하거나 스페이스 관리자를 스페이스 참여자로 변경하는 등 멤버십 관련 속성을 변경하는 방법을 설명합니다.

Membership 리소스는 실제 사용자 또는 Google Chat 앱이 스페이스에 초대되었는지, 스페이스의 일부인지, 또는 스페이스에 없는지를 나타냅니다.

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.memberships 승인 범위 또는 Chat으로 데이터를 가져오는 경우 chat.import 승인 범위를 사용하는 사용자 인증이 필요합니다.

Node.js

  • Node.js 및 npm
  • Node.js용 최신 Google 클라이언트 라이브러리입니다. 설치하려면 명령줄 인터페이스에서 다음 명령어를 실행하세요.

    npm install @google-cloud/local-auth @googleapis/chat
    
  • Google Chat API가 사용 설정 및 구성된 Google Cloud 프로젝트 단계는 Google Chat 앱 빌드를 참고하세요.
  • 채팅 앱에 구성된 승인입니다. 멤버십을 업데이트하려면 chat.memberships 승인 범위 또는 Chat으로 데이터를 가져오는 경우 chat.import 승인 범위를 사용하는 사용자 인증이 필요합니다.

Apps Script

멤버십 업데이트

스페이스 멤버십을 업데이트하려면 요청에 다음을 전달합니다.

  • chat.memberships 승인 범위를 지정합니다.
  • Membership 리소스에서 patch 메서드를 호출하고 업데이트할 멤버십의 name과 업데이트된 멤버십 속성을 지정하는 updateMaskbody를 전달합니다.
  • updateMask는 업데이트할 멤버십 요소를 지정하며 다음을 포함합니다.
    • role: Chat 스페이스 내 사용자의 역할로, 스페이스에서 허용되는 작업을 결정합니다. 가능한 값은 다음과 같습니다.
      • ROLE_MEMBER: 스페이스의 멤버입니다. 사용자는 스페이스에 메시지 전송과 같은 기본 권한을 갖습니다. 1:1 대화 및 이름이 지정되지 않은 그룹 대화에서 모든 사람이
      • ROLE_MANAGER: 스페이스 관리자입니다. 사용자는 모든 기본 권한에 더해 구성원 추가 또는 삭제와 같이 스페이스를 관리할 수 있는 관리 권한을 갖게 됩니다. spaceTypeSPACE인 스페이스(이름이 지정된 공백)에서만 지원됩니다.

일반 스페이스 멤버를 스페이스 관리자로 지정하기

다음 예에서는 업데이트된 멤버십 속성을 지정하는 body에서 roleROLE_MANAGER로 지정하여 일반 스페이스 구성원을 스페이스 관리자로 만듭니다.

Python

  1. 작업 디렉터리에서 chat_membership_update.py라는 파일을 만듭니다.
  2. chat_membership_update.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.memberships"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then updates a specified space member to change
        it from a regular member to a space manager.
        '''
    
        # 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().members().patch(
    
            # The membership to update, and the updated role.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MEMBERSHIP with a membership name.
            # Obtain the membership name from the membership of Chat API.
            name='spaces/SPACE/members/MEMBERSHIP',
            updateMask='role',
            body={'role': 'ROLE_MANAGER'}
    
          ).execute()
    
        # Prints details about the updated membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 코드에서 다음을 바꿉니다.

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

    python3 chat_membership_update.py
    

Node.js

  1. 작업 디렉터리에서 chat_membership_update.js라는 파일을 만듭니다.
  2. chat_membership_update.js에 다음 코드를 포함합니다.

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Updates a membership in a Chat space to change it from
    * a space member to a space manager.
    * @return {!Promise<!Object>}
    */
    async function updateSpace() {
    
      /**
      * Authenticate with Google Workspace
      * and get user authorization.
      */
      const scopes = [
        'https://www.googleapis.com/auth/chat.memberships',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      /**
      * Build a service endpoint for Chat API.
      */
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      /**
      * Use the service endpoint to call Chat API.
      */
      return await chatClient.spaces.patch({
    
        /**
        * The membership to update, and the updated role.
        *
        * Replace SPACE with a space name.
        * Obtain the space name from the spaces resource of Chat API,
        * or from a space's URL.
        *
        * Replace MEMBERSHIP with a membership name.
        * Obtain the membership name from the membership of Chat API.
        */
        name: 'spaces/SPACE/members/MEMBERSHIP',
        updateMask: 'role',
        requestBody: {
          role: 'ROLE_MANAGER'
        }
      });
    }
    
    /**
    * Use the service endpoint to call Chat API.
    */
    updateSpace().then(console.log);
    
  3. 코드에서 다음을 바꿉니다.

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

    python3 chat_membership_update.js
    

Apps Script

이 예에서는 고급 Chat 서비스를 사용하여 Chat API를 호출합니다.

  1. Apps Script 프로젝트의 appsscript.json 파일에 chat.memberships 승인 범위를 추가합니다.

    "oauthScopes": [
      "https://www.googleapis.com/auth/chat.memberships"
    ]
    
  2. Apps Script 프로젝트의 코드에 다음과 같은 함수를 추가합니다.

    /**
     * Updates a membership from space member to space manager.
     * @param {string} memberName The resource name of the membership.
    */
    function updateMembershipToSpaceManager(memberName) {
      try {
        const body = {'role': 'ROLE_MANAGER'};
        Chat.Spaces.Members.patch(memberName, body);
      } catch (err) {
        // TODO (developer) - Handle exception
        console.log('Failed to create message with error %s', err.message);
      }
    }
    

Google Chat API는 지정된 멤버십을 스페이스 관리자로 변경하고 변경사항을 자세히 설명하는 Membership 인스턴스를 반환합니다.

스페이스 관리자를 정규 회원으로 설정하기

다음 예에서는 업데이트된 멤버십 속성을 지정하는 body에서 roleROLE_MEMBER로 지정하여 스페이스 관리자를 일반 스페이스 멤버로 만듭니다.

Python

  1. 작업 디렉터리에서 chat_membership_update.py라는 파일을 만듭니다.
  2. chat_membership_update.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.memberships"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then updates a specified space member to change
        it from a regular member to a space manager.
        '''
    
        # 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().members().patch(
    
            # The membership to update, and the updated role.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MEMBERSHIP with a membership name.
            # Obtain the membership name from the membership of Chat API.
            name='spaces/SPACE/members/MEMBERSHIP',
            updateMask='role',
            body={'role': 'ROLE_MEMBER'}
    
          ).execute()
    
        # Prints details about the updated membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 코드에서 다음을 바꿉니다.

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

    python3 chat_membership_update.py
    

Node.js

  1. 작업 디렉터리에서 chat_membership_update.js라는 파일을 만듭니다.
  2. chat_membership_update.js에 다음 코드를 포함합니다.

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Updates a membership in a Chat space to change it from
    * a space manager to a space member.
    * @return {!Promise<!Object>}
    */
    async function updateSpace() {
    
      /**
      * Authenticate with Google Workspace
      * and get user authorization.
      */
      const scopes = [
        'https://www.googleapis.com/auth/chat.memberships',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      /**
      * Build a service endpoint for Chat API.
      */
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      /**
      * Use the service endpoint to call Chat API.
      */
      return await chatClient.spaces.patch({
    
        /**
        * The membership to update, and the updated role.
        *
        * Replace SPACE with a space name.
        * Obtain the space name from the spaces resource of Chat API,
        * or from a space's URL.
        *
        * Replace MEMBERSHIP with a membership name.
        * Obtain the membership name from the membership of Chat API.
        */
        name: 'spaces/SPACE/members/MEMBERSHIP',
        updateMask: 'role',
        requestBody: {
          role: 'ROLE_MEMBER'
        }
      });
    }
    
    /**
    * Use the service endpoint to call Chat API.
    */
    updateSpace().then(console.log);
    
  3. 코드에서 다음을 바꿉니다.

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

    python3 chat_membership_update.js
    

Apps Script

이 예에서는 고급 Chat 서비스를 사용하여 Chat API를 호출합니다.

  1. Apps Script 프로젝트의 appsscript.json 파일에 chat.memberships 승인 범위를 추가합니다.

    "oauthScopes": [
      "https://www.googleapis.com/auth/chat.memberships"
    ]
    
  2. Apps Script 프로젝트의 코드에 다음과 같은 함수를 추가합니다.

    /**
     * Updates a membership from space manager to space member.
     * @param {string} memberName The resource name of the membership.
    */
    function updateMembershipToSpaceMember(memberName) {
      try {
        const body = {'role': 'ROLE_MEMBER'};
        Chat.Spaces.Members.patch(memberName, body);
      } catch (err) {
        // TODO (developer) - Handle exception
        console.log('Failed to create message with error %s', err.message);
      }
    }
    

Google Chat API는 지정된 멤버십을 스페이스 관리자로 변경하고 변경사항을 자세히 설명하는 Membership 인스턴스를 반환합니다.