发出直接请求

我们建议您在实现过程中使用客户端库和示例。但是,如果您的API集成存在特殊需求(如使用了不支持的语言),则可以按照下述步骤发出直接请求。

目录

调用样式

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

术语REST是“具象状态传输”的简称。就Google API而言,它是指使用HTTP谓词来检索和修改由Google存储的数据的表示形式。

在REST型系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(如创建、获取、更新或删除资源)的请求之后,服务器便会执行此操作并发送响应,此响应通常会采用所指定资源的表示形式。

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

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

因为所有API资源都具有唯一的HTTP可访问的URI,因此REST不仅支持数据缓存,而且经过优化适用于网络的分布式基础架构。

如需详细了解REST,您可以参考以下第三方文档:

AdSense Management API中的REST

受支持的操作直接对应到REST HTTP谓词,如AdSense Management API操作中所述。

AdSense Management API URI的具体格式为:

https://www.googleapis.com/adsense/v1.4/resourceID?parameters

其中,resourceID是广告客户、广告单元、网址渠道、自定义渠道或报告集合的标识符,而parameters是指应用于查询的任意参数。

通过resourceID路径扩展格式,您可以指定您当前所操作的资源,例如:

https://www.googleapis.com/adsense/v1.4/adclients
https://www.googleapis.com/adsense/v1.4/adclients/adClientId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits/adUnitId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/urlchannels
...

AdSense Management API参考文档中概括了用于API中每种受支持操作的全部URI。

下面的两个示例展示了它在AdSense Management API中的工作方式。

列出广告客户:

GET https://www.googleapis.com/adsense/v1.4/adclients/

列出广告客户ca-pub-1234567890123456帐户中的广告单元:

GET https://www.googleapis.com/adsense/v1.4/adClients/ca-pub-1234567890123456/adunits

数据格式

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

给请求授权

您的应用向AdSense Management API发送的每个请求都必须包含授权令牌。Google也可通过此令牌识别您的应用。

关于授权协议

您的应用必须使用OAuth 2.0给请求授权,不支持其他授权协议。

使用OAuth 2.0给请求授权

所有发送到AdSense Management API的请求都必须由已通过身份验证的用户进行授权。

OAuth 2.0的具体授权流程可能会因您所编写的应用类型而异。下面是适用于所有应用类型的通用流程:

  1. 创建应用时,您需要使用Google Developers Console进行注册。然后,Google会提供您后面需要用到的信息,例如客户端ID和客户端密钥。
  2. 在Google Developers Console中激活AdSense Management API。(如果Developers Console中未列出该API,请跳过这一步。)
  3. 当您的应用需要访问用户数据时,它会请求Google提供特定范围的访问权限。
  4. Google会向用户显示同意界面,请用户授权您的应用请求其某些数据。
  5. 如果用户批准,Google会为您的应用提供一个短期访问令牌
  6. 您的应用请求用户数据,在请求中随附访问令牌。
  7. 如果Google确定您的请求及令牌有效,会返回您请求的数据。

有些流程还包含其他步骤,如使用刷新令牌获取新的访问令牌。要详细了解各种应用类型的流程,请参阅Google的OAuth 2.0文档

以下是适用于AdSense Management API的OAuth 2.0范围信息:

范围 含义
https://www.googleapis.com/auth/adsense 对AdSense数据的读取/写入权限。
https://www.googleapis.com/auth/adsense.readonly 对AdSense数据的只读权限。

要通过OAuth 2.0申请访问权限,您的应用需要范围信息,以及在注册应用时Google提供的相关信息(如客户端ID和客户端密钥)。

提示:Google API客户端库可帮您处理某些授权流程,且支持多种编程语言;要了解详情,请参阅库和示例页面

发出请求

最后一个步骤是发出API请求。有关具体信息,请参阅参考文档

发送以下问题的反馈:

此网页
AdSense Management API
AdSense Management API