Method: users.settings.filters.get
HTTP 请求
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters/{id}
网址采用 gRPC 转码语法。
路径参数
参数 |
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 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-09-05。
[null,null,["最后更新时间 (UTC):2024-09-05。"],[[["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"]]