如果您尚未完成一些准备工作,请先完成,然后才能开始编写您的第一个客户端应用。
创建 Google 账号并获取 Search Ads 360 权限
若要使用 Search Ads 360 API,您需要拥有 Google 账号,并已向该账号授予 Search Ads 360 中的适当权限:
如果您还没有 Google 账号,请 创建一个。
让 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 凭据
- 启动 Google API 控制台
设置工具。
设置工具会引导您完成创建项目(或使用现有项目)、启用 Search Ads 360 API 和创建 OAuth 2.0 凭据的流程。 - 在注册应用页面上,选择一个现有项目或选择创建项目。然后点击继续。
- 在 Google API 控制台启用 Search Ads 360 API 后,点击转到凭据按钮。
- 在创建凭据页面上,输入以下信息:
- 您使用的是哪个 API?:Search Ads 360 API
- 您要访问哪些数据?:用户数据
- 点击下一步按钮。
设置工具现在可帮助您创建 OAuth 2.0 客户端 ID。
- 按照设置工具中的其余步骤操作。
安装 sa360Api.py
Search Ads 360 提供了一个实用程序脚本,以简化授权设置流程。如果您想在设计和编写完整应用之前尝试发送和接收数据,也可以使用此脚本以 JSON 格式发送和接收数据。您可以复制本文档网站中的多个 JSON 示例,并将它们直接输入到脚本中。
如需安装该脚本,请执行以下操作:
- 安装 Python 2.7。
该脚本不适用于 Python 3.x。 - 安装 c网址。
- 下载 sa360Api.zip。
- 从
sa360Api.zip
中提取sa360Api.py
。 - 将
sa360Api.py
设为可执行文件。
了解 REST 基础知识
您可以通过以下两种方式调用 Admin API:
- 使用客户端库。
- 发送 HTTP 请求并解析响应。
如果您决定不使用客户端库,则需要了解 REST 的基础知识。
REST 是一种软件架构样式,可提供便利、一致的方法来请求和修改数据。
术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。
在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。
在 Google 的 RESTful API 中,客户端使用 HTTP 谓词(例如 POST
、GET
、PUT
或 DELETE
)指定操作。它通过以下格式的全局唯一 URI 来指定资源:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。
您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GET
、POST
、PUT
和 DELETE
的规范。
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。