Требования

Прежде чем приступить к разработке своего первого клиентского приложения, вам необходимо выполнить несколько действий, если вы еще этого не сделали.

Создайте проект для своего клиента.

Прежде чем отправлять запросы, необходимо сообщить Google о вашем клиенте и активировать доступ к API. Для этого нужно создать проект в консоли Google API (именно так называется набор настроек и информации о доступе к API) и зарегистрировать ваше приложение.

Для начала работы с Android Over The Air API необходимо воспользоваться инструментом настройки , который поможет вам создать проект в консоли Google API и включить API.

Добавить проект в белый список

API Android Over The Air доступен только для проектов, включенных в белый список. Если ваш проект не включен в белый список, при попытке его использования вы получите ошибку 404 .

Чтобы попасть в белый список, отправьте электронное письмо своему менеджеру по работе с ключевыми клиентами Google (TAM) с просьбой добавить ваш новый идентификатор проекта в белый список.

Идентификатор проекта можно найти на вашей панели управления облаком . Дополнительную информацию см. в этом справочном документе .

Обратите внимание, что идентификатор проекта в идеале должен иметь следующий формат: {company}-gota-api-{number}

После добавления вашего проекта в белый список включите Android Over The Air API для вашего проекта и ознакомьтесь с инструкцией по авторизации для получения подробной информации о доступе к нему.

Обратите внимание, что использовать Android Over The Air API сможет только тот проект, идентификатор которого вы указали. Мы настоятельно рекомендуем создать служебную учетную запись (как описано в разделе авторизации) для использования API, а не использовать личные учетные записи.

Попробуйте панель управления Android Over The Air.

Данная документация по API предполагает, что вы использовали Android Over The Air Dashboard и знакомы с концепциями веб-программирования и форматами веб-данных.

Если вы еще не пользовались Android Over The Air Dashboard, попробуйте ознакомиться с пользовательским интерфейсом, прежде чем приступать к программированию.

Изучите основы REST.

Существует два способа вызова API:

Если вы решите не использовать клиентские библиотеки, вам потребуется понять основы REST.

REST — это стиль программной архитектуры, обеспечивающий удобный и согласованный подход к запросу и изменению данных.

Термин REST расшифровывается как « Representational State Transfer» (передача репрезентативного состояния ). В контексте API Google это означает использование HTTP-глаголов для получения и изменения представлений данных, хранящихся в Google.

В RESTful-системе ресурсы хранятся в хранилище данных; клиент отправляет запрос серверу на выполнение определенного действия (например, создание, получение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в виде представления указанного ресурса.

В RESTful API от Google клиент указывает действие, используя HTTP-глагол, такой как POST , GET , PUT или DELETE . Он указывает ресурс с помощью глобально уникального URI следующего вида:

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

Поскольку все ресурсы API имеют уникальные URI, доступные по протоколу HTTP, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной инфраструктурой сети.

Возможно, вам пригодятся определения методов в документации по стандартам HTTP 1.1; они включают спецификации для GET , POST , PUT и DELETE .

REST в Android Over The Air API

Операции Android Over The Air API напрямую соответствуют HTTP-глаголам REST.

Конкретные форматы URI для Android Over The Air API следующие:

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

Полный набор URI, используемых для каждой поддерживаемой операции в API, приведен в справочном документе Android Over The Air API Reference .

Изучите основы JSON.

API Android Over The Air возвращает данные в формате JSON.

JSON (JavaScript Object Notation) — это распространённый, независимый от языка формат данных, предоставляющий простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .