Альфа-API отчета о рекламной активности

Отчет «Действия с рекламой» – это централизованное представление эффективности вашей рекламы. Он объединяет данные, метрики и параметры из API сетевых отчетов и API отчетов о посредничестве, а также данные о ставках в единый унифицированный отчет.

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

API сетевых отчетов API отчета о медиации API отчета о рекламной активности
Производительность сети ✅ ✅ ✅
Представление водопада ✅ ✅
Эффективность ставок ✅
Эффективность эксперимента медиации A/B ✅
Ежечасная отчетность ✅
Размер отчета 100 тыс. 100 тыс. 500 тыс.

Метрики, параметры и фильтры измерений

Следующие метрики были добавлены в API отчетов о активности рекламы в дополнение ко многим метрикам, доступным в API сетевых отчетов и API отчетов о медиации.

Метрика Описание
BID_REQUEST Количество запросов к источнику объявлений с назначением ставок.
BIDS_IN_AUCTION Количество ставок, поданных источником объявлений, участвовавшим в аукционах.
WINNING_BIDS Число ставок, выигравших аукцион.

Следующие новые параметры включены в API отчетов о активности рекламы.

Измерение Описание
НЕДЕЛЯ Дата первого дня недели (в соответствии с кодом языка, указанным в настройках локализации) в формате ГГГГММДД (например, «20210701»). В запросах можно указать только одно измерение времени: ДАТА, НЕДЕЛЯ или МЕСЯЦ.
ЧАС Час в формате HH по времени PST. Например, «05» — 5 утра по тихоокеанскому времени, «13» — 13:00 по тихоокеанскому времени. В запросе также необходимо указать измерение DATE. Если указано измерение HOUR, возвращаются данные максимум за 28 дней. Даты начала диапазона дат, которые старше 28 дней до текущей даты, возвращают ошибку.
MEDIATION_AB_TEST (название эксперимента) Просмотр эффективности с помощью A/B-теста медиации. Это обязательно указать, если указано измерение VARIANT.
MEDIATION_AB_TEST_VARIANT (вариант A, вариант B) Просмотрите эффективность по варианту теста A/B медиации.
Название измерения в API отчета о медиации Название параметра в API отчета о рекламной активности Описание
AD_UNIT 1 AD_UNIT_ID Уникальный идентификатор рекламного блока (например, «123456789»).
AD_UNIT_NAME Название рекламного блока.
ПРИЛОЖЕНИЕ 1 Идентификатор_приложения Уникальный идентификатор мобильного приложения (например, «1234567890»).
ПРИЛОЖЕНИЕ_ИМЯ Название приложения.
ОБЪЯВЛЕНИЕ_ИСТОЧНИК 1 AD_SOURCE_ID Уникальный идентификатор источника объявления (например, «1234567890123456789»).
AD_SOURCE_NAME Название источника объявлений (например, «Сеть AdMob»).
AD_SOURCE_INSTANCE 1 AD_SOURCE_INSTANCE_ID Уникальный идентификатор экземпляра источника объявления (например, «123456789012»).
AD_SOURCE_INSTANCE_NAME Имя экземпляра источника объявлений (например, «AdMob (по умолчанию)»).
MEDIATION_GROUP 1 MEDIATION_GROUP_ID Уникальный идентификатор группы медиации (например, "1234567890").
MEDIATION_GROUP_NAME Уникальный идентификатор группы медиации (например, "AdMob (по умолчанию)").

1 : Дополнительную информацию см. в разделе «Скаляры» .

Следующие размеры имеют обновленный формат.

Название измерения в API отчета о медиации Описание в API отчета о медиации Описание в API отчета о рекламной активности
ESTIMATED_EARNINGS Ориентировочный доход издателя AdMob. Валютная единица (доллар США, евро или другая) показателей дохода определяется настройкой локализации валюты. Сумма указана в микронах. Например, 6,50 доллара США будут представлены как 6500000.

Ориентировочный доход на группу медиации и на уровень экземпляра источника объявлений поддерживается начиная с 20 октября 2019 г. Ориентировочный доход сторонних поставщиков будет равен 0 для дат до 20 октября 2019 г.

 Ориентировочный доход издателя AdMob. Валютная единица (доллар США, евро или другая) показателей дохода определяется настройкой локализации валюты.
НАБЛЮДЕННАЯ_ECPM Расчетная средняя эффективная цена за тысячу показов сторонней рекламной сети. Валютная единица (доллар США, евро или другая) показателей дохода определяется настройкой локализации валюты. Сумма указана в микронах. Например, 2,30 доллара США будут представлены как 2300000.

Расчетная средняя эффективная цена за тысячу показов для группы медиации и уровня экземпляра источника объявлений поддерживается начиная с 20 октября 2019 года. Расчетная средняя эффективная цена за тысячу показов сторонних поставщиков будет равна 0 для дат до 20 октября 2019 года.

 Средняя эффективная цена за тысячу показов для всех объявлений. Валютная единица (доллар США, евро или другая) показателей дохода определяется настройкой локализации валюты.

Средняя эффективная цена за тысячу показов для группы медиации и уровня экземпляра источника объявлений поддерживается начиная с 20 октября 2019 года. OBSERVED_ECPM будет показывать 0 для дат до 20 октября 2019 года.

Скаляры

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

Параметры, затронутые в API отчетов о медиации и API отчетов о сети:

  • AD_UNIT
  • APP
  • AD_SOURCE
  • AD_SOURCE_INSTANCE
  • MEDIATION_GROUP
Пример данных ответа на отчет
Формат измерения медиации/сетевого API 
"AD_UNIT": {
   "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY",
   "displayLabel": "Test ad unit name"
   }
Формат измерения AAR API 
"AD_UNIT_NAME": "Test ad unit name",
"AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Ежечасная отчетность

Теперь вы можете просматривать эффективность по часам в API AdMob. Почасовая отчетность доступна на срок до 28 дней.

Измерение DATE также необходимо указать в запросе на получение почасовых данных. Если указано измерение HOUR, возвращаются данные максимум за 28 дней. Даты начала диапазона дат, которые старше 28 дней до текущей даты, возвращают ошибку.

Больший размер отчета

API отчетов о рекламной активности позволяет получить в общей сложности 500 000 строк. Дополнительную информацию см. в руководстве по квотам .

Сделать запрос

Выполните следующие действия, чтобы сделать запрос.

локон (командная строка)

Запросы с использованием Curl

  1. Загрузите файл секретов клиента и сгенерируйте учетные данные для авторизации.

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

    Для аутентификации и авторизации мы рекомендуем использовать oauth2l — простой инструмент командной строки для работы с Google OAuth 2.0. Установите oauth2l и выполните приведенную ниже команду, заменив path_to_credentials_json путем к файлу credentials.json , который вы загружаете при регистрации облачного приложения. При первом запуске команда проведет вас через процесс авторизации OAuth 2.0. Последующие запуски автоматически обновляют токен.

    ~/go/bin/oauth2l header --json path_to_credentials_json \
        https://www.googleapis.com/auth/admob.readonly

  2. Создайте отчет о рекламной активности.

    curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
     -H "Content-Type: application/json" \
     -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
      {
        "report_spec": {
        "date_range": {
          "start_date": {"year": 2023, "month": 1, "day": 1},
          "end_date": {"year": 2023, "month": 1, "day": 2}
        },
        "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
        "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
        "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
        "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
        "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
        }
      }
EOF

    Пример ответа:

    {
"rows": [
  {
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant A"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 0
      },
      "BID_REQUEST": {
        "integerValue": "27"
      },
      "WINNING_BIDS": {
        "doubleValue": 0.1111111111111111
      },
      "IMPRESSIONS": {
        "integerValue": "2"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0
      }
    }
  },
{
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant B"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 1
      },
      "BID_REQUEST": {
        "integerValue": "6"
      },
      "WINNING_BIDS": {
        "doubleValue": 1
      },
      "IMPRESSIONS": {
        "integerValue": "3"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0.000427519
      }
    }
  }
]}