Method: users.settings.filters.get
HTTP リクエスト
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters/{id}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ |
userId |
string
ユーザーのメールアドレス。特別な値「me」を使用して、認証済みユーザーを示すことができます。
|
id |
string
取得するフィルタの ID。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功した場合、レスポンスの本文には 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
詳細については、承認ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-09-05 UTC。
[null,null,["最終更新日 2024-09-05 UTC。"],[[["Retrieves a specific Gmail filter using the filter ID and user's email address."],["Requires authorization with specific OAuth scopes for accessing and modifying Gmail settings."],["The request body should be empty, and a successful response provides the filter details."],["Employs gRPC Transcoding syntax for constructing the HTTP request URL."]]],["This document outlines how to retrieve a specific filter using a GET request. The request URL is structured as `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters/{id}`, using the `userId` (e.g., \"me\" for the current user) and the filter's `id` as path parameters. The request body must be empty. A successful request returns a `Filter` instance in the response body. This action requires specific authorization scopes, such as `gmail.settings.basic`, `mail.google.com`, `gmail.modify`, or `gmail.readonly`.\n"]]
