이 가이드에서는 Google Chat API의 Space
리소스에서 patch()
메서드를 사용하여 스페이스를 업데이트하는 방법을 설명합니다. 스페이스를 업데이트하여 사용자에게 표시되는 표시 이름, 설명, 가이드라인과 같은 스페이스의 속성을 변경합니다.
Google Workspace 관리자는 patch()
메서드를 호출하여 Google Workspace 조직의 기존 스페이스를 업데이트할 수 있습니다.
Space
리소스는 사용자와 Chat 앱이 메시지를 보내고, 파일을 공유하고, 공동작업할 수 있는 장소를 나타냅니다. 스페이스에는 다음과 같은 여러 유형이 있습니다.
- 채팅 메시지 (DM)는 두 사용자 간의 대화 또는 사용자와 Chat 앱 간의 대화입니다.
- 그룹 채팅은 세 명 이상의 사용자와 Chat 앱 간의 대화입니다.
- 이름이 지정된 스페이스는 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업하는 지속적인 공간입니다.
기본 요건
Node.js
- Google Chat에 액세스할 수 있는 비즈니스 또는 엔터프라이즈 Google Workspace 계정
- 환경을 설정합니다.
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성
- Chat 앱의 이름, 아이콘, 설명을 사용하여 Google Chat API를 사용 설정하고 구성합니다.
- Node.js Cloud 클라이언트 라이브러리를 설치합니다.
- 데스크톱 애플리케이션용
OAuth 클라이언트 ID 사용자 인증 정보 만들기 이 가이드에서 샘플을 실행하려면 사용자 인증 정보를
client_secrets.json
라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
Python
- Google Chat에 액세스할 수 있는 비즈니스 또는 엔터프라이즈 Google Workspace 계정
- 환경을 설정합니다.
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성
- Chat 앱의 이름, 아이콘, 설명을 사용하여 Google Chat API를 사용 설정하고 구성합니다.
- Python Cloud 클라이언트 라이브러리를 설치합니다.
- 데스크톱 애플리케이션의
OAuth 클라이언트 ID 사용자 인증 정보 만들기 이 가이드에서 샘플을 실행하려면 사용자 인증 정보를
client_secrets.json
라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
자바
- Google Chat에 액세스할 수 있는 비즈니스 또는 엔터프라이즈 Google Workspace 계정
- 환경을 설정합니다.
- Google Cloud 프로젝트를 만듭니다.
- OAuth 동의 화면 구성
- 채팅 앱의 이름, 아이콘, 설명을 사용하여 Google Chat API를 사용 설정하고 구성합니다.
- Java Cloud 클라이언트 라이브러리를 설치합니다.
- 데스크톱 애플리케이션의
OAuth 클라이언트 ID 사용자 인증 정보 만들기 이 가이드에서 샘플을 실행하려면 사용자 인증 정보를
client_secrets.json
라는 JSON 파일로 로컬 디렉터리에 저장합니다.
- 사용자 인증을 지원하는 승인 범위를 선택합니다.
Apps Script
- Google Chat에 액세스할 수 있는 비즈니스 또는 엔터프라이즈 Google Workspace 계정
- 환경을 설정합니다.
- 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를 가져올 수 있습니다.
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
를 지정합니다.
표시 이름, 스페이스 유형, 기록 상태, 권한 설정 등을 업데이트할 수 있습니다. 업데이트할 수 있는 모든 필드를 보려면 참조 문서를 확인하세요.
API 키 만들기
개발자 프리뷰 API 메서드를 호출하려면 API 검색 문서의 비공개 개발자 프리뷰 버전을 사용해야 합니다. 요청을 인증하려면 API 키를 전달해야 합니다.
API 키를 만들려면 앱의 Google Cloud 프로젝트를 열고 다음을 실행합니다.
- Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.
- 사용자 인증 정보 만들기 > API 키를 클릭합니다.
- 새 API 키가 표시됩니다.
- 복사 를 클릭하여 앱 코드에서 사용할 API 키를 복사합니다. API 키는 프로젝트 사용자 인증 정보의 'API 키' 섹션에서도 확인할 수 있습니다.
- 키 제한을 클릭하여 고급 설정을 업데이트하고 API 키 사용을 제한합니다. 자세한 내용은 API 키 제한사항 적용을 참고하세요.
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, 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().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()
코드에서 다음을 바꿉니다.
API_KEY
: Chat API의 서비스 엔드포인트를 빌드하기 위해 만든 API 키입니다.- Chat API의
spaces.list
메서드 또는 스페이스의 URL에서 가져올 수 있는 스페이스 이름이 포함된SPACE
작업 디렉터리에서 샘플을 빌드하고 실행합니다.
python3 chat_space_update_app.py
Google Chat API는 업데이트를 반영하는 Space
리소스의 인스턴스를 반환합니다.