OAuth 桌面和 Web 应用流程

本指南介绍了如何使用您自己的凭据以及桌面流程网页流程设置 OAuth2 以进行 API 访问。这些步骤只需执行一次,除非您撤消、删除 OAuth2 凭据或需要更改 OAuth2 凭据的允许范围。

创建 OAuth2 凭据

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

  2. 下载客户端的 JSON 文件,具体方法是首先点击客户端的下载 OAuth 客户端图标,然后在接下来显示的屏幕上点击下载 JSON 按钮。

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

设置客户端库

  1. 在终端中,运行 GenerateUserCredentials 示例。使用命令行标志向其传递您在上一步中下载的 JSON 文件。

    使用 Gradle 从命令行运行

    ./gradlew --console=plain --quiet runExample \
      --example="authentication.GenerateUserCredentials \
      --oAuthClientFile ${HOME}/client_secret_XXX.apps.googleusercontent.com.json"
    
  2. 该示例将提示您访问一个网址,您需要允许 OAuth2 凭据代表您访问您的 Google Ads 帐号。

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

    在无痕浏览器会话或无痕式窗口中访问该网址。 通过您访问 Google Ads 时所用的 Google 帐号登录。点击 OAuth2 同意屏幕上的继续

    意见征求屏幕

  3. 您将转到一个页面,其中显示一条表明授权成功的消息。

    已成功检索到授权代码。

    查看 GenerateUserCredentials 的控制台输出,获取进一步说明。

  4. 返回您运行示例的控制台。您将看到该示例已完成,并显示您的刷新令牌和一些说明,以及配置客户端库所需的属性:

    #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=........................
    
  5. 将日期注释 # 到输出末尾的几行内容复制到 ads.properties 文件中。

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

    为最简单的设置,请将 ads.properties 文件放在主目录中。