Method: spaces.messages.list

発信者がメンバーになっているスペース内のメッセージ（ブロックされたメンバーとスペースからのメッセージを含む）を一覧表示します。例については、メッセージのリスト表示をご覧ください。ユーザー認証が必要です。

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）でフィルタできます。

メッセージの作成日でフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して createTime を指定します。例: "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

詳しくは、認可ガイドをご覧ください。