이 가이드에서는 Google Chat API의 Membership
리소스에서 update()
메서드를 사용하여 스페이스 구성원을 스페이스 관리자로 변경하거나 스페이스 관리자를 스페이스 구성원으로 변경하는 등 멤버십에 관한 속성을 변경하는 방법을 설명합니다.
Google Workspace 관리자는 update()
메서드를 호출하여 Google Workspace 조직의 스페이스 멤버십을 업데이트할 수 있습니다.
Membership
리소스는 사람 사용자 또는 Google Chat 앱이 스페이스에 초대되었는지, 스페이스에 속해 있는지, 스페이스에 없는지를 나타냅니다.
기본 요건
Node.js
- Google Chat에 액세스할 수 있는 비즈니스 또는 엔터프라이즈 Google Workspace 계정
- 환경을 설정합니다.
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성
- Chat 앱의 이름, 아이콘, 설명을 사용하여 Google Chat API를 사용 설정하고 구성합니다.
- Node.js Cloud 클라이언트 라이브러리를 설치합니다.
- Google Chat API 요청에서 인증할 방법에 따라 액세스 사용자 인증 정보를 만듭니다.
- Chat 사용자로 인증하려면 OAuth 클라이언트 ID 사용자 인증 정보를 만들고 사용자 인증 정보를
client_secrets.json
라는 JSON 파일로 로컬 디렉터리에 저장합니다. - Chat 앱으로 인증하려면 서비스 계정 사용자 인증 정보를 만들고 사용자 인증 정보를
credentials.json
라는 JSON 파일로 저장합니다.
- Chat 사용자로 인증하려면 OAuth 클라이언트 ID 사용자 인증 정보를 만들고 사용자 인증 정보를
- 사용자 또는 Chat 앱으로 인증할지 여부에 따라 승인 범위를 선택합니다.
멤버십 업데이트
스페이스 멤버십을 업데이트하려면 요청에 다음을 전달합니다.
- 승인 범위를 지정합니다.
UpdateMembership()
메서드를 호출합니다.- 다음을 사용하여
membership
를Membership
의 인스턴스로 전달합니다.- 업데이트할 멤버십으로 설정된
name
필드로, 스페이스 ID와 회원 ID가 포함됩니다. - 업데이트할 멤버십 필드가 새 값으로 설정됩니다.
- 업데이트할 멤버십으로 설정된
updateMask
를 전달하여 업데이트할 멤버십의 측면을 지정합니다. 여기에는 다음이 포함됩니다.role
: Chat 스페이스 내에서 사용자의 역할로, 스페이스에서 허용되는 작업을 결정합니다. 가능한 값은 다음과 같습니다.ROLE_MEMBER
: 스페이스의 구성원입니다. 사용자에게 스페이스에 메시지를 보내는 등의 기본 권한이 있습니다. 1:1 및 이름이 지정되지 않은 그룹 대화에서는 모든 사용자가 이 역할을 갖습니다.ROLE_MANAGER
: 스페이스 관리자입니다. 사용자는 모든 기본 권한과 함께 멤버 추가 또는 삭제와 같이 스페이스를 관리할 수 있는 관리 권한을 갖습니다.spaceType
이SPACE
인 스페이스(이름이 지정된 스페이스)에서만 지원됩니다.
일반 스페이스 회원을 사용자로 스페이스 관리자로 지정하기
다음 예에서는 사용자 인증을 사용하여 Chat API를 호출하여 role
을 ROLE_MANAGER
로 지정하여 일반 스페이스 회원을 스페이스 관리자로 만듭니다.
Node.js
샘플을 실행하려면 다음을 바꿉니다.
SPACE_NAME
: 스페이스name
의 ID입니다.ListSpaces()
메서드를 호출하거나 스페이스의 URL에서 ID를 가져올 수 있습니다.MEMBER_NAME
: 멤버십의name
에 있는 ID입니다.ListMemberships()
메서드를 호출하거나 Chat API로 비회원 가입을 비동기식으로 만든 후 반환된 응답 본문에서 ID를 가져올 수 있습니다.ROLE_NAME
: 업데이트된 역할ROLE_MANAGER
Google Chat API는 지정된 멤버십을 스페이스 관리자로 업데이트하고 Membership
의 인스턴스를 반환합니다.
스페이스 관리자를 사용자로 일반 멤버로 지정
다음 예에서는 사용자 인증을 사용하여 Chat API를 호출하여 role
를 ROLE_MEMBER
로 지정하여 스페이스 관리자를 일반 스페이스 회원으로 만듭니다.
Node.js
샘플을 실행하려면 다음을 바꿉니다.
SPACE_NAME
: 스페이스의name
의 ID입니다.ListSpaces()
메서드를 호출하거나 스페이스의 URL에서 ID를 가져올 수 있습니다.MEMBER_NAME
: 멤버십name
의 ID입니다.ListMemberships()
메서드를 호출하거나 Chat API와 비동기식으로 멤버십을 만든 후 반환된 응답 본문에서 ID를 가져올 수 있습니다.ROLE_NAME
: 업데이트된 역할ROLE_MEMBER
Google Chat API는 지정된 멤버십을 스페이스 관리자로 업데이트하고 Membership
의 인스턴스를 반환합니다.
Chat 앱으로 일반 스페이스 회원을 스페이스 관리자로 지정하기
앱 인증에는 일회성 관리자 승인이 필요합니다.
API 키 만들기
개발자 프리뷰 API 메서드를 호출하려면 API 검색 문서의 비공개 개발자 프리뷰 버전을 사용해야 합니다. 요청을 인증하려면 API 키를 전달해야 합니다.
API 키를 만들려면 앱의 Google Cloud 프로젝트를 열고 다음을 실행합니다.
- Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.
- 사용자 인증 정보 만들기 > API 키를 클릭합니다.
- 새 API 키가 표시됩니다.
- 복사 를 클릭하여 앱 코드에서 사용할 API 키를 복사합니다. API 키는 프로젝트 사용자 인증 정보의 'API 키' 섹션에서도 확인할 수 있습니다.
- 키 제한을 클릭하여 고급 설정을 업데이트하고 API 키 사용을 제한합니다. 자세한 내용은 API 키 제한 적용을 참고하세요.
Chat API를 호출하는 스크립트 작성
다음 예에서는 앱 인증을 사용하여 Chat API를 호출하여 업데이트된 멤버십 속성을 지정하는 body
에서 role
를 ROLE_MANAGER
로 지정하여 일반 스페이스 회원을 스페이스 관리자로 만듭니다.
Python
- 작업 디렉터리에
chat_membership_update_to_manager_app.py
라는 파일을 만듭니다. chat_membership_update_to_manager_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.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().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()
코드에서 다음을 바꿉니다.
API_KEY
: Chat API의 서비스 엔드포인트를 빌드하기 위해 만든 API 키입니다.SPACE
: Chat API의spaces.list
메서드 또는 스페이스 URL에서 가져올 수 있는 스페이스 이름입니다.MEMBERSHIP
: Chat API의spaces.members.list
메서드에서 가져올 수 있는 멤버십 이름입니다.
작업 디렉터리에서 샘플을 빌드하고 실행합니다.
python3 chat_membership_update_to_manager_app.py
스페이스 관리자를 채팅 앱에서 정규 멤버로 설정하기
앱 인증에는 일회성 관리자 승인이 필요합니다.
API 키 만들기
개발자 프리뷰 API 메서드를 호출하려면 API 검색 문서의 비공개 개발자 프리뷰 버전을 사용해야 합니다. 요청을 인증하려면 API 키를 전달해야 합니다.
API 키를 만들려면 앱의 Google Cloud 프로젝트를 열고 다음을 실행합니다.
- Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.
- 사용자 인증 정보 만들기 > API 키를 클릭합니다.
- 새 API 키가 표시됩니다.
- 복사 를 클릭하여 앱 코드에서 사용할 API 키를 복사합니다. API 키는 프로젝트 사용자 인증 정보의 'API 키' 섹션에서도 확인할 수 있습니다.
- 키 제한을 클릭하여 고급 설정을 업데이트하고 API 키 사용을 제한합니다. 자세한 내용은 API 키 제한 적용을 참고하세요.
Chat API를 호출하는 스크립트 작성
다음 예에서는 앱 인증을 사용하여 Chat API를 호출하여 업데이트된 멤버십 속성을 지정하는 body
에서 role
를 ROLE_MEMBER
로 지정하여 스페이스 관리자를 일반 스페이스 회원으로 만듭니다.
Python
- 작업 디렉터리에
chat_membership_update_to_member_app.py
라는 파일을 만듭니다. chat_membership_update_to_member_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.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. ''' # 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().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()
코드에서 다음을 바꿉니다.
API_KEY
: Chat API의 서비스 엔드포인트를 빌드하기 위해 만든 API 키입니다.SPACE
: Chat API의spaces.list
메서드 또는 스페이스의 URL에서 가져올 수 있는 스페이스 이름입니다.MEMBERSHIP
: Chat API의spaces.members.list
메서드에서 가져올 수 있는 멤버십 이름입니다.
작업 디렉터리에서 샘플을 빌드하고 실행합니다.
python3 chat_membership_update_to_member_app.py
Google Workspace 관리자로 멤버십 업데이트하기
Google Workspace 관리자는 update()
메서드를 호출하여 Google Workspace 조직의 모든 스페이스에 대한 멤버십을 업데이트할 수 있습니다.
Google Workspace 관리자로 이 메서드를 호출하려면 다음 단계를 따르세요.
- 사용자 인증을 사용하여 메서드를 호출하고 관리자 권한을 사용하여 메서드 호출을 지원하는 승인 범위를 지정합니다.
- 요청에서 쿼리 매개변수
useAdminAccess
를true
로 지정합니다.
자세한 내용 및 예시는 Google Workspace 관리자로서 Google Chat 스페이스 관리하기를 참고하세요.
관련 주제
- 스페이스에 사용자 또는 Google Chat 앱 초대 또는 추가하기
- 사용자 또는 Chat 앱의 멤버십에 대한 세부정보 가져오기
- 스페이스의 멤버 나열
- 스페이스에서 사용자 또는 Chat 앱 삭제하기