开始使用 AdMob API

重要提示 ：新的用户角色和权限会影响 AdMob API 返回的数据。了解详情

本指南适用于想要使用 AdMob API 以编程方式获取 AdMob 帐号相关信息的开发者。

所有 Google AdMob API 调用都必须通过 OAuth2 授权，以便您的应用能够代表用户与网络服务进行交互。OAuth2 可让您的 AdMob API 客户端应用访问用户的 AdMob 帐号，而无需处理或存储用户的用户名或密码。如需了解授权概览，请参阅授权。

请按照以下步骤生成 OAuth2 凭据并发出您的第一个请求。

前提条件

• Google 帐号。

• Google AdMob 帐号。

• 熟悉 REST 基础知识以及使用 OAuth 2.0 向请求授权。

确定您的身份验证类型

请查看下表，了解最适合您的应用的身份验证类型：

选择您的 OAuth2 身份验证类型	如果...
桌面应用	您正在使用一个顶级经理帐号管理所有 AdMob API 帐号。 您是首次使用的用户，或者希望使用最简单的设置快速上手。 您的应用只能通过一台机器对 Google AdMob 用户进行身份验证。
Web 应用	您希望以可授权您的应用访问其 AdMob API 帐号数据的用户身份进行身份验证。 您希望轻松生成多个授权凭据，例如管理第三方帐号。 您的应用需要回调网址。桌面应用流程不支持回调网址。

要点 ：即使您正在开发在服务器上运行的应用，仍然可以选择桌面应用流程。区别在于 OAuth 授权是在本地完成还是远程完成。桌面流程要求在本地计算机上完成授权，而网络流程允许在 Google 的授权服务器上完成授权。

创建项目

若要开始使用 AdMob API，您需要先在 Google API 控制台中创建或选择一个项目，然后使用设置工具启用该 API，该工具会引导您完成整个过程并自动启用 AdMob API。

为现有项目启用 API

以下步骤适用于已有项目并希望手动为该项目启用 AdMob API 的用户。

为您的项目启用API：

1. Open the API Library中的Google API Console 。
2. If prompted, select a project, or create a new one. API Library列出了所有可用的API，并按产品家族和受欢迎程度分组。
3. 如果您要启用的API在列表中不可见，请使用搜索找到它，或单击其所属产品系列中的“ 查看全部 ”。
4. 选择要启用的API，然后单击“ 启用”按钮。
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

创建 OAuth2 凭据

以下说明将引导您完成创建 OAuth 2.0 客户端 ID（以便在“已安装的应用”流程中使用）的整个过程。

1. Go to the Credentials page.

2. 依次点击创建凭据 > OAuth 客户端 ID。

   如果您之前未为此项目配置 OAuth 权限请求页面，系统会引导您立即执行此操作。点击配置同意屏幕。您可以通过多种方式配置同意屏幕以使用 OAuth 2.0 客户端 ID。

   1. 将用户类型设置为外部，将发布状态设置为已发布。

   2. 或者，将用户类型设置为外部，将发布状态设置为测试，然后通过选择添加用户来添加测试用户，以授予他们使用您的 OAuth 2.0 客户端 ID 的权限。

      如需了解详情，请参阅设置 OAuth 权限请求页面。

3. 选择桌面应用或网页应用作为应用类型，为其命名，然后点击创建。

完成后，系统会显示一个 OAuth 2.0 客户端 ID 和客户端密钥，您可以将其下载为 JSON 格式进行保存以备后用。

发出请求

AdMob API 是基于 HTTP 和 JSON 构建的，因此任何标准 HTTP 客户端均可向其发送请求并解析响应。但是，Google API 客户端库具有更好的语言集成和安全性，并且支持发出已获授权的请求。客户端库支持多种编程语言；使用客户端库可以避免手动设置 HTTP 请求和手动解析响应。

注意 ：首次激活 OAuth 流程时，系统会要求您提供 AdMob 发布商 ID，并接受浏览器中显示授权提示。接受之前，请务必使用可访问您 AdMob 帐号的 Google 帐号登录。然后，您的应用便会获得授权，能够代表当前登录的任何帐号访问数据。

创建 OAuth 2.0 凭据后，您就可以开始使用 AdMob API 了。如需使用 OAuth 2.0 请求访问权限，您的应用还需要范围信息：

范围	含义
https://www.googleapis.com/auth/admob.readonly	查看所有 AdMob 数据。这可能包括帐号信息、广告资源和中介设置、报告以及其他数据。 其中不包括敏感数据，例如付款或广告系列详细信息。
https://www.googleapis.com/auth/admob.report	查看广告效果和收入报告。查看发布商 ID、时区和默认货币代码。

使用 Java、PHP、Python 或 curl 中的示例发出您的第一个报告请求。

撤消共享令牌

您可以通过以下两种方式撤消共享令牌：

1. 前往您的 Google 帐号权限页面，撤消对相关项目的访问权限。

2. 或者，您也可以使用 Google Identity API 撤消 Web 应用令牌。