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 messages 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

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

string

省略可。クエリフィルタ。

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

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

スレッドでフィルタするには、spaces/{space}/threads/{thread} 形式の thread.name を指定します。1 つのクエリで指定できる 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

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