Chartboost API — Методы для аналитики

Последнее обновление:

 

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


Метод HTTP GET
Конечная точка https://analytics.chartboost.com/v3/metrics/campaign
Пример запроса https://analytics.chartboost.com/v3/metrics/campaign?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
aggregate String Необязательное Обобщить результаты по времени (за день, за неделю, за месяц) За день
campaignId String Необязательное Ид. кампании (может быть To Campaign ID или From Campaign ID, в зависимости от groupBy и role) Нет
campaignType String Необязательное network, cross_promo, direct_deal network, direct_deal
dateMin String Обязательное Минимальная дата (ГГГГ-ММ-ДД) Нет
dateMax String Обязательное Максимальная дата (ГГГГ-ММ-ДД) Нет
groupBy String Необязательное Один из следующих вариантов: 'country' 'app' 'app,creative' 'target_creative' 'date' 'campaign' 'campaign_target' 'campaign_type' Нет
platform String Необязательное Фильтровать по отдельным платформам (iOS, Google Play, Amazon) Все
role String Необязательное advertiser или publisher Оба

Поля отклика
Параметр Описание Для кого возвращается
adTypeId 1 = interstitial
2 = more_apps
3 = in_play
4 = rewarded_video
5 = video_interstitial
Все
app Название приложения Все
campaign Название кампании Все
campaignId Ид. кампании (может быть To Campaign ID или From Campaign ID, в зависимости от groupBy и role) Все
campaignTarget Имя цели кампании (возвращается только при группировке по campaign_target) Рекламодатели
campaignSubType user_acquisition или retargeting Все
clicksDelivered Доставленные клики Публикаторы
clicksReceived Полученные клики Рекламодатели
cpcvEarned Соотношение средств, заработанных на полных просмотрах видео, и количества полных просмотров Публикаторы
cpcvSpent Соотношение средств, затраченных на полные просмотры видео, и количества полных просмотров Рекламодатели
creative Название рекламного креатива (возвращается только при группировке по creative) Рекламодатели
ctrDelivered Кликабельность для доставленных показов Публикаторы
ctrReceived Кликабельность для полученных показов Рекламодателей
dt Дата (ГГГГ-ММ-ДД) Все
ecpmEarned Заработок на 1000 показов Публикаторы
ecpmSpent Затраты на 1000 показов Рекламодатели
impressionsDelivered Показы, доставленные публикатором Публикаторы
impressionsReceived Показы, полученные рекламодателем Рекламодатели
installDelivered Доставленные установки Публикаторы
installRateDelivered Частота установок (IR) Публикаторы
installRateReceived Частота установок (IR) Рекламодатели
installReceived Установки Рекламодатели
moneyEarned Заработанные средства Публикаторы
moneySpent Потраченные средства Рекламодатели
videoCompletedDelivered Доставленные полные просмотры видео Публикаторы
videoCompletedReceived Полученные полные просмотры видео Рекламодатели

▲ К началу

 

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


Метод HTTP GET
Конечная точка https://analytics.chartboost.com/v3/metrics/app
Пример запроса https://analytics.chartboost.com/v3/metrics/app?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
aggregate String Необязательное Обобщить результаты по времени (за день, за неделю, за месяц) За день
appId String Необязательное Один или несколько (через запятые) ид. приложений Все
dateMax String Обязательное Максимальная дата (ГГГГ-ММ-ДД) Нет
dateMin String Обязательное Минимальная дата (ГГГГ-ММ-ДД) Нет
groupBy String Необязательное Один из следующих вариантов: app, ad_type,app, date, ad_location (только публикаторы), platform, campaign_type Нет
platform String Необязательное Один из вариантов: iOS, Google Play, Amazon Все
role String Необязательное advertiser или publisher Оба

Поля отклика
Параметр Описание Для кого возвращается
ad_type Тип рекламы
Подробнее о типах рекламы ▶
Все (только когда groupBy=ad_type,app)
allInstalls Количество всех установок независимо от источника (Chartboost и все прочие) Все
app Название приложения Все
appBundleId Больше не передается; в отчетах пользователи увидят Deprecated (устаревшее) Все
appId Ид. приложения в Chartboost Все
bootups Сколько раз пользователь запускал ваше приложение на устройстве Все
campaignType network, cross_promo, direct_deal Все
clicksDelivered Доставленные клики Публикаторы
clicksReceived Полученные клики Рекламодатели
cpcvEarned Соотношение средств, заработанных на полных просмотрах видео, и количества полных просмотров Публикаторы
cpcvSpent Соотношение средств, затраченных на полные просмотры видео, и количества полных просмотров Рекламодатели
ctrDelivered Кликабельность для доставленных показов Публикаторы
ctrReceived Кликабельность для полученных показов Рекламодатели
dt Дата (ГГГГ-ММ-ДД) Все
ecpmEarned Заработок на 1000 показов Публикаторы
ecpmSpent Затраты на 1000 показов Рекламодатели
eventLocation Именованное местоположение Chartboost для рекламы, публикуемой в приложении. Рекламодатели видят в поле отклика значение default. Все
impressionsDelivered Показы, доставленные публикатором Публикаторы
impressionsReceived Показы, полученные рекламодателем Рекламодатели
installDelivered Доставленные установки Публикаторы
installRateDelivered Частота установок (IR) Публикаторы
installRateReceived Частота установок (IR) Рекламодатели
installReceived Установки Рекламодатели
moneyEarned Заработанные средства Публикаторы
moneySpent Потраченные средства Рекламодатели
platform iOS, Google Play или Amazon Все
uniques Количество уникальных устройств, на которых запускалось приложение Все
videoCompletedDelivered Доставленные полные просмотры видео Публикаторы
videoCompletedReceived Полученные полные просмотры видео Рекламодатели

▲ К началу

 

Конечная точка экспорта установок предоставляет полный список всех полученных и (или) доставленных установок. Учтите, что эта конечная точка всегда возвращается ид. задания из системы Очереди аналитики, как описано в разделе «Перед началом».


Метод HTTP GET
Конечная точка https://analytics.chartboost.com/v3/metrics/install
Пример запроса https://analytics.chartboost.com/v3/metrics/install?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
campaignIds String Необязательное Один или несколько ид. кампаний (разделенные запятыми) Все кампании
campaignType String Необязательное network, cross_promo или direct_deal Все
dateMax String Обязательное Максимальная дата (ГГГГ-ММ-ДД) Нет
dateMin String Обязательное Минимальная дата (ГГГГ-ММ-ДД) Нет
platform String Необязательное Один из вариантов: iOS, Google Play, Amazon Все
role String Необязательное advertiser или publisher Оба

Поля отклика
Параметр Описание Для кого возвращается
Ad Type Тип рекламы
Подробнее о типах рекламы ▶
Все
Click Timestamp Дата и время (DD-MM-YYYY HH:MM:SS) Все
Cost Type Тип предложения цены за рекламирование
Подробнее о типах предложения цены ▶
Все
Cost Value Значение предложения цены за рекламирование Все
Country Двухбуквенный код страны устройства Все
Date Дата и время (DD-MM-YYYY HH:MM:SS) Все
From App Bundle Bundle ID публикующего приложения Все
From App ID Ид. публикующего приложения Все
From App Name Название публикующего приложения Все
From Campaign ID Ид. публикующей кампании Публикаторы
From Campaign Name Название публикующей кампании Публикаторы
From Campaign Type network, cross_promo, direct_deal Публикаторы
GAID Ид. рекламы Google (Google Advertising ID) Все (только для публикаторов, если отключен поведенческий таргетинг)
IFA Идентификатор iOS для рекламодателей (если отключен iOS 10 Limit Ad Tracking) Все (только для публикаторов, если отключен поведенческий таргетинг)
MAC MAC-адрес (устаревшее) Нет
Model Модель устройства Все
OS Операционная система устройства Все
To App Bundle Bundle ID рекламируемого приложения Все
To App ID Ид. рекламируемого приложения Все
To App Name Название рекламируемого приложения Все
To Campaign ID Ид. кампании рекламирования Рекламодатели
To Campaign Name Название кампании рекламирования Рекламодатели
To Campaign Target Ид. цели кампании рекламирования Все
To Campaign Type network, cross_promo, direct_deal Рекламодатели
UUID Универсальный уникальный идентификатор устройства (если доступен) Все (только для публикаторов, если отключен поведенческий таргетинг)

▲ К началу

 

Помимо конечных точек на странице «Проводник API» панели пользователя, мы создали еще одну, предназначенную специально для возврата чистых аналитических данных на уровне приложения, даты и страны. Этой конечной точкой могут также пользоваться от лица клиентов Chartboost сторонние службы соотнесения и посредничества, которым нужны данные на уровне страны.

Примечание для посреднических сетей: Настоятельно рекомендуем опустить поле campaignType, поскольку API будет автоматически возвращать результаты для network,direct_deal.
В этот API не входят данные о страницах «Другие приложения». Учтите, что между конечными точками приложений и кампаний и вашей аналитикой на панели пользователя могут возникать расхождения. Используйте конечную точку кампаний и группируйте по country, чтобы получить данныe app, country и ad_type.

Метод HTTP GET
Конечная точка https://analytics.chartboost.com/v3/metrics/appcountry
Пример запроса https://analytics.chartboost.com/v3/metrics/appcountry?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
appIds String Необязательное Один или несколько (через запятые) ид. приложений Все приложения
dateMin String Обязательное Минимальная дата (ГГГГ-ММ-ДД) Нет
dateMax String Обязательное Максимальная дата (ГГГГ-ММ-ДД) Нет
campaignType String Необязательное network, cross_promo или direct_deal network,direct_deal
adTypeIds String Необязательное Один или несколько (через запятые) идентификаторов типа рекламы: 1 = interstitial, 3 = in_play, 4 = rewarded_video, 5 = video_interstitial 1,4,5
role String Необязательное advertiser или publisher publisher
adLocation String Необязательное Один или несколько (через запятые) adLocations
  • Случай #1: (adLocation=<любое значение, кроме 'all'>) показывает совокупные результаты по каждому adLocation ТОЛЬКО для указанных adLocation. Информация для adLocation доступна лишь тогда, когда оно является одним из трех главных adLocation, используемых приложением публикатора. Для прочих adLocation не возвращается никаких данных.
  • Случай #2: (adLocation='all') показывает результаты для каждого из трех главных adLocation приложения публикатора, а все остальные данные совокупно входят в раздел adLocation = 'other'
  • Случай #3: (adLocation= пусто или not passed)показывает все данные совокупно в разделе adLocation = 'overall'. Разбивка по разным adLocation не предоставляется.
См. случай #3

Поля отклика
Параметр Описание Для кого возвращается
adLocation Именованное местоположение Chartboost для рекламы, публикуемой в приложении. Рекламодатели видят в поле отклика значение default. Все
adType interstitial, rewarded_video, video_interstitial Все
app Название приложения Все
campaignType network, cross_promo, direct_deal Все
clicksDelivered Клики Публикаторы
clicksReceived Клики Рекламодатели
countryCode Двухбуквенный код страны либо «unknown» Все
cpcvEarned Соотношение средств, заработанных на полных просмотрах видео, и количества полных просмотров Публикаторы
cpcvSpent Соотношение средств, затраченных на полные просмотры видео, и количества полных просмотров Рекламодатели
ctrDelivered Кликабельность (CTR) Публикаторы
ctrReceived Кликабельность (CTR) Рекламодатели
dt Дата (ГГГГ-ММ-ДД) Все
ecpmEarned Заработок на 1000 показов Публикаторы
ecpmSpent Затраты на 1000 показов Рекламодатели
impressionsDelivered Показы Публикаторы
impressionsReceived Показы Рекламодатели
installRateDelivered Частота установок (IR) Публикаторы
installRateReceived Частота установок (IR) Рекламодатели
installsDelivered Установки Публикаторы
installsReceived Установки Рекламодатели
moneyEarned Заработанные средства Публикаторы
moneySpent Потраченные средства Рекламодатели
platform iOS, Google Play или Amazon Все
videoCompletedDelivered Полные просмотры видео Публикаторы
videoCompletedReceived Полные просмотры видео Рекламодатели

▲ К началу

 


Вам может быть интересно...