OAuth 桌面和 Web 应用流程

本指南将向您详细介绍如何使用自己的凭据和桌面流程或网站流程设置 OAuth 2.0 以访问 API。除非您撤消、删除或需要更改 OAuth 2.0 凭据的允许范围，否则只需执行一次这些步骤。

创建 OAuth 2.0 凭据

  1. 按照相应步骤为 Google Ads API 配置 Google API 控制台项目。

  2. 如需下载客户端的 JSON 文件，请先点击其 Download OAuth client（下载 OAuth 客户端）图标，然后点击下方屏幕上的 DOWNLOAD JSON（下载 JSON）按钮。

    将文件保存到您的主目录，这样您现在就有了本地文件 ~/client_secret_XXX.apps.googleusercontent.com.json（其中 XXX 是特定于您的项目的值）。我们将在下一步中使用此文件来运行代码示例。

设置客户端库

  1. 在终端中，运行 GenerateUserCredentials 代码示例。使用命令行标志向其传递您下载的 OAuth 2.0 JSON 文件。

    您可以使用以下命令从命令行使用 Gradle 运行代码示例： 
    ./gradlew --console=plain --quiet runExample \
      --example="authentication.GenerateUserCredentials \
      --oAuthClientFile ${HOME}/client_secret_XXX.apps.googleusercontent.com.json"

  2. 此代码示例会提示您访问一个网址，您必须在该网址中授权该应用代表您访问您的 Google Ads 账号。

    Paste this URL in your browser:
https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=****...

    在无痕浏览器会话或无痕式窗口中访问该网址。使用您用于访问 Google Ads 的 Google 账号登录。通常，这是 Google Ads 经理账号的登录电子邮件地址，其中包含您需要在其账号层次结构下管理的所有账号。点击 OAuth 2.0 同意屏幕上的继续。

    OAuth 2.0 权限请求页面

    系统会将您转到一个页面，其中会显示一条消息，指明授权已成功。

    Authorization code was successfully retrieved.

Check the console output from `GenerateUserCredentials` for further instructions.

  3. 返回运行代码示例的控制台。您会看到代码示例已完成，并会显示您的刷新令牌和一些说明，后面是您需要遵循的配置客户端库的说明：

        #Mon Apr 18 09:07:51 EDT 2022
    api.googleads.refreshToken=1/Yw.........................................
    api.googleads.clientId=...........-...............apps.googleusercontent.com
    api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
    api.googleads.clientSecret=........................

  4. 将日期注释 # 到输出末尾的行复制到 ads.properties 文件中。

    将 INSERT_DEVELOPER_TOKEN_HERE 替换为您的开发者令牌。

    如需最简单的设置，请将 ads.properties 文件放在您的主目录中。