向请求授权
当您的应用请求不公开的数据时,该请求必须经过有权访问相应数据并且已经过身份验证的用户授权。
您的应用向 Indexing API 发出的每个请求都必须包含授权令牌。Google 也可通过此令牌识别您的应用。
关于授权协议
您的应用必须使用 OAuth 2.0 向请求授权,其他任何授权协议均不受支持。如果您的应用使用使用 Google 账号登录,系统会代您执行授权方面的某些操作。
使用 OAuth 2.0 向请求授权
向 Indexing API 发出的所有请求均须由经过身份验证的用户授权。
根据您所编写的应用的类型,OAuth 2.0 的具体授权流程可能会有所不同。下面是适用于所有应用类型的大致流程:
- 开发应用时,您需要使用 Google API 控制台注册该应用。然后,Google 会提供您稍后需要用到的信息,例如客户端 ID 和客户端密钥。
- 在 Google API 控制台中激活 Indexing API。(如果 API 控制台中未列出该 API,请跳过这一步。)
- 当您的应用需要访问用户数据时,它会请求 Google 提供特定范围的访问权限。
- Google 会向相应用户显示权限请求页面,让用户授权您的应用请求他们的某些数据。
- 待该用户同意后,Google 会为您的应用提供一个时效很短的访问令牌。
- 您的应用会请求获取用户数据,并在请求中附上该访问令牌。
- 如果 Google 确定您的请求及令牌有效,就会返回您所请求的数据。
有些流程还包含其他步骤,例如使用刷新令牌获取新的访问令牌。如需详细了解适用于各类应用的不同流程,请参阅 Google 的 OAuth 2.0 文档。
以下是 Indexing API 的 OAuth 2.0 授权范围信息:
范围 |
含义 |
https://www.googleapis.com/auth/indexing |
读取/写入权限。 |
要通过 OAuth 2.0 请求访问权限,您的应用既需要授权范围信息,也需要 Google 在您注册应用时提供的信息(如客户端 ID 和客户端密钥)。
提示:Google API 客户端库可帮您处理部分授权流程,并且支持多种编程语言;有关详情,请参阅库和示例页面。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-02-17。
[null,null,["最后更新时间 (UTC):2025-02-17。"],[[["The Indexing API requires authorization for all requests using OAuth 2.0 for accessing private user data."],["Applications need to be registered with Google API Console and the Indexing API activated to initiate the authorization process."],["Users are presented with a consent screen to grant access, and upon approval, the application receives a short-lived access token to make authorized requests."],["Google's client libraries offer built-in support for handling parts of the authorization, simplifying the process for developers."]]],["Applications must use OAuth 2.0 to authorize requests for private data from the Indexing API. This requires registering the application with the Google API Console to obtain a client ID and secret. The application requests a specific access scope from Google, which then prompts the user for consent. Upon approval, Google issues a short-lived access token. This token is attached to data requests, and Google validates it before providing the requested data. The scope for the Indexing API is `https://www.googleapis.com/auth/indexing` for read/write access.\n"]]