発信者がメンバーであるスペースのメッセージ(ブロックされているメンバーやスペースからのメッセージを含む)が一覧表示されます。例については、メッセージを一覧表示するをご覧ください。ユーザー認証が必要です。
HTTP リクエスト
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。メッセージを一覧表示するスペースのリソース名。 形式: |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
返されるメッセージの最大数。サービスは、この値よりも少ないメッセージを返す可能性があります。 指定されていない場合は、最大で 25 が返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると |
pageToken |
前のクエリから再開する場合は省略可。 以前のメッセージ リスト呼び出しで受け取ったページトークン。このパラメータを指定して、後続のページを取得します。 ページ分割の際に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
クエリフィルタ。 メッセージは日付( 作成日でメッセージをフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して スレッドでフィルタするには、 スレッドと日付の両方でフィルタするには、クエリで たとえば、次のクエリは有効です。
無効なクエリは |
orderBy |
前のクエリから再開する場合は省略可。 メッセージ リストを並べ替える方法。並べ替えオペレーションで並べ替える値を指定します。並べ替えオペレーションの有効な値は次のとおりです。
デフォルトの順序は |
showDeleted |
削除済みのメッセージを含めるかどうか。削除されたメールには、削除日時と削除に関するメタデータが含まれますが、メールのコンテンツは利用できません。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
メッセージを一覧表示するレスポンス メッセージ。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"messages": [
{
object ( |
フィールド | |
---|---|
messages[] |
メッセージのリスト。 |
nextPageToken |
トークンを |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
詳しくは、承認ガイドをご覧ください。