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
詳細については、承認ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-09-05 UTC。
[null,null,["最終更新日 2024-09-05 UTC。"],[[["Lists all labels in a user's mailbox, providing details like ID, name, and visibility."],["Requires an HTTP GET request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/labels`, replacing `{userId}` with the user's email address or `me`."],["The response body includes a list of labels, each containing basic information; use `labels.get` for detailed label data."],["Requires authorization with specific OAuth scopes, such as `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.readonly`."]]],[]]