Method: users.settings.filters.list

Gmail ユーザーのメールフィルタを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレス。特別な値「me」を使用して、認証済みユーザーを指定できます。

リクエストの本文

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

レスポンスの本文

filters.list メソッドのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "filter": [
    {
      object (Filter)
    }
  ]
}
フィールド
filter[]

object (Filter)

ユーザーのフィルタのリスト。

認可スコープ

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

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

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