Method: spaces.messages.list

string

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

形式: spaces/{space}

integer

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

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

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

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

string

省略可。前回の list messages 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

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

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 エラーでサーバーが拒否します。

string

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

• 昇順の場合は ASC。

• DESC: 降順。

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

boolean

省略可。削除されたメールを含めるかどうか。削除されたメールには、削除日時と削除に関するメタデータが含まれますが、メールの内容は利用できません。