Google Chat スペースのイベントを一覧表示します。各イベントのpayloadには、Chat リソースの最新バージョンが含まれます。たとえば、スペースの新しいメンバーに関するイベントを一覧表示すると、サーバーは最新のメンバーの詳細を含む Membership
リソースを返します。リクエストした期間中に新しいメンバーが削除された場合、イベント ペイロードには空の Membership
リソースが含まれます。
ユーザー認証が必要です。予定を一覧表示するには、認証済みのユーザーがスペースのメンバーである必要があります。
例については、Google Chat スペースのイベントを一覧表示するをご覧ください。
HTTP リクエスト
GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。イベントが発生した Google Chat スペースのリソース名。 フォーマット: |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
省略可。返されるスペース イベントの最大数。サービスはこの値よりも少ない数を返す場合があります。 負の値を指定すると |
pageToken |
前のリストスペース イベント呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。 ページ分割の際には、スペース イベントを一覧表示するために指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
必須。クエリフィルタ。 has 必要に応じて、開始時間(
開始時間または終了時間を指定するには、等価 たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
スペースのイベントを一覧表示するレスポンス メッセージです。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"spaceEvents": [
{
object ( |
フィールド | |
---|---|
spaceEvents[] |
結果は時系列(古いイベントから)で返されます。 |
nextPageToken |
追加のイベントを取得するために使用される継続トークン。このフィールドを省略すると、後続のページはなくなります。 |
承認スコープ
次の 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
詳しくは、承認ガイドをご覧ください。