Method: spaces.messages.list

発信者がメンバーになっているスペース内のメッセージ（ブロック中のメンバーとスペースからのメッセージを含む）を一覧表示します。メッセージがないスペースからのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト {} が含まれます。例については、メッセージを一覧表示するをご覧ください。ユーザー認証が必要です。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。メッセージを一覧表示するスペースのリソース名。

形式: spaces/{space}

クエリ パラメータ

パラメータ
pageSize

integer

返されるメッセージの最大数。サービスから返されるメッセージはこの値よりも少ないことがあります。

指定しない場合は、最大で 25 個が返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。

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

string

前のクエリから再開する場合は省略可。

前回の list メッセージ呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。

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

string

クエリフィルタ。

日付（createTime）やスレッド（thread.name）でメッセージをフィルタできます。

作成日でメッセージをフィルタするには、createTime に RFC-3339 形式のタイムスタンプと二重引用符を指定します。例: "2023-04-21T11:30:00-04:00"。大なり演算子（>）を使用すると、タイムスタンプより後に作成されたメッセージを一覧表示できます。また、小なり演算子 < を使用すると、タイムスタンプより前に作成されたメッセージを一覧表示できます。時間間隔内のメッセージをフィルタリングするには、2 つのタイムスタンプ間で AND 演算子を使用します。

スレッドでフィルタするには、thread.name を spaces/{space}/threads/{thread} の形式で指定します。thread.name はクエリごとに 1 つだけ指定できます。

スレッドと日付の両方でフィルタするには、クエリで AND 演算子を使用します。

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

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

前のクエリから再開する場合は省略可。

メッセージのリストを並べ替える方法。順序付けオペレーションによって順序付けする値を指定します。有効な順序付けオペレーションの値は次のとおりです。

  • 昇順の場合は ASC。

  • DESC: 降順。

デフォルトの順序は createTime ASC です。
showDeleted

boolean

削除済みのメッセージを含めるかどうかを指定します。削除されたメッセージには、削除日時とその削除に関するメタデータが含まれますが、メッセージのコンテンツは利用できません。

リクエスト本文

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

レスポンスの本文

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

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

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

object (Message)

メッセージのリスト。
nextPageToken

string

トークンを pageToken として送信して、結果の次のページを取得できます。空の場合、後続のページはありません。

認可スコープ

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

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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