v1.4 of the AdSense Management API is now deprecated. This version will stop returning data on October 12, 2021. Please migrate to v2 as soon as possible.

Начало работы

Этот документ предназначен для разработчиков, которые хотят получать информацию о своем аккаунте AdSense с помощью API управления AdSense. Предполагается, что читатели знакомы с основными понятиями веб-программирования и форматами интернет-данных.

Содержание

Предварительная подготовка

Создание аккаунта AdSense

Вам понадобится аккаунт AdSense для тестирования. Если у вас уже есть тестовый аккаунт, никаких дополнительных действий не потребуется. Создавать, менять и просматривать тестовые данные можно в пользовательском интерфейсе AdSense.

Знакомство с AdSense

Если вы не знакомы с основными понятиями AdSense, изучите краткое описание и пользовательский интерфейс, прежде чем приступить к написанию кода.

Выбор клиентской библиотеки

На странице Клиентские библиотеки и примеры кода можно узнать, какие библиотеки и образцы кода мы предлагаем. Нажмите на вкладку для выбранного языка программирования, а затем на ссылку для загрузки. Клиентские библиотеки автоматизируют следующие задачи:

  • аутентификацию;
  • обнаружение служб;
  • составление запросов к API;
  • анализ ответов.

Изучите инструкции по установке и настройке клиентской библиотеки – обычно их можно найти в файле README в корневом каталоге репозитория.

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

Регистрация приложения

Чтобы приступить к использованию API управления AdSense, необходимо зарегистрировать приложение в Google. Для этого:

  1. Откройте консоль API.
  2. Войдите в свой аккаунт Google или зарегистрируйтесь.
  3. Создайте новый проект.
  4. В этом проекте нажмите кнопку Activate (Активировать) в разделе API управления AdSense.
  5. Перейдите на вкладку API Access (Доступ к API).
  6. Создайте идентификатор клиента. У вас есть два варианта:
    1. Web application (Веб-приложение) – если ваше приложение базируется на веб-сервере.
    2. Installed application (Установленное приложение) – во всех остальных случаях.

    Примечание. Аккаунты служб не поддерживаются по причине доступа к защищенным данным.

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

Примечание. При регистрации используйте тот аккаунт Google, который должен представлять вас как автора приложения (аккаунт разработчика). Он может быть не связан с AdSense, так как пользователи приложения будут предоставлять доступ к собственным аккаунтам.

Руководство по быстрому старту

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

  1. Получите список рекламных клиентов для аккаунта AdSense, используя соответствующий образец кода. Этот запрос запускает однократный процесс аутентификации и авторизация вашего проекта пользователем AdSense.

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

    1. В случае веб-приложения пользователи будут перенаправлены на сайт, где они смогут предоставить вам доступ. После авторизации они перенаправляются на URL обратного вызова, заданный в консоли API.
    2. Для установленных приложений процедура практически такая же. Клиентская библиотека попытается открыть окно браузера и использовать код авторизации. Этот метод специфичен для платформ Android, Chrome и iOS.
  2. С помощью API Explorer вызовите метод reports.generate и запросите следующий отчет:
    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS

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

  3. Попробуйте запросить этот же отчет из своего приложения.
  4. Отчеты можно фильтровать по рекламным блокам. Получите список рекламных блоков, используя метод adunits.list (необходимо указать идентификатор клиента – см. шаг 1). Выбрав рекламный блок, укажите его идентификатор в параметре filter метода reports.generate:

    Рекламные блоки – это заданные пользователем места для размещения рекламы, от которых зависят некоторые параметры объявлений, например размер и форма.

    • startDate: today-1m
    • endDate: today
    • dimensions: DATE
    • metrics: EARNINGS
    • filter: AD_UNIT_ID==ca-pub-123456789:987654321
  5. Попробуйте выполнить фильтрацию по клиентским или URL-каналам. Фильтры также можно комбинировать.

    Каналы позволяют отслеживать эффективность набора рекламных блоков. Существует два типа каналов: URL-каналы и клиентские каналы. Первые позволяют отслеживать эффективность для определенной страницы или домена, а вторые – для указанной пользователем группы рекламных блоков.

  6. Если есть желание, подпишитесь на анонсы AdSense API.

Готово! Теперь вы можете пробовать другие доступные вызовы и ресурсы. Информацию о них вы найдете в справочной документации.