Method: users.labels.list

ユーザーのメールボックス内のすべてのラベルを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレスです。認証されたユーザーを示すには、特別な値 me を使用できます。

リクエストの本文

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

レスポンスの本文

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

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

object (Label)

ラベルのリスト。各ラベルリソースには、id、name、messageListVisibility、labelListVisibility、type のみが含まれます。labels.get メソッドは、ラベルの詳細を取得できます。

認可スコープ

以下のいずれかの 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.labels
  • https://www.googleapis.com/auth/gmail.metadata

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