为 Google Ads API 配置 Google API 控制台项目

要对 Google Ads 用户进行身份验证和授权,您就必须提供用于访问 Google OAuth2 服务器的凭据。这些凭据会向 Google 标识您的应用,让您能够生成用于管理 Google Ads 用户的 OAuth 令牌。通过 Google API 控制台,您可以对 Google OAuth2 凭据的访问权限进行管理。

观看此视频,了解一些 Cloud 项目最佳实践

Google OAuth 验证

任何用于获取 Google Ads API 范围凭据的 Google Cloud 应用都需要通过 Google OAuth 验证,以免其用户看到未经验证的界面屏幕。在此上下文中,应用定义为 Google Cloud 中唯一的 OAuth 2.0 客户端 ID。

除了在开发者令牌审批流程中执行的所有审核外,此验证是独立的,也是必须进行的,因为 Google Ads API 范围属于敏感范围

Google 验证无需任何费用,通常在 3 到 5 个工作日内完成。此政策适用于所有应用。

我们建议所有应用尽快完成 Google OAuth 验证流程,以免业务中断。

创建项目

前往 Google API 控制台。点击创建项目,输入名称,然后点击创建

在项目中启用 Google Ads API

要为您的项目启用 Google Ads API,请按以下步骤操作:

  1. 在 Google API 控制台中打开 API 库。如果系统提示,请选择您的项目或创建一个新项目。API 库中列出了所有可用的 API(按产品系列和热门程度分组)。

  2. 如果列表中没有显示 Google Ads API,请使用搜索功能找到该 API。

  3. 选择 Google Ads API,然后点击启用按钮。

选择用户类型和发布状态

启用该 API 后,您必须指定项目的用户类型发布状态。下表重点介绍了这些设置的每个组合的一些关键属性和限制。如需了解详情,请参阅 Google Cloud Platform 文档

用户类型 发布状态 限制
内部 测试
  • 仅适用于与 Google Cloud 组织关联的项目。
  • OAuth 同意屏幕中列出的测试用户不得超过 100 名。
  • 测试用户必须是与项目关联的 Google Cloud 组织中的内部用户。
  • 授权将在自同意之日起 7 天后过期。
外部 测试
  • 适用于所有项目。
  • OAuth 同意屏幕中列出的测试用户不得超过 100 名。
  • 测试用户可以是拥有 Google 账号的任何用户。
  • 授权将在自同意之日起 7 天后过期。
内部 正式版
  • 仅适用于与 Google Cloud 组织关联的项目。
  • 允许向与项目关联的 Google Cloud 组织中的任何用户授权。
外部 正式版
  • 适用于所有项目。
  • 允许向拥有 Google 账号的任何用户授权。

无论项目的用户类型发布状态如何,未完成 Google OAuth 验证都会导致以下情况:

  1. 打开“同意屏幕”页面,然后在页面顶部的下拉菜单中选择您的项目。

  2. 选择用户类型,然后点击创建

  3. 填写同意屏幕表单。如有需要,您以后还可修改此字段。完成后,点击保存并继续

  4. 在下一页上,点击添加或移除范围

    • 向下滚动,然后在手动添加范围下的字段中输入以下内容:

      https://www.googleapis.com/auth/adwords
      
    • 点击添加到表格

    • 添加您的项目将请求的任何其他范围,然后点击更新

    • 点击保存并继续

  5. 如果您不打算立即发布项目,请添加您要用于测试的每个用户帐号的电子邮件地址,然后点击保存并继续

  6. 查看摘要页面,然后点击返回信息中心

测试应用和授权流程后,您可以返回信息中心,然后点击发布应用,将其发布状态测试更改为正式版

选择应用类型

Google Ads API 有两个应用类型选项:“桌面设备”或“网站”。请参阅下表,确定哪种类型最适合您要构建的应用:

选择此应用类型 如果...
桌面应用
  • 您正在使用一个顶级经理帐号管理所有 Google Ads 帐号。
  • 您是首次使用的用户,或者想要使用最简单的设置快速上手。
  • 您的应用只会在一台机器上对 Google 用户进行身份验证。
Web 应用
  • 您想以能够授权您的应用访问其 Google Ads 账号数据的用户身份进行身份验证。
  • 您希望轻松生成多个授权凭据,以便管理(比如)第三方账号。
  • 您的应用需要回调网址。桌面应用流程不支持回调网址。

如需了解详情,请参阅有关桌面应用Web 应用的 Google Identity Platform OAuth 文档。

创建客户端 ID 和客户端密钥

确定应用类型后,请按照以下说明生成 OAuth2 客户端 ID 和客户端密钥:

  1. 打开“凭据”页面。 选择之前创建的项目或创建新项目。

  2. 在“凭据”屏幕上,点击创建凭据,然后选择 OAuth 客户端 ID

    1. 如果您以前没有为此项目配置 OAuth 同意屏幕,系统会引导您立即执行此操作。点击配置同意屏幕

      1. 选择用户类型,然后点击创建

      2. 填写初始表单。如有需要,您以后还可修改此字段。完成后,点击保存

    2. 导航回凭据 > 创建凭据 > OAuth 客户端 ID 以继续操作。

  3. 选择桌面应用 Web 应用作为应用类型,具体取决于您的用例。

  4. 为其命名,然后点击创建

  5. 如果您的客户端类型是 Web 应用,请至少添加一个已获授权的重定向 URI。

    对于与客户端库示例中的默认配置兼容的本地测试,请使用 http://127.0.0.1

    对于桌面应用客户端,您将仍然使用环回 IP 重定向,但 Cloud 控制台中未明确配置 URI。

  6. 在确认页面上,将您的客户端 ID您的客户端密钥复制到剪贴板,您在配置客户端库时需要用到这些信息。您也可以稍后返回凭据页面检索这些详细信息。