Интеграции с аналитическими сервисами
Adapty отправляет все события подписок в аналитические сервисы — например, Amplitude, Mixpanel и AppMetrica. Также можно настроить отправку событий на ваш сервер через интеграцию с webhook. Главное удобство в том, что вам не нужно отправлять события самостоятельно — мы сделаем это за вас. Просто настройте интеграцию в дашборде Adapty.
Adapty поддерживает интеграцию со следующими сторонними аналитическими сервисами:
Не нашли своего провайдера аналитики?
Сообщите нам! Создайте запрос на добавление функции, и мы рассмотрим его.
Свойства событий
События webhook отправляются в формате JSON. Все события имеют одинаковую структуру, но их поля различаются в зависимости от типа события, стора и вашей конфигурации.
| Свойство | Тип | Описание |
|---|---|---|
| profile_id | uuid | ID пользователя Adapty. |
| currency | str | Местная валюта (по умолчанию USD). |
| price_usd | float | Цена продукта до вычета комиссии Apple/Google. Выручка. |
| proceeds_usd | float | Цена продукта после вычета комиссии Apple/Google. Чистая выручка. |
| net_revenue_usd | float | Чистый доход (после вычета комиссии Apple/Google и налогов) в USD. Может быть пустым. |
| price_local | float | Цена продукта до вычета комиссии Apple/Google в местной валюте. Выручка. |
| proceeds_local | float | Цена продукта после вычета комиссии Apple/Google в местной валюте. Чистая выручка. |
| transaction_id | str | Уникальный идентификатор транзакции (покупки или продления). |
| original_transaction_id | str | Идентификатор транзакции исходной покупки. |
| purchase_date | ISO 8601 date | Дата и время покупки продукта. |
| original_purchase_date | ISO 8601 date | Дата и время исходной покупки. |
| environment | str | Может быть Sandbox или Production. |
| vendor_product_id | str | ID продукта в Apple App Store, Google Play Store или Stripe. |
| base_plan_id | str | ID базового плана в Google Play Store или ID цены в Stripe. |
| event_datetime | ISO 8601 date | Дата и время события. |
| store | str | Может быть app_store или play_store. |
| trial_duration | str | Длительность пробного периода в днях. Формат: « days», например «7 days». |
| cancellation_reason | str | Причина отмены подписки пользователем. Возможные значения: iOS и Android: voluntarily_cancelled, billing_error, refund iOS: price_increase, product_was_not_available, unknown Android: new_subscription_replace, cancelled_by_developer |
| subscription_expires_at | ISO 8601 date | Дата истечения подписки. Как правило, в будущем. |
| consecutive_payments | int | Количество периодов непрерывной подписки пользователя, включая текущий. |
| rate_after_first_year | bool | Признак того, что подписка соответствует условиям пониженной комиссии (обычно 15%) после одного года непрерывного продления. Ставки комиссии зависят от участия в программе и страны. Подробнее см. в разделе Комиссия стора и налоги. |
| promotional_offer_id | str | ID promotional offer, указанный в разделе Product дашборда Adapty. |
| store_offer_category | str | Может быть introductory или promotional. |
| store_offer_discount_type | str | Может быть free_trial, pay_as_you_go или pay_up_front. |
| paywall_name | str | Название пейвола, с которого была совершена транзакция. |
| paywall_revision | int | Ревизия пейвола, с которого была совершена транзакция. Значение равно 1. |
| developer_id | str | Developer (SDK) ID плейсмента, с которого была совершена транзакция. |
| ab_test_name | str | Название A/B-теста, в рамках которого была совершена транзакция. |
| ab_test_revision | int | Ревизия A/B-теста, в рамках которого была совершена транзакция. Значение равно 1. |
| cohort_name | str | Название аудитории, к которой принадлежит профиль. |
| profile_event_id | uuid | Уникальный ID события для дедупликации. |
| store_country | str | Страна, переданная нам стором. |
| profile_ip_address | str | IP профиля (может быть IPv4 или IPv6; предпочтение отдаётся IPv4). Обновляется при каждом изменении IP устройства. |
| profile_country | str | Определяется Adapty на основе IP профиля. |
| profile_total_revenue_usd | float | Общая выручка по профилю с учётом возвратов. |
| variation_id | uuid | Уникальный ID пейвола, на котором была совершена покупка. |
| access_level_id | str | ID платного уровня доступа. |
| is_active | bool | Признак того, что платный уровень доступа активен для профиля. |
| will_renew | bool | Признак того, что платный уровень доступа будет продлён. |
| is_refund | bool | Признак того, что транзакция возвращена. |
| is_lifetime | bool | Признак того, что платный уровень доступа является пожизненным. |
| is_in_grace_period | bool | Признак того, что профиль находится в льготном периоде. |
| starts_at | ISO 8601 date | Дата и время начала платного уровня доступа для пользователя. |
| renewed_at | ISO 8601 date | Дата и время продления платного доступа. |
| expires_at | ISO 8601 date | Дата и время истечения платного доступа. |
| activated_at | ISO 8601 date | Дата и время активации платного доступа. |
| billing_issue_detected_at | ISO 8601 date | Дата и время обнаружения проблемы с оплатой. |
| profile_has_access_level | Bool | Признак того, что у профиля есть активный уровень доступа (только для Webhook). |
Каждое событие содержит следующие свойства:
transaction_id, original_transaction_id, purchase_date, original_purchase_date, environment, vendor_product_id, event_datetime, store.
Кроме того, некоторые события содержат дополнительные свойства. Для событий subscription_refunded и non_subscription_purchase_refunded обязательно нужно передавать значения price_usd и proceeds_usd.
| Название события | Свойства |
|---|---|
| subscription_initial_purchase | price_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration |
| subscription_renewed | price_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration |
| subscription_cancelled | cancellation_reason, trial_duration |
| trial_started | subscription_expires_at, trial_duration |
| trial_converted | price_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration |
| trial_cancelled | cancellation_reason, trial_duration |
| non_subscription_purchase | price_usd, proceeds_usd |
| billing_issue_detected | subscription_expires_at, trial_duration |
| entered_grace_period | subscription_expires_at, trial_duration |
Пример события
{
"price_usd": 9.99,
"proceeds_usd": 6.99,
"transaction_id": "1000000628581600",
"original_transaction_id": "1000000628581600",
"purchase_date": "2020-02-18T18:40:22.000000+0000",
"original_purchase_date": "2020-02-18T18:40:22.000000+0000",
"environment": "Sandbox",
"vendor_product_id": "premium",
"event_datetime": "2020-02-18T18:40:22.000000+0000",
"store": "app_store"
}
Adapty отправляет события на ваш сервер и в сторонние аналитические системы.
Свойство profile_ip_address синхронизируется с текущим IP устройства. При каждом обращении SDK к серверам Adapty IP обновляется, если он отличается от сохранённого.
Настройка идентификатора профиля
- Задайте идентификатор профиля для выбранной аналитики с помощью инструкций для инструкции по установке атрибутов пользователя в вашем приложении iOS, Android, React Native, Flutter и Unity .
Предотвращение дублирования
Не забудьте отключить отправку событий подписок с устройств и вашего сервера, чтобы избежать дублирования.
Отключение внешней аналитики для конкретного пользователя
В некоторых случаях может потребоваться прекратить отправку аналитических событий для конкретного пользователя — например, если в вашем приложении есть возможность отказаться от аналитики.
Чтобы отключить внешнюю аналитику для пользователя, используйте метод updateProfile(). Создайте объект AdaptyProfileParameters.Builder и установите соответствующее значение.
Когда внешняя аналитика заблокирована, Adapty не будет отправлять никакие события ни в одну интеграцию для этого пользователя. Если вы хотите отключить интеграцию для всех пользователей приложения, просто выключите её в дашборде Adapty.