Прямые запросы

При разработке приложения мы рекомендуем вам использовать клиентские библиотеки и примеры кода. Тем не менее, если они не обеспечивают необходимых вам возможностей (например, вы используете неподдерживаемый язык), можно отправлять запросы к API напрямую.

Содержание

Стиль вызовов

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

REST – это сокращение от Representational State Transfer (передача состояния представления). В API Google система REST позволяет использовать методы HTTP для извлечения и изменения представлений данных, сохраняемых Google.

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

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

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

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

Подробнее о REST читайте на следующих ресурсах:

  • Building Web Services the REST Way. В этом документе (на английском языке), предназначенном для поставщиков услуг, дается хороший обзор архитектуры REST.
  • HTTP 1.1: определения методов; спецификации для GET, POST, PUT и DELETE.

Использование REST в API управления AdSense

Поддерживаемые операции напрямую соответствуют HTTP-глаголам REST, как описано в разделе Операции API управления AdSense.

URI в API управления AdSense имеют следующий формат:

https://www.googleapis.com/adsense/v1.4/resourceID?parameters

Здесь resourceID – идентификатор рекламного клиента, рекламного блока, URL-канала, клиентского канала или набора отчетов, а parameters – любые параметры, которые необходимо применить в запросе.

Формат расширений пути resourceID позволяет определить, над каким ресурсом выполняется операция, например:

https://www.googleapis.com/adsense/v1.4/adclients
https://www.googleapis.com/adsense/v1.4/adclients/adClientId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits/adUnitId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/urlchannels
...

Полный перечень URI для всех поддерживаемых операций представлен в справочной документации по API управления AdSense.

Вот несколько примеров.

Получение списка рекламных клиентов:

GET https://www.googleapis.com/adsense/v1.4/adclients/

Получение списка рекламных блоков в рекламном клиенте ca-pub-1234567890123456:

GET https://www.googleapis.com/adsense/v1.4/adClients/ca-pub-1234567890123456/adunits

Формат данных

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

Авторизация запросов

Все запросы, которые ваше приложение отправляет в API управления AdSense, должны содержать токен авторизации, который одновременно выполняет функцию идентификатора вашего приложения для Google.

Протоколы авторизации

Для авторизации запросов ваше приложение должно использовать протокол OAuth 2.0. Никакие другие протоколы авторизации не поддерживаются.

Авторизация запросов с помощью OAuth 2.0

Все запросы к API управления AdSense должны быть авторизованы пользователем, прошедшим аутентификацию.

Особенности процесса авторизации с помощью OAuth 2.0 зависят от типа приложения. В общих чертах процедура выглядит так:

  1. Создавая приложение, вы регистрируете его в Консоли Google Developers. Вы получите информацию, которая пригодится позже, например идентификатор и секретный ключ клиента.
  2. Активируйте API управления AdSense в Консоли Google Developers (если такого API там нет, пропустите этот шаг).
  3. Когда приложению потребуются пользовательские данные, оно запрашивает у Google определенную область доступа.
  4. Google показывает пользователю диалоговое окно с просьбой авторизовать приложение для запроса этих данных.
  5. Если пользователь соглашается, Google предоставляет приложению токен доступа с коротким сроком действия.
  6. Ваше приложение запрашивает пользовательские данные, указывая токен доступа.
  7. Получив действительный запрос и токен, Google возвращает необходимые данные.

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

В таблице ниже приведена информация об области действия OAuth 2.0 для API управления AdSense.

Область действия Назначение
https://www.googleapis.com/auth/adsense Доступ к данным AdSense с правом на чтение и запись.
https://www.googleapis.com/auth/adsense.readonly Доступ к данным AdSense только для чтения.

Чтоб запросить доступ с помощью OAuth 2.0, приложению нужна информация об области доступа наряду с данными, которые Google предоставляет при регистрации приложения (например, идентификатор или секретный ключ клиента).

Совет. Клиентские библиотеки API Google автоматически выполняют часть задач, связанных с авторизацией. Они доступны для различных языков программирования. Дополнительную информацию можно получить на странице Библиотеки и примеры кода.

Выполнение запроса

И наконец, выполните запрос к API. О том, как это сделать, читайте в справочной документации.

Оставить отзыв о...

Текущей странице
AdSense Management API
AdSense Management API