Method: spaces.messages.list

string

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

形式: spaces/{space}

integer

返されるメッセージの最大数。サービスは、この値よりも少ないメッセージを返す可能性があります。

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

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

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

string

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

以前のメッセージ リスト呼び出しで受け取ったページトークン。このパラメータを指定して、後続のページを取得します。

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

string

クエリフィルタ。

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

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

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

string

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

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

• 昇順の場合は ASC。

• DESC: 降順

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

boolean

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