您的第一个应用:前提条件

在开始编写您的首个客户端应用之前,您需要做一些准备工作(如果您还没有这样做)。

创建 Google 帐号并获取 Search Ads 360 权限

要使用 Search Ads 360 API,您需要拥有一个 Google 帐号,并通过 Search Ads 360 向该帐号授予适当的权限:

  1. 如果您还没有 Google 帐号,请创建一个

  2. 让 Search Ads 360 代理机构管理员为您的 Google 帐号创建 Search Ads 360 用户

    如需下载报表,您需要对要处理的广告客户拥有查看权限

    要添加或修改转化数据,您需要对要合作的广告客户拥有修改权限。在共享 Floodlight 配置中,您需要拥有每个要向其上传转化数据的子级广告客户的修改权限。 您无需访问父级广告客户,也无需访问不会向其上传转化数据的子级广告客户。如果您使用点击 ID 将转化归因于访问,请确保您对生成了点击 ID 的广告客户拥有修改权限。如果您指定的点击 ID 来自您无权修改的广告客户,该请求不会成功。

    代理机构管理员可将您的帐号设置为有权访问特定广告客户的广告客户用户,或者为您的帐号设置更高级别的访问权限,例如对代理机构中的所有广告客户拥有访问权限的代理机构用户

启用 API 转化服务

如果您想要上传转化数据,那么拥有代理机构管理员权限的 Search Ads 360 用户需要登录 Search Ads 360 界面,并启用 API 转化服务。如需了解相关说明,请参阅 Search Ads 360 帮助中心

为您的客户端创建 Google API 控制台项目和 OAuth 凭据

  1. 启动 Google API 控制台设置工具
    该设置工具会指导您创建项目(或使用现有项目)、启用 Search Ads 360 API 以及创建 OAuth 2.0 凭据。
  2. 注册应用页面上,选择一个现有项目或选择创建项目。然后点击继续
  3. 在 Google API 控制台启用 Search Ads 360 API 后,点击转到凭据按钮。
  4. 创建凭据页面上,输入以下信息:
    • 您使用的是哪个 API?:Search Ads 360 API
    • 您要访问哪些数据?:用户数据
  5. 点击下一步按钮。

    设置工具现在可帮助您创建 OAuth 2.0 客户端 ID

  6. 按照设置工具中的其余步骤操作。

安装 sa360Api.py

Search Ads 360 提供了实用工具脚本,可协助您设置授权。在设计和编写完整应用之前,如果您想尝试发送和接收数据,也可以使用此脚本发送和接收 JSON 格式的数据。您可以复制本文档网站中的许多 JSON 示例,并将其直接输入脚本。

如需安装该脚本,请执行以下操作:

  1. 安装 Python 2.7。
    该脚本不适用于 Python 3.x。
  2. 安装 c网址
  3. 下载 sa360Api.zip
  4. sa360Api.zip 中提取 sa360Api.py
  5. sa360Api.py 设为可执行文件。

了解 REST 基础知识

您可以通过以下两种方式调用 Admin API:

  • 使用客户端库
  • 发送 HTTP 请求并解析响应。

如果您决定不使用客户端库,则需要了解 REST 的基础知识。

REST 是一种软件架构样式,可提供便捷且一致的方法用于请求和修改数据。

术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。

在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。

在 Google 的 REST API 中,客户端会使用 HTTP 动词(如 POSTGETPUTDELETE)指定操作。它通过以下形式的全局唯一 URI 指定资源:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。

您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GETPOSTPUTDELETE 的规范。

Search Ads 360 API 中的 REST

Search Ads 360 API 操作会直接映射到 REST HTTP 动词。

Search Ads 360 API URI 的具体格式为:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

API 参考文档中总结了用于 API 中每种受支持的操作的全部 URI。

了解 JSON 基础知识

如果您使用 REST,则需要为请求正文使用 JSON 格式。您可以指定响应采用 JSON 或 CSV 格式。

JSON(JavaScript 对象表示法)是一种与语言无关的常见数据格式,可通过简单的文本来表示任意数据结构。如需了解详情,请参阅 json.org