Before you can start coding your first client application, there are a few things you need to do, if you haven't done them already.

Create a project for your client

Before you can send requests, you need to tell Google about your client and activate access to the API. You do this by using the Google API Console to create a project, which is a named collection of settings and API access information, and register your application.

To get started using Android Over The Air API, you need to first use the setup tool, which guides you through creating a project in the Google API Console, enabling the API, and creating credentials.

Whitelist the project

The Android Over The Air API is only available to whitelisted projects. If your project is not whitelisted, you will receive 404 errors attempting to use it.

In order to get whitelisted, send an email to your Google TAM to whitelist your new project ID.

The project ID can be found in your Cloud Dashboard. See this help doc for more information.

Note that the project id should ideally be of this format {company}-gota-api-{number}

After you've been whitelisted, enable Android Over The Air API for your project and see the authorization how-to for details on accessing it.

Note that only the project ID you provided will be able to use the Android Over The Air API. We strongly recommend creating a service account (as described in authorization) for API usage rather than using any personal accounts.

Try out Android Over The Air Dashboard

This API documentation assumes that you've used Android Over The Air Dashboard, and that you're familiar with web programming concepts and web data formats.

If you haven't used Android Over The Air Dashboard, then try out the user interface before starting to code.

Learn REST basics

There are two ways to invoke the API:

If you decide not to use client libraries, you'll need to understand the basics of REST.

REST is a style of software architecture that provides a convenient and consistent approach to requesting and modifying data.

The term REST is short for "Representational State Transfer." In the context of Google APIs, it refers to using HTTP verbs to retrieve and modify representations of data stored by Google.

In a RESTful system, resources are stored in a data store; a client sends a request that the server perform a particular action (such as creating, retrieving, updating, or deleting a resource), and the server performs the action and sends a response, often in the form of a representation of the specified resource.

In Google's RESTful APIs, the client specifies an action using an HTTP verb such as POST, GET, PUT, or DELETE. It specifies a resource by a globally-unique URI of the following form:

Because all API resources have unique HTTP-accessible URIs, REST enables data caching and is optimized to work with the web's distributed infrastructure.

You may find the method definitions in the HTTP 1.1 standards documentation useful; they include specifications for GET, POST, PUT, and DELETE.

REST in the Android Over The Air API

The Android Over The Air API operations map directly to REST HTTP verbs.

The specific formats for Android Over The Air API URIs are:

The full set of URIs used for each supported operation in the API is summarized in the Android Over The Air API Reference document.

Learn JSON basics

The Android Over The Air API returns data in JSON format.

JSON (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see