Google Chat 스페이스 일정 세부정보 보기

이 가이드에서는 Google Chat API의 SpaceEvent 리소스에서 get() 메서드를 사용하여 Google Chat 스페이스의 이벤트에 관한 세부정보를 가져오는 방법을 설명합니다.

SpaceEvent 리소스는 스페이스 또는 메시지, 반응, 멤버십과 같은 하위 리소스의 변경사항을 나타냅니다. 지원되는 이벤트 유형에 대한 자세한 내용은 SpaceEvent 리소스의 eventType 필드 참조 문서를 참고하세요.

요청 시간으로부터 최대 28일 전의 이벤트를 요청할 수 있습니다. 이벤트에는 변경된 리소스의 최신 버전이 포함됩니다. 예를 들어 새 메시지에 관한 이벤트를 요청했지만 나중에 메시지가 업데이트된 경우 서버는 이벤트 페이로드에서 업데이트된 Message 리소스를 반환합니다.

이 메서드를 호출하려면 사용자 인증을 사용해야 합니다. 이벤트를 가져오려면 인증된 사용자가 이벤트가 발생한 스페이스의 구성원이어야 합니다.

기본 요건

Node.js

Python

스페이스 이벤트에 관한 세부정보 가져오기 (사용자 인증)

Google Chat의 스페이스 이벤트에 관한 세부정보를 가져오려면 요청에 다음을 전달하세요.

  • 요청에서 이벤트 유형을 지원하는 승인 범위를 지정합니다. 앱이 작동할 수 있는 가장 제한적인 범위를 선택하는 것이 좋습니다.
  • 가져올 스페이스 이벤트의 name를 전달하여 GetSpaceEvent() 메서드를 호출합니다.

다음 예에서는 스페이스 이벤트를 가져옵니다.

Node.js

이 Node.js 코드 샘플은 Chat RPC API를 사용합니다.

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

await main();

이 샘플을 실행하려면 다음을 바꾸세요.

  • SCOPE_NAME: 이벤트 유형에 기반한 승인 범위입니다. 예를 들어 새 멤버십에 관한 스페이스 이벤트를 가져오는 경우 https://www.googleapis.com/auth/chat.memberships.readonly 형식으로 지정된 chat.memberships.readonly 범위를 사용합니다. ListSpaceEvents() 메서드에서 이벤트 유형을 가져올 수 있습니다. 이 메서드를 사용하는 방법을 알아보려면 스페이스의 이벤트 나열을 참고하세요.
  • SPACE_NAME: 스페이스의 name에서 가져온 ID입니다. ListSpaces() 메서드를 호출하거나 스페이스의 URL에서 ID를 가져올 수 있습니다.
  • SPACE_EVENT_NAME: 스페이스 이벤트의 name에서 가져온 ID입니다. ListSpaceEvents() 메서드에서 ID를 가져올 수 있습니다. 이 메서드를 사용하는 방법을 알아보려면 스페이스의 이벤트 나열을 참고하세요.

Chat API는 이벤트에 관한 세부정보가 포함된 SpaceEvent 인스턴스를 반환합니다.

스페이스 이벤트에 관한 세부정보 가져오기 (Chat 앱 인증)

앱 인증에는 일회성 관리자 승인이 필요합니다.

Chat REST API를 사용하여 앱 인증이 있는 스페이스에서 스페이스 이벤트에 관한 세부정보를 가져오려면 요청에 다음을 전달하세요.

  • 요청에서 각 이벤트 유형을 지원하도록 하나 이상의 승인 범위를 지정합니다. 앱이 작동할 수 있는 가장 제한적인 범위를 선택하는 것이 좋습니다. 범위 선택에 대해 자세히 알아보려면 인증 및 승인 개요를 참고하세요.
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • spaceEvents 리소스에서 get 메서드를 호출합니다.
  • 이벤트 세부정보를 가져올 스페이스의 name를 전달합니다.

API 키 만들기

개발자 미리보기 API 메서드를 호출하려면 공개되지 않은 개발자 미리보기 버전의 API 검색 문서를 사용해야 합니다. 요청을 인증하려면 API 키를 전달해야 합니다.

API 키를 만들려면 앱의 Google Cloud 프로젝트를 열고 다음 단계를 따르세요.

  1. Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.

    사용자 인증 정보로 이동

  2. 사용자 인증 정보 만들기 > API 키를 클릭합니다.
  3. 새 API 키가 표시됩니다.
    • 복사 를 클릭하여 앱의 코드에서 사용할 API 키를 복사합니다. API 키는 프로젝트 사용자 인증 정보의 'API 키' 섹션에서도 확인할 수 있습니다.
    • 무단 사용을 방지하려면 API 키를 사용할 수 있는 위치와 API를 제한하는 것이 좋습니다. 자세한 내용은 API 제한사항 추가를 참고하세요.

Chat API를 호출하는 스크립트 작성

앱 인증Chat REST API를 사용하여 스페이스 이벤트에 관한 세부정보를 가져오는 방법은 다음과 같습니다.

Python

이 Python 코드 샘플은 Chat REST API를 사용합니다.

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

    from google.oauth2 import service_account
    from apiclient.discovery import build
    
    # Define your app's authorization scopes.
    # Set authorization scopes based on the
    # event type. For example, if you are getting a space event
    # about a new membership, use the `chat.app.memberships.readonly` scope.
    #
    # When modifying these scopes, delete the file token.json, if it exists.
    SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
              "https://www.googleapis.com/auth/chat.app.messages.readonly",
              "https://www.googleapis.com/auth/chat.app.spaces"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then lists space events from a specified space.
        '''
    
        # 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().spaceEvents().get(
    
            # The space to get event details from.
            #
            # Replace SPACE_NAME with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
    
        ).execute()
    
        # Print Chat API's response in your command line interface.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 코드에서 다음을 바꿉니다.

    • API_KEY: Chat API의 서비스 엔드포인트를 빌드하기 위해 만든 API 키입니다.
    • SPACE_NAME: 스페이스 이름입니다. Chat API의 spaces.list 메서드 또는 스페이스의 URL에서 가져올 수 있습니다.
    • SPACE_EVENT_NAME: 스페이스 이벤트의 name에서 가져온 ID입니다. ListSpaceEvents() 메서드에서 ID를 가져올 수 있습니다. 이 메서드를 사용하는 방법을 알아보려면 스페이스의 이벤트 나열을 참고하세요.
  4. 작업 디렉터리에서 다음 샘플을 빌드하고 실행합니다.

    python3 chat_spaceevents_get_app.py

Chat API는 새 멤버십과 메시지에 관한 페이지로 나누어진 스페이스 이벤트 목록을 반환합니다.