开始使用 AdMob API

本指南面向希望使用 AdMob API 以编程方式获取和管理 AdMob 账号中的数据的开发者。

所有 Google AdMob API 调用都必须通过 OAuth2 授权，这样您的应用才能代表用户与 Web 服务互动。OAuth2 可让您的 AdMob API 客户端应用访问用户的 AdMob 账号，而无需处理或存储用户的用户名或密码。如需大致了解授权，请参阅授权。

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

前提条件

确定身份验证类型

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

选择 OAuth2 身份验证类型 如果…
桌面应用
  • 您使用单个顶级经理账号管理所有 AdMob API 账号。
  • 您是初次使用，或者希望通过最简单的设置快速开始使用。
  • 您的应用仅验证来自一台机器的 Google AdMob 用户。
Web 应用
  • 您希望以能够向您的应用授予权限来访问其 AdMob API 账号数据的用户身份进行身份验证。
  • 您希望轻松生成多个授权凭据，以便管理第三方账号等。
  • 您的应用需要回调网址。桌面应用流程不支持回调网址。

创建项目

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

为现有项目启用 API

以下步骤适用于拥有现有项目且希望手动为该项目激活 AdMob API 的用户。

如需为您的项目启用该 API，请按以下步骤操作：

  1. 在 Google API 控制台中打开 API 库。
  2. 如果系统提示您选择一个项目或创建一个新项目，请视需要选择相应选项。API 库列出了所有可用的 API（按产品系列和热门程度分组）。
  3. 如果列表中没有显示您要启用的 API，请使用搜索功能查找该 API，或点击该 API 所属产品系列中的查看全部。
  4. 选择您要启用的 API，然后点击启用按钮。
  5. 如果系统提示，请启用结算功能。
  6. 如果系统提示您阅读并接受该 API 的服务条款，请按提示操作。

创建 OAuth2 凭据

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

  1. 前往“客户”页面。

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

    如果您之前未为此项目配置 OAuth 权限请求页面，系统现在会引导您进行配置。点击配置权限请求页面。您可以通过多种方式配置权限请求页面，以使用 OAuth 2.0 客户端 ID。

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

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

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

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

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

发出请求

AdMob API 基于 HTTP 和 JSON 而构建，因此任何标准 HTTP 客户端均可向其发送请求并解析响应。不过，Google API 客户端库可提供更好的语言集成和更高的安全性，还支持发出授权请求。客户端库支持多种编程语言；使用这些库可避免手动设置 HTTP 请求和解析响应。

创建 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 应用令牌。