设置 API
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
您的应用向 Postmaster Tools API 发送的每个请求都必须包含授权令牌。Google 也可通过此令牌来识别您的应用。
关于授权协议
您的应用必须使用 OAuth 2.0 向请求授权，其他任何授权协议均不受支持。如果您的应用使用使用 Google 账号登录，系统会代您执行授权方面的某些操作。
使用 OAuth 2.0 向请求授权
向 Postmaster Tools API 发出的所有请求均须由已通过身份验证的用户授权。
根据您所开发的应用的类型，OAuth 2.0 的具体授权流程可能会有所不同。下面是适用于所有应用类型的大致流程：
- 开发应用时，您需要使用 Google API 控制台注册该应用。然后，Google 会提供您稍后需要用到的信息，例如客户端 ID 和客户端密钥。
- 在 Google API 控制台中激活 Postmaster Tools API。（如果 API 控制台中未列出该 API，请跳过这一步。）
- 当您的应用需要访问用户数据时，它会请求 Google 提供特定范围的访问权限。
- Google 会向相应用户显示权限请求页面，让用户授权您的应用请求他们的某些数据。
- 待该用户同意后，Google 会为您的应用提供一个时效很短的访问令牌。
- 您的应用会请求获取用户数据，并在请求中附上该访问令牌。
- 如果 Google 确定您的请求及令牌有效，就会返回您所请求的数据。
有些流程还包含其他步骤，例如使用刷新令牌获取新的访问令牌。如需详细了解适用于各类应用的不同流程，请参阅 Google 的 OAuth 2.0 文档。
以下是 Postmaster Tools API 的 OAuth 2.0 范围信息：
| 范围 |
含义 |
https://www.googleapis.com/auth/postmaster.readonly |
允许对 Postmaster Tools 数据进行只读访问。 |
要通过 OAuth 2.0 请求访问权限，您的应用既需要授权范围信息，也需要 Google 在您注册应用时提供的信息（如客户端 ID 和客户端密钥）。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2025-08-29。
[null,null,["最后更新时间 (UTC)：2025-08-29。"],[],[],null,["# Set up the API\n\nEvery request your application sends to the Postmaster Tools API must include an authorization token. The token also identifies your application to Google.\n\nAbout authorization protocols\n-----------------------------\n\nYour application must use [OAuth 2.0](https://developers.google.com/identity/protocols/OAuth2) to authorize requests. No other authorization protocols are supported. If your application uses [Sign In With Google](https://developers.google.com/identity/gsi/web), some aspects of authorization are handled for you.\n\nAuthorizing requests with OAuth 2.0\n-----------------------------------\n\nAll requests to the Postmaster Tools API must be authorized by an authenticated user.\n\nThe details of the authorization process, or \"flow,\" for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:\n\n1. When you create your application, you register it using the [Google API Console](https://console.cloud.google.com/). Google then provides information you'll need later, such as a client ID and a client secret.\n2. Activate the Postmaster Tools API in the Google API Console. (If the API isn't listed in the API Console, then skip this step.)\n3. When your application needs access to user data, it asks Google for a particular **scope** of access.\n4. Google displays a **consent screen** to the user, asking them to authorize your application to request some of their data.\n5. If the user approves, then Google gives your application a short-lived **access token**.\n6. Your application requests user data, attaching the access token to the request.\n7. If Google determines that your request and the token are valid, it returns the requested data.\n\nSome flows include additional steps, such as using **refresh tokens** to acquire new access tokens. For detailed information about flows for various types of applications, see Google's [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n\nHere's the OAuth 2.0 scope information for the Postmaster Tools API:\n\n| Scope | Meaning |\n|-------------------------------------------------------|---------------------------------------------------|\n| `https://www.googleapis.com/auth/postmaster.readonly` | Allows read-only access to Postmaster Tools data. |\n\nTo request access using OAuth 2.0, your application needs the scope information, as well as\ninformation that Google supplies when you register your application (such as the client ID and the\nclient secret)."]]
