前提条件

在开始编写您的首个客户端应用之前,您需要做一些准备工作(如果您还没有做的话)。

为客户端创建一个项目

您需要先告知 Google 您的客户端并激活对 API 的访问权限,然后才能发送请求。 为此,您可以使用 Google API 控制台创建一个项目(这是设置和 API 访问信息的命名集合),然后注册您的应用。

如需开始使用 Android Over The Air API,您需要先使用设置工具,该工具会引导您在 Google API 控制台中创建项目、启用 API 以及创建凭据。

将项目列入白名单

Android Over The Air API 仅适用于已列入白名单的项目。如果您的项目未列入白名单,您在尝试使用该项目时会收到 404 错误消息。

为了能够列入白名单,请向 Google TAM 发送电子邮件,将您的新项目 ID 列入白名单。

您可以在 Cloud 信息中心内找到项目 ID。 如需了解详情,请参阅此帮助文档

请注意,项目 ID 最好采用以下格式:{company}-gota-api-{number}

在列入白名单后,请为您的项目enable Android Over The Air API,并查看授权方法以详细了解如何访问该 API。

请注意,只有您提供的项目 ID 才能使用 Android Over The Air API。我们强烈建议您创建用于 API 的服务帐号(如授权中所述),而不是使用任何个人帐号。

试用 Android 无线下载信息中心

本 API 文档假定您使用过 Android 无线下载信息中心,并且熟悉网络编程概念和网络数据格式。

如果您尚未使用过 Android 无线下载信息中心,请在开始编码之前试用界面

了解 REST 基础知识

您可以通过以下两种方式调用 API:

  • 发送 HTTP 请求并解析响应。
  • 使用客户端库

如果您决定不使用客户端库,则将需要了解 REST 的基础知识。

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

术语 REST 是“具象状态传输”的简称。在 Google API 的上下文中,指的是使用 HTTP 谓词来检索和修改由 Google 存储的数据的表示法。

在 RESTful 系统中,资源存储在数据存储区中;在客户端发送要求服务器执行特定操作(例如创建、检索、更新或删除资源)的请求之后,服务器便会执行该操作并发送响应,此响应的格式通常为所指定资源的表示法。

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

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

由于所有 API 资源都具有 HTTP 可访问的唯一 URI,因此 REST 启用了数据缓存,而且经过优化以与网络的分布式基础架构一起使用。

您可能会发现 HTTP 1.1 标准文档中的方法定义十分有用;这些定义中包含了 GETPOSTPUTDELETE 的规范。

Android Over The Air API 中的 REST

Android Over The Air API 操作会直接映射到 REST HTTP 动词。

Android Over The Air API URI 的具体格式为:

https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters

Android Over The Air API 参考文档总结了用于 API 中各项受支持操作的全部 URI。

了解 JSON 基础知识

Android Over The Air API 以 JSON 格式返回数据。

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