Authentication

所有 Google Ad Manager API 调用都必须通过 OAuth2 进行授权,OAuth2 是一种开放标准,允许用户向第三方应用授予权限,以便应用可以代表用户与 Web 服务进行交互。OAuth2 可让您的 Ad Manager API 客户端应用访问用户的 Ad Manager 账号,而无需处理或存储用户的用户名或密码。

生成 OAuth2 凭据

执行以下步骤以生成 OAuth2 凭证。

1. 确定身份验证类型

请查看下表,了解哪种身份验证类型最适合您的 Ad Manager API 应用:

选择 OAuth2 身份验证类型
服务账号

如果您只需要访问自己的 Ad Manager 数据,请选择此选项。

了解详情。
Web 应用

如果您想以任何向您的应用授予 Ad Manager 数据访问权限的用户身份进行身份验证,请选择此选项。

了解详情。

2. 创建 OAuth2 凭证

确定身份验证类型后,点击下面的相应标签页,然后按照说明生成 OAuth2 凭证:

服务账号
  1. 打开 Google API 控制台的“凭据”页面。
  2. 从项目下拉列表中,选择创建新项目,输入项目名称,并视需要修改提供的项目 ID。点击创建。
  3. 在“凭证”页面上,选择创建凭证,然后选择服务账号密钥。
  4. 选择新建服务账号,然后选择 JSON。
  5. 点击创建,下载包含私钥的文件。
Web 应用
  1. 打开 Google API 控制台的“凭据”页面。
  2. 从项目下拉菜单中,选择创建新项目,输入项目名称(并视需要修改提供的项目 ID),然后点击创建。
  3. 在“凭据”页面上,选择创建凭据,然后选择 OAuth 客户端 ID。
  4. 系统可能会提示您在“权限请求页面”页面上设置产品名称;如果是这样,请点击配置权限请求页面,提供所需信息,然后点击保存以返回到“凭据”页面。
  5. 选择 Web 应用作为应用类型。按照说明输入 JavaScript 来源和/或重定向 URI。
  6. 点击创建。
  7. 在显示的页面上,将客户端 ID 和客户端密钥复制到剪贴板,因为您在配置客户端库时需要用到它们。
有关客户端 ID 和客户端密钥的屏幕截图

3. 配置您的 Ad Manager 广告资源网

如果您是第三方开发者,则可能需要让客户为您执行此步骤。

服务账号
  1. 前往您的 Ad Manager 广告资源网。
  2. 点击管理标签。
  3. 确保已启用 API 访问权限。
  4. 点击添加服务账号用户按钮。
  5. 使用服务账号邮箱填写表单。必须向服务账号用户授予访问实体的权限,就像该服务账号用户在界面上访问实体一样。
  6. 点击保存按钮。系统应该会显示一条消息,确认已添加您的服务账号。
  7. 如需查看现有服务账号用户,请前往“用户”标签页,然后点击服务账号过滤条件。

4. 配置和使用客户端库

请按照以下相应指南在客户端库中使用凭据:

如果您选择不使用我们的客户端库,则需要自行实现 OAuth2 服务账号或 Web 应用流程。

幕后花絮

我们的客户端库会自动处理下文所述的细节,因此,只有在您对幕后故事感兴趣时,才需要继续阅读。本部分面向已熟悉 OAuth2 规范并了解如何将 OAuth2 与 Google API 搭配使用的高级用户。

HTTP 请求标头

向 Ad Manager API 发出的每个请求中的 HTTP 标头都必须包含以下形式的访问令牌:

Authorization: Bearer ACCESS_TOKEN

例如:

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
…
</soap:Envelope>

范围

单个访问令牌可以授予对多个 API 的不同程度的访问权限。名为 scope 的变量参数控制访问令牌允许的一组资源和操作。在访问令牌请求期间,您的应用会在 scope 参数中发送一个或多个值。

Ad Manager 只有一个范围,如下所示。授权应在产品内的用户级别执行。

范围 权限
https://www.googleapis.com/auth/admanager 在 Ad Manager 中查看和管理您的广告系列。