本文档适用于希望使用 AdSense Management API 获取有关其 AdSense 帐号的信息的开发者。本文档假定您熟悉 Web 编程概念和 Web 数据格式。
前期准备
创建 AdSense 账号
注册或登录您的 AdSense 账号即可开始使用。
熟悉 AdSense
如果您不熟悉 AdSense 概念,请在开始编码之前阅读 AdSense 简介信息并练习使用 AdSense 界面。
选择客户端库
在客户端库和示例页面中,您可以找到有关可用库和示例的信息。点击所选语言对应的标签页,然后点击相应链接下载源代码。客户端库会为您处理以下工作:
- 身份验证
- 服务发现
- 构建对 API 的请求
- 响应解析
阅读相关说明以安装和配置您选择的客户端库(通常位于代码库根目录下的 README 文件中)。
如果您的实现有特殊需求(例如使用不受支持的语言),您可以向 API 发出直接请求,而不是使用客户端库。
注册应用
要使用 AdSense Management API,您必须通过创建项目并生成客户端 ID 来注册您正在开发的应用。
注册您的应用使用您刚创建的新凭据修改客户端库项目的配置文件。如需了解详情,请参阅客户端库文档。
注意:用于注册的 Google 帐号应该是您的开发者帐号,也就是说,您希望应用的用户将其视为应用开发者的帐号。此帐号无需与 AdSense 登录信息相关联,因为用户在使用应用时将获得对自己帐号的访问权限。
快速入门教程
请按照以下步骤发出您的第一个请求。请注意,根据您所使用的库或语言,这些步骤可能会略有不同:
- 使用相应的示例从 AdSense 帐号中获取广告客户列表。此请求会启动一个一次性流程,在该流程中,AdSense 用户对您的项目进行身份验证和授权。
广告客户表示 AdSense 帐号与 AdSense 产品(如内容广告或搜索广告)之间的关联。一个 AdSense 帐号可以有一个或多个广告客户。
- 对于 Web 应用,用户将被重定向到他们可以选择授予访问权限的网站。获得授权后,用户将被重定向到 API 控制台中定义的回调网址。
- 安装式应用的工作原理与其类似。客户端库将尝试打开浏览器窗口并使用授权代码。对于 Android、Chrome 和 iOS 应用,此方法因平台而异。
- 使用
reports.generate
API Explorer 请求以下报告:date_range: YESTERDAY
dimensions: DATE
metrics: ESTIMATED_EARNINGS
您可以通过报告深入了解自己的收入,以及影响这些收入的因素。您可以利用渠道对整个帐号生成报告,也可以针对部分广告单元生成报告。
- 尝试从您的应用请求同一报告。
- 您可以按广告单元过滤报告。使用
adunits.list
获取广告单元列表。请注意,您需要广告客户 ID(可在第 1 步中获取)。选择广告单元后,请在reports.generate
的 filter 参数中使用其 ID:广告单元是用户为广告配置的占位符,用于定义所展示的广告的某些属性(如尺寸和形状)。
date_range: YESTERDAY
dimensions: DATE
metrics: ESTIMATED_EARNINGS
filter: AD_UNIT_ID==ca-pub-123456789:987654321
- 请尝试按自定义渠道或网址渠道过滤,或混合使用多种过滤条件。
通过渠道工具,您可以跟踪一部分广告单元的效果。渠道有两种: 网址渠道和自定义渠道。前一种可以帮助您跟踪特定网页或网域中的广告效果,而后一种则可帮助您跟踪用户选择的特定几组广告单元的效果。
浏览参考文档中的其他可用调用和资源,即可开始实现您的实现。