v1.4 of the AdSense Management API is now deprecated. This version will stop returning data on October 12, 2021. Please migrate to v2 as soon as possible.

使用入门

本文档旨在帮助希望使用AdSense Management API的开发者了解有关其AdSense帐户的信息。本文档假设您熟悉网络编程的概念和网络数据格式。

目录

前期准备

获得AdSense帐户

您需要一个用来进行测试的AdSense帐户。如果您已经拥有测试帐户,说明一切准备就绪;这时您就可以访问AdSense界面,设置、修改或查看您的测试数据。

熟悉AdSense

如果您不熟悉AdSense概念,请在开始编码之前阅读AdSense介绍信息,并练习使用界面

选择客户端库

客户端库和示例页面,您会看到可用库和示例的相关信息。点击您所选语言对应的标签,然后通过链接下载源代码。客户端库会为您处理以下几个方面:

  • 身份验证
  • 服务发现
  • 创建API请求
  • 响应解析

阅读相关说明以安装和配置您所选择的客户端库。该说明通常位于存储库根目录下的README文件中。

如果您的实现方式有特殊需求(例如使用不支持的语言),可以向API发出直接请求,而不是使用客户端库。

注册应用

要使用AdSense Management API,您必须向Google注册您开发的应用:

  1. 进入API控制台
  2. 登录您的Google帐户或创建一个帐户。
  3. 创建一个新项目。
  4. 在新创建的项目中,点击AdSense Management API下方的“激活”按钮。
  5. 转到“API访问”部分。
  6. 创建客户ID:
    1. 网络应用(如果您的实现环境在网络服务器中)。
    2. 安装版应用(针对其他所有实现环境)。

    注意:在访问受保护的数据时,服务帐户不受支持。

  7. 使用您刚创建的新凭据修改客户端库项目的配置文件。有关详情,请查看客户端库文档。

注意:用于注册的Google帐户应该是您的开发者帐户,也就是您希望应用的用户将其视为该应用的开发者的帐户。该帐户无需与AdSense登录信息相关联,因为用户在使用该应用时将获得对自己帐户的访问权限。

快速入门指南

按照下面的步骤操作来发出您的首个请求。请注意,根据您所使用的库或语言,这些步骤可能会略有不同:

  1. 使用相应示例从AdSense帐户中提取广告客户列表。该请求会发起一个让AdSense用户对您的项目进行身份验证和授权的一次性过程。

    广告客户代表AdSense帐户与AdSense产品(如内容联盟网络广告或搜索广告)之间的一种关联。每个AdSense帐户可以有一个或多个广告客户。

    1. 对于网络应用,用户将被重定向到他们可以选择是否授予访问权限的网站。获得授权后,他们将会被重定向到API控制台中定义的回调网址。
    2. 安装版应用的工作原理与之类似。客户端库将尝试打开一个浏览器窗口并使用授权码。对于Android、Chrome和iOS应用,此方法将因各个平台而异。
  2. 使用 APIs Explorer中的reports.generate请求以下报告:
    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS

    您可以通过报告深入了解自己的收入,还能了解影响这些收入的因素。可以针对整个帐户生成报告,也可以通过使用渠道仅针对一部分广告单元生成报告。

  3. 尝试从您的应用中请求同一报告。
  4. 您可以按广告单元对报告进行过滤。请使用adunits.list来获取广告单元列表。请注意,在此过程中需要使用广告客户ID(可在第1步中获得此ID)。在选择广告单元后,请在reports.generatefilter参数中使用其ID。

    广告单元是用户为广告配置的占位符,用于定义所展示的广告的一些属性(如尺寸和形状)。

    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS
    • filter: AD_UNIT_ID==ca-pub-123456789:987654321
  5. 尝试按自定义渠道或网址渠道或混合使用多个过滤条件来进行过滤。

    通过渠道,您可以仅跟踪一部分广告单元的广告效果。渠道分为两种类型:网址渠道和自定义渠道。前一种供您用来跟踪特定页面或网域的广告效果,而后一种则用来跟踪用户选择的几组特定广告单元的效果。

  6. (可选)加入AdSense API通知组

在了解了参考文档中的其他可用调用和资源后,您就可以开始实现该API了。