이 가이드에서는 Google Chat API의 Space 리소스에서
patch()
메서드를 사용하여 스페이스를 업데이트하는 방법을 설명합니다. 스페이스를 업데이트하여 사용자에게 표시되는 표시 이름, 설명, 가이드라인과 같은 스페이스의 속성을 변경합니다.
Google Workspace 관리자는 patch() 메서드를 호출하여 Google Workspace 조직의 기존 스페이스를 업데이트할 수 있습니다.
Space 리소스
는 사용자와 Chat 앱이 메시지를 보내고,
파일을 공유하고, 공동작업할 수 있는 공간을 나타냅니다. 다음과 같이 여러 유형의 스페이스가 있습니다.
- 채팅 메시지 (DM)는 두 사용자 또는 사용자와 Chat 앱 간의 대화입니다.
- 그룹 채팅은 세 명 이상의 사용자와 Chat 앱 간의 대화입니다.
- 이름 지정된 스페이스는 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업하는 영구적인 공간입니다.
기본 요건
Node.js
- Google Chat에 액세스할 수 있는 Business 또는 Enterprise Google Workspace 계정 Google Chat
- 환경 설정:
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성.
- Chat 앱의 이름, 아이콘, 설명으로 Google Chat API를 사용 설정하고 구성합니다.
- Node.js Cloud 클라이언트 라이브러리를 설치합니다.
-
데스크톱 애플리케이션의 OAuth 클라이언트 ID 사용자 인증 정보를 만듭니다. 이 가이드의 샘플을 실행하려면 사용자 인증 정보를
credentials.json이라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
Python
- Google Chat에 액세스할 수 있는 Business 또는 Enterprise Google Workspace 계정 Google Chat
- 환경 설정:
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성.
- Chat 앱의 이름, 아이콘, 설명으로 Google Chat API를 사용 설정하고 구성합니다.
- Python Cloud 클라이언트 라이브러리를 설치합니다.
-
데스크톱 애플리케이션의 OAuth 클라이언트 ID 사용자 인증 정보를 만듭니다. 이 가이드의 샘플을 실행하려면 사용자 인증 정보를
credentials.json이라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
자바
- Google Chat에 액세스할 수 있는 Business 또는 Enterprise Google Workspace 계정 Google Chat
- 환경 설정:
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성.
- Chat 앱의 이름, 아이콘, 설명으로 Google Chat API를 사용 설정하고 구성합니다.
- 자바 Cloud 클라이언트 라이브러리를 설치합니다.
-
데스크톱 애플리케이션의 OAuth 클라이언트 ID 사용자 인증 정보를 만듭니다. 이 가이드의 샘플을 실행하려면 사용자 인증 정보를
credentials.json이라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
Apps Script
- Google Chat에 액세스할 수 있는 Business 또는 Enterprise Google Workspace 계정 Google Chat
- 환경 설정:
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성.
- Chat 앱의 이름, 아이콘, 설명으로 Google Chat API를 사용 설정하고 구성합니다.
- 독립형 Apps Script 프로젝트를 만들고 고급 Chat 서비스를 사용 설정합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
사용자로 스페이스 업데이트
사용자 인증으로 Google Chat의 기존 스페이스를 업데이트하려면 요청에 다음을 전달합니다.
chat.spaces승인 범위를 지정합니다.-
UpdateSpace()메서드를 호출합니다. 요청에서 스페이스name필드, 업데이트할 필드가 하나 이상 있는updateMask필드, 업데이트된 스페이스 정보가 있는body를 지정합니다.
표시 이름, 스페이스 유형, 기록 상태 등을 업데이트할 수 있습니다. 업데이트할 수 있는 모든 필드를 보려면 참조 문서를 참고하세요.
기존 스페이스의 displayName 필드를 업데이트하는 방법은 다음과 같습니다.
Node.js
Python
자바
Apps Script
이 샘플을 실행하려면 SPACE_NAME을 스페이스의
name
필드에 있는 ID로 바꿉니다. `ListSpaces()` 메서드를 호출하거나 스페이스의 URL에서 ID를 가져올 수 있습니다.ListSpaces()
Google Chat API는 업데이트를 반영하는
Space 인스턴스를 반환합니다.
Google Workspace 관리자로 스페이스 업데이트
Google Workspace 관리자는 UpdateSpace() 메서드를 호출하여 Google Workspace 조직의 스페이스를 업데이트할 수 있습니다.
Google Workspace 관리자로 이 메서드를 호출하려면 다음 단계를 따르세요.
- 사용자 인증을 사용하여 메서드를 호출하고 관리자 권한 으로 메서드 호출을 지원하는 승인 범위를 지정합니다.
- 요청에서 쿼리 매개변수
useAdminAccess를true로 지정합니다.
자세한 내용과 예시는 Google Workspace 관리자로 Google Chat 스페이스 관리를 참고하세요.
Chat 앱으로 스페이스 업데이트
앱 인증에는 일회성 관리자 승인이 필요합니다.
앱 인증으로 Google Chat의 기존 스페이스를 업데이트하려면 요청에 다음을 전달합니다.
chat.app.spaces승인 범위를 지정합니다. 앱 인증을 사용하면 Chat 앱에서 만든 스페이스만 업데이트할 수 있습니다.Space리소스에서patch메서드를 호출합니다. 요청에서 스페이스name필드, 업데이트할 필드가 하나 이상 있는updateMask필드, 업데이트된 스페이스 정보가 있는body를 지정합니다.
표시 이름, 스페이스 유형, 기록 상태, 권한 설정 등을 업데이트할 수 있습니다. 업데이트할 수 있는 모든 필드를 보려면 참조 문서를 참고하세요.
Chat API를 호출하는 스크립트 작성
기존 스페이스의 spaceDetails 필드를 업데이트하는 방법은 다음과 같습니다.
Python
- 작업 디렉터리에
chat_space_update_app.py라는 파일을 만듭니다. chat_space_update_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"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # 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) # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()코드에서 다음을 바꿉니다.
SPACE를 스페이스 이름으로 바꿉니다. 스페이스 이름은spaces.list메서드 를 Chat API에서 가져오거나 스페이스의 URL에서 가져올 수 있습니다.
작업 디렉터리에서 다음 샘플을 빌드하고 실행합니다.
python3 chat_space_update_app.py
Google Chat API는 업데이트를 반영하는
Space 리소스 인스턴스를 반환합니다.
제한사항 및 고려사항
- 앱 인증을 사용하면 Chat 앱에서 다음 작업을 할 수 있습니다.
- 자신이 만든 스페이스에서
predefinedPermissionSettings또는permissionSettings만 업데이트할 수 있습니다. accessSettings.audience를 업데이트할 수 없습니다.
- 자신이 만든 스페이스에서
관련 주제
- 스페이스에 대한 세부정보를 가져옵니다.
- 스페이스를 나열합니다.
- 스페이스를 삭제합니다.
- 스페이스를 설정합니다.
- 채팅 메시지 스페이스를 찾습니다.
- 특정 사용자가 스페이스를 검색할 수 있도록 합니다.