Method: spaces.spaceEvents.list

Google Chat スペースのイベントを一覧表示します。各イベントのpayloadには、Chat リソースの最新バージョンが含まれます。たとえば、スペースの新しいメンバーに関するイベントを一覧表示すると、サーバーは最新のメンバーシップ情報を含む Membership リソースを返します。リクエストされた期間中に新しいメンバーが削除された場合、イベント ペイロードには空の Membership リソースが含まれます。

ユーザー認証が必要です。イベントを一覧表示するには、認証済みのユーザーがスペースのメンバーである必要があります。

例については、Google Chat スペースのイベントを一覧表示するをご覧ください。

HTTP リクエスト

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。イベントが発生した Google Chat スペースのリソース名。

形式: spaces/{space}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるスペース イベントの最大数。サービスはこの値よりも少ない値を返すことがあります。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
pageToken

string

前回のリストスペース イベント呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、スペース イベントをリストするために指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter

string

必須。クエリフィルタ。

has : 演算子を使用して、少なくとも 1 つのイベントタイプ（eventType）を指定する必要があります。複数のイベントタイプでフィルタするには、OR 演算子を使用します。フィルタではバッチイベントタイプを省略します。このリクエストにより、関連するバッチイベントが自動的に返されます。たとえば、新しいリアクション（google.workspace.chat.reaction.v1.created）でフィルタすると、サーバーはバッチ新規リアクション イベント（google.workspace.chat.reaction.v1.batchCreated）も返します。サポートされているイベントタイプの一覧については、SpaceEvents リファレンス ドキュメントをご覧ください。

必要に応じて、開始時間（startTime）と終了時間（endTime）でフィルタすることもできます。

  • startTime: スペース イベントの一覧表示を開始する排他的なタイムスタンプ。過去 28 日前までのイベントを一覧表示できます。指定しない場合、過去 28 日間のスペース イベントが一覧表示されます。
  • endTime: スペース イベントを一覧表示するまでの包括的なタイムスタンプ。指定しない場合は、リクエスト時点までのイベントが一覧表示されます。

開始時間または終了時間を指定するには、等号 = 演算子を使用し、RFC-3339 の形式を使用します。startTime と endTime の両方でフィルタするには、AND 演算子を使用します。

たとえば、次のクエリは有効です。

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

次のクエリは無効です。

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

スペース イベントの一覧表示に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
フィールド
spaceEvents[]

object (SpaceEvent)

結果は時系列で返されます（古いイベントが先）。
nextPageToken

string

より多くのイベントを取得するために使用される継続トークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳細については、承認ガイドをご覧ください。