Google Chat 스페이스의 일정 나열하기

이 가이드에서는 Google Chat API의 SpaceEvent 리소스에서 list 메서드를 사용하여 스페이스의 리소스 변경사항을 나열하는 방법을 설명합니다.

SpaceEvent 리소스는 메시지, 반응, 멤버십과 같은 스페이스의 하위 리소스를 포함하여 대상 공간의 변경사항을 나타냅니다. 지원되는 이벤트 유형 및 이벤트 페이로드 목록에 대한 자세한 내용은 SpaceEvent 리소스 참조 문서의 eventType 및 payload 필드를 확인하세요.

요청 시간으로부터 최대 28일 전에 이벤트를 나열할 수 있습니다. 서버는 영향을 받은 리소스의 최신 버전이 포함된 이벤트를 반환합니다. 예를 들어 새로운 스페이스 멤버에 관한 이벤트를 나열하면 서버는 최신 멤버십 세부정보가 포함된 Membership 리소스를 반환합니다. 요청된 기간 동안 새 구성원이 삭제된 경우 이벤트 페이로드에 빈 Membership 리소스가 포함됩니다.

이 메서드를 호출하려면 사용자 인증을 사용해야 합니다. 스페이스의 이벤트를 나열하려면 인증된 사용자가 스페이스의 참여자여야 합니다.

기본 요건

Python

  • Python 3.6 이상
  • pip 패키지 관리 도구

  • 최신 Python용 Google 클라이언트 라이브러리입니다. 이를 설치하거나 업데이트하려면 명령줄 인터페이스에서 다음 명령어를 실행합니다.

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Google Chat API가 사용 설정 및 구성된 Google Cloud 프로젝트 단계는 Google Chat 앱 빌드를 참고하세요.

  • 채팅 앱에 구성된 승인입니다. SpaceEvent 리소스를 나열하면 다음 인증 방법이 지원됩니다.

스페이스 이벤트 나열

Chat 스페이스의 스페이스 일정을 나열하려면 다음 단계를 따르세요.

  • SpaceEvent 리소스에서 list 메서드를 호출합니다.
  • filter 필드를 사용하여 나열할 이벤트 유형을 지정합니다. 이벤트 유형을 하나 이상 지정해야 하며 날짜별로 필터링할 수도 있습니다. 지원되는 이벤트 유형 목록은 eventType 필드를 참고하세요.
  • 사용자 인증을 사용하면 요청의 각 이벤트 유형을 지원하는 하나 이상의 승인 범위를 지정합니다. 앱이 작동할 수 있는 가장 제한적인 범위를 선택하는 것이 좋습니다. 범위를 선택하려면 인증 및 승인 개요를 참조하세요.

다음 코드 샘플에서는 스페이스의 새 멤버십 및 메시지에 대한 이벤트를 나열합니다.

Python

  1. 작업 디렉터리에서 chat_space_event_list.py라는 파일을 만듭니다.

  2. chat_space_event_list.py에 다음 코드를 포함합니다.

    """Lists SpaceEvent resources from the Chat API."""

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.memberships.readonly",
"https://www.googleapis.com/auth/chat.messages.readonly"]

# 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().spaceEvents().list(

    # The space from which to list events.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE',

    # A required filter. Filters and returns events about new memberships and messages
    filter='event_types:"google.workspace.chat.membership.v1.created" OR event_types:"google.workspace.chat.message.v1.created"'

).execute()

# Prints details about the created space events.
print(result)

  3. 코드에서 다음을 바꿉니다.

    • SPACE: Chat API의 spaces.list 메서드 또는 스페이스 URL에서 가져올 수 있는 스페이스 이름입니다.

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

    python3 chat_space_event_list.py

Chat API는 새 멤버십 및 메시지에 대한 SpaceEvent 리소스 이벤트 목록을 반환합니다.

페이지로 나누기 맞춤설정

필요한 경우 다음 쿼리 매개변수를 전달하여 페이지로 나누기를 맞춤설정합니다.

  • pageSize: 반환할 SpaceEvent 리소스의 최대 개수입니다. 서비스가 이 값보다 적게 반환할 수 있습니다. 음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
  • pageToken: 이전 목록 공간 이벤트 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 토큰을 제공하세요. 페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.