메시지에 대한 세부정보 보기

이 가이드에서는 Google Chat API의 Message 리소스에서 get 메서드를 사용하여 문자 메시지 또는 카드 메시지에 대한 세부정보를 반환하는 방법을 설명합니다.

Message 리소스는 Google Chat의 텍스트 또는 카드 메시지를 나타냅니다. 상응하는 메서드를 호출하여 Google Chat API에서 메시지를 create, get, update 또는 delete할 수 있습니다. 문자 및 카드 메시지에 관한 자세한 내용은 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.messages.readonly 또는 chat.messages 승인 범위를 사용하는 사용자 인증은 사용자가 액세스할 수 있는 메시지를 가져올 수 있습니다.
    • chat.bot 승인 범위를 사용하는 앱 인증은 앱으로 전송된 메시지를 가져올 수 있습니다.

사용자 인증이 포함된 메시지 가져오기

사용자 인증을 사용하여 메시지에 대한 세부정보를 가져오려면 요청에 다음을 전달합니다.

  • chat.messages.readonly 또는 chat.messages 승인 범위를 지정합니다.
  • Message 리소스에서 get 메서드를 호출합니다.
  • name를 가져올 메시지의 리소스 이름으로 설정합니다.

다음 예에서는 사용자 인증이 포함된 메시지를 가져옵니다.

Python

  1. 작업 디렉터리에서 chat_message_get_user.py라는 파일을 만듭니다.
  2. chat_message_get_user.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.messages.readonly"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then gets a message.
        '''
    
        # 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().messages().get(
    
            # The message to get.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MESSAGE with a message name.
            # Obtain the message name from the response body returned
            # after creating a message asynchronously with Chat REST API.
            name = 'spaces/SPACE/messages/MESSAGE'
    
        ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. 코드에서 다음을 바꿉니다.

    • SPACE: Chat API의 spaces.list 메서드 또는 스페이스 URL에서 가져올 수 있는 스페이스 이름입니다.
    • MESSAGE: 메시지 이름으로, Chat API를 사용하여 메시지를 비동기식으로 만들거나 생성 시 메시지에 할당된 커스텀 이름을 사용하여 메시지를 만든 후 반환된 응답 본문에서 가져올 수 있습니다.
  4. 작업 디렉터리에서 샘플을 빌드하고 실행합니다.

    python3 chat_message_get_user.py
    

Chat API는 지정된 메시지를 자세히 설명하는 Message 인스턴스를 반환합니다.

앱 인증이 포함된 메시지 받기

앱 인증을 사용하여 메시지에 관한 세부정보를 가져오려면 요청에 다음을 전달합니다.

  • chat.bot 승인 범위를 지정합니다.
  • Message 리소스에서 get 메서드를 호출합니다.
  • name를 가져올 메시지의 리소스 이름으로 설정합니다.

다음 예에서는 앱 인증이 포함된 메시지를 가져옵니다.

Python

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

    from google.oauth2 import service_account
    from apiclient.discovery import build
    
    # Specify required scopes.
    SCOPES = ['https://www.googleapis.com/auth/chat.bot']
    
    # Specify service account details.
    CREDENTIALS = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )
    
    # Build the URI and authenticate with the service account.
    chat = build('chat', 'v1', credentials=CREDENTIALS)
    
    # Get a Chat message.
    result = chat.spaces().messages().get(
    
        # The message to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name='spaces/SPACE/messages/MESSAGE'
    
      ).execute()
    
    # Print Chat API's response in your command line interface.
    print(result)
    
  3. 코드에서 다음을 바꿉니다.

    • SPACE: 메시지가 게시된 스페이스의 name로, Chat API의 spaces.list 메서드 또는 스페이스의 URL에서 가져올 수 있습니다.

    • MESSAGE: 메시지 이름으로, Chat API를 사용하여 메시지를 비동기식으로 만들거나 생성 시 메시지에 할당된 커스텀 이름을 사용하여 메시지를 만든 후 반환된 응답 본문에서 가져올 수 있습니다.

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

    python3 chat_get_message_app.py
    

Chat API는 지정된 메시지를 자세히 설명하는 Message 인스턴스를 반환합니다.