Делайте прямые запросы

Мы рекомендуем вам использовать клиентские библиотеки и примеры для вашей реализации. Однако если у вашей интеграции с API есть особые потребности, например использование неподдерживаемого языка, вы можете делать прямые запросы, как описано ниже.

Стиль звонка

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

Термин REST является сокращением от « Передача представительского состояния ». В контексте 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 в API управления AdSense

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

Конкретный формат URI API управления AdSense:

https://adsense.googleapis.com/v2/resourceID?parameters

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

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

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

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

Вот несколько примеров того, как это работает в API управления AdSense.

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

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

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

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

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

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

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

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

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

О протоколах авторизации

Ваше приложение должно использовать OAuth 2.0 для авторизации запросов. Никакие другие протоколы авторизации не поддерживаются. Если ваше приложение использует «Войти через Google» , некоторые аспекты авторизации выполняются за вас.

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

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

Этот процесс упрощается с помощью идентификатора клиента OAuth.

Получите идентификатор клиента OAuth

Или создайте его на странице «Учетные данные» .

Детали процесса авторизации или «потока» для OAuth 2.0 несколько различаются в зависимости от того, какое приложение вы пишете. Следующий общий процесс применим ко всем типам приложений:

  1. Когда вашему приложению требуется доступ к пользовательским данным, оно запрашивает у Google определенный объем доступа.
  2. Google отображает пользователю экран согласия , прося его разрешить вашему приложению запрашивать некоторые из его данных.
  3. Если пользователь одобряет, Google предоставляет вашему приложению кратковременный токен доступа .
  4. Ваше приложение запрашивает пользовательские данные, прикрепляя к запросу токен доступа.
  5. Если Google определит, что ваш запрос и токен действительны, он вернет запрошенные данные.

Некоторые потоки включают дополнительные шаги, например использование токенов обновления для получения новых токенов доступа. Подробную информацию о потоках для различных типов приложений см. в документации 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. Подробную информацию смотрите в справочной документации .