InCost API для рекламных сетей

Краткий обзор. API InCost, часть AppsFlyer ROI360, позволяет рекламным сетям отправлять данные о расходах на рекламу в AppsFlyer программным способом. Это предоставит рекламодателям данные о совокупных расходах и позволит им оценить истинное влияние вашей сети.

О API InCost

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

Преимущества

  • Помогите своим клиентам понять истинное влияние вашей сети с помощью удобной отчетности о расходах. Без данных о затратах ваши клиенты упускают важную часть измерений и не могут точно измерить рентабельность инвестиций в рекламу. В связи с этим они могут ошибочно инвестировать в другие медиа-источники, что отрицательно скажется на вашей прибыли.
  • Докажите свою рентабельность с помощью решения, которое гарантирует точное, полное и оперативное измерение затрат.
  • API InCost быстро и просто развертывается, а эффект ощущается практически мгновенно. Вы также получаете полный контроль над тем, как и когда отправлять данные, включая возможность отправлять данные о расходах за период до 90 прошедших дней.
  • API InCost поддерживает все модели ценообразования кампаний, а не только CPI (единственная модель, доступная при отправке затрат по клику).
  • Выделитесь на маркетплейсе партнеров AppsFlyer с помощью значка «Cost» (Затраты), который указывает на то, что вы поддерживаете эту функцию.

Реализация API InCost

Необходимые условия: Для соответствия требованиям InCost API вашей рекламной сети необходимо:

  • 90% кампаний содержат идентификатор кампании в атрибуции.
  • Возможность отправки данных не менее 6 раз в день для повышения актуальности данных. Конкретное время определяется рекламной сетью.
  • [Если рекламная сеть обновляет данные за прошлое время] Возможность отправлять данные за последние 7 дней каждый раз для повышения полноты данных.

Чтобы внедрить API InCost и начать отправлять данные о расходах в AppsFlyer:

  • Следуйте инструкциям в следующей таблице.
Шаг Действие 
1

Подать заявку на InCost:

  1. В AppsFlyer в верхнем меню выберите Помощь > Связаться с нашей командой.
    Откроется виджет помощи партнеру.
  2. Выберите Включение измерения расходов и отправьте свою информацию.
    После отправки откроется заявка на поддержку, и с вами свяжется инженер по партнерским решениям AppsFlyer.
2 Убедитесь, что иерархии кампаний (идентификатор кампании и, при необходимости, идентификатор набора объявлений и идентификатор объявления) включены в ваши ссылки атрибуции для более чем 90% вашего трафика.
3

Получите токен API AppsFlyer на дэшборде AppsFlyer.

4

Передайте токен API вашему разработчику для использования в заголовке авторизации API и попросите его следовать инструкциям по реализации 3 методов API:

  1. Получить список приложений
  2. Загрузить InCostСообщите разработчику, какие поля следует заполнить в JSON:
    • Обязательные поля должны быть заполнены. Это значит, что не следует отправлять пустые поля. 
    • Медиа-источником могут быть только такие источники, которые связаны с вашим аккаунтом рекламной сети (зарегистрированы в нем). Получите список у вашего менеджера по развитию партнеров.
    • Примите во внимание часовой пояс приложения (сообщенный через API для получения списка разрешений для приложения), чтобы согласовать даты данных о расходах с датами приложения.
    • Если есть поля, которые не являются частью иерархии отчетности по затратам вашей кампании, не включайте их. Например, идентификатор набора объявлений, название актива, идентификатор объявления, название объявления.
  3. Получить статус работы.
6

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

7

Убедитесь, что ваши рекламодатели активируют функцию получения данных о расходах на вкладке «Расходы» на своей странице интегрированного партнера AppsFlyer. Затем они начнут получать данные о расходах.

Поля для загрузки JSON для InCost

Поле

Обязательно

Примечания

date

Да

  • Дата расходов
  • Формат: YYYY-MM-DD
  • Пример:2019-12-30
app_id

Да

  • Идентификатор приложения, как он отображается на платформе AppsFlyer
  • Формат: Строка до 250 символов
  • Пример: Android:com.app.nameiOS: id123456789

media_source

Да

  • Имя сети (ID), которая показывает рекламу, связанную с вашим аккаунтом рекламной сети в AppsFlyer
  • Формат: Строка 50 символов
  • Пример: network_int

af_prt

Нет*

  • Требуется для данных об атрибуции и расходах агентства.
  • Название агентства, отображаемое в ссылке атрибуции и связанное с аккаунтом агентства в AppsFlyer.
  • Формат: Строка 50 символов
  • Пример: agencya

campaign_id

Да

  • Должен быть идентичен параметру af_c_id, отправленному в ссылке атрибуции
  • Пустая строка не допускается.
  • Формат: Строка 24 символа
  • Пример: 123abc

campaign_name

Да

  • Формат: Строка 100 символов
  • Пример: my_campaign123

adset_id

Нет*
  • Обязательно, если вы отправляете adset_name
  • Должен быть идентичен параметру af_adset_id, отправленному в ссылке атрибуции
  • Если ваш отчет о расходах не поддерживает adset_id, никогда не отправляй его
  • Формат: Строка 24 символа
  • Пример: 123A

adset_name

Нет

  • Если вы отправляете это поле, вы также должны отправить adset_id
  • Формат: Строка 100 символов
  • Пример:my_adset_name

ad_id

Нет*

  • Обязательно, если вы отправляете ad_name.
  • Это поле должно быть идентично параметру af_ad_id, отправленному в ссылке атрибуции
  • Если ваш отчет о расходах не поддерживает adset_id, никогда не отправляй его
  • Формат: Строка 24 символа
  • Пример:123AB

site_id

Нет

  • Уникальный идентификатор, определяющий издателя, показывающего рекламу.
  • Формат: Строка 24 символа.

ad_name

Нет

  • Если вы отправляете это поле, вы также должны отправить ad_id
  • Формат: Строка 100 символов
  • Пример:Ad-name

geo

Нет

  • Страна, которую вы записали как связанную с затратами
  • По возможности это должна быть страна, в которой было показано объявление.
  • Формат: Двухбуквенный код страны по ISO 3166
  • Пример:US, CN, ZA
currency

Да

  • Тип валюты расходов
  • Формат: Трехзначный код валюты по ISO 4217
  • Пример: USD, EUR, ZAR
spend Да
  • Сумма расходов в указанной валюте 
  • После десятичной точки допускается пять цифр
  • Допускается значение 0 (ноль)
  • Отрицательные значения НЕ допускаются
  • Не отправляйте разделители ,
  • Не отправляйте значения в кавычках 
  • Формат: Десятичное число
  • Примеры значений: 1 1.2 1234.20
channel Нет
  • Должен быть идентичен параметру af_channel, отправленному в ссылке атрибуции
  • Формат: Строка 20 симв.
  • Пример: my_channel
keywords Нет
  • Формат: Строка 100 симв.
  • Пример: abc app

* См. колонку «Примечания», так как в некоторых случаях это поле необходимо отправлять.