Method: users.threads.list

ユーザーのメールボックス内のスレッドを一覧表示します。

HTTP リクエスト

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレス。特別な値 me を使用して、認証済みユーザーを示すことができます。

クエリ パラメータ

パラメータ
maxResults

integer (uint32 format)

返されるスレッドの最大数。このフィールドのデフォルトは 100 です。このフィールドに設定可能な最大値は 500 です。
pageToken

string

リスト内の結果の特定のページを取得するためのページトークン。
q

string

指定されたクエリに一致するスレッドのみを返します。Gmail の検索ボックスと同じクエリ形式をサポートしています。（例: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"）。gmail.metadata スコープを使用して API にアクセスする場合、このパラメータは使用できません。
labelIds[]

string

指定されたすべてのラベル ID に一致するラベルを持つスレッドのみを返します。
includeSpamTrash

boolean

結果に SPAM と TRASH のスレッドを含めます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
フィールド
threads[]

object (Thread)

スレッドのリスト。各スレッド リソースには messages のリストが含まれていません。特定のスレッドの messages のリストは、threads.get メソッドを使用して取得できます。
nextPageToken

string

リスト内の次のページの結果を取得するページトークン。
resultSizeEstimate

integer (uint32 format)

推定結果の合計数。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

詳細については、OAuth 2.0 Overview をご覧ください。