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

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

SpaceEvent 리소스 스페이스의 하위 리소스를 포함하여 대상 스페이스의 변경사항을 나타냅니다. 멤버십과 같은 다양한 유형의 콘텐츠를 공유할 수 있습니다. 자세한 내용은 지원되는 이벤트 유형 및 이벤트 페이로드 목록은 eventType 및 SpaceEvent 리소스의 payload 필드 참조하세요.

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

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

기본 요건

Python

스페이스 이벤트 목록

Chat 스페이스의 스페이스 이벤트를 나열하려면 다음 안내를 따르세요.

  • list 메서드 호출 (SpaceEvent) 리소스를 참고하세요.
  • 다음을 사용하여 나열할 이벤트 유형을 지정합니다. 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: 이전 list space events 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 토큰을 입력합니다. 페이지로 나눌 때 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.