Типы и поля событий вебхука

Adapty отправляет вебхуки в ответ на события подписки. В этом разделе описаны типы событий и данные, которые содержатся в каждом вебхуке.

Типы событий вебхука

Вы можете отправлять в вебхук все типы событий или выбрать только нужные. Ознакомьтесь с нашими потоками событий, чтобы понять, какие данные ожидать и как выстроить вокруг них бизнес-логику. Ненужные типы событий можно отключить при настройке интеграции с вебхуком. Там же можно заменить стандартные идентификаторы событий Adapty на собственные, если это необходимо.

Название событияОписание
subscription_startedСрабатывает, когда пользователь активирует платную подписку без пробного периода — то есть с немедленным списанием.
subscription_activeПодтверждает, что подписка всё ещё активна после события subscription_started. Вы задаёте количество дней между началом подписки и этой проверкой. Событие приходит, если подписка активна, в том числе когда пользователь вошёл в льготный период. Если к моменту проверки подписка завершилась или пользователь отключил автопродление, событие не поступает и Adapty больше не проверяет. Событие относится только к подпискам, оформленным без пробного периода. Конвертация триала отправляет trial_converted, которое проверку не запускает.
subscription_renewedПроисходит при продлении подписки и списании средств. Фиксируется начиная со второго платёжного периода — как для подписок с пробным периодом, так и без него.
subscription_renewal_cancelledПользователь отключил автопродление подписки. Доступ к премиум-функциям сохраняется до конца оплаченного периода.
subscription_renewal_reactivatedСрабатывает, когда пользователь снова включает автопродление подписки.
subscription_expiredСрабатывает, когда подписка полностью завершается после отмены. Например, если пользователь отменил подписку 12 декабря, но она оставалась активной до 31 декабря, событие фиксируется 31 декабря, когда подписка истекает.
subscription_pausedПроисходит, когда пользователь активирует паузу подписки (только Android).
subscription_deferredСрабатывает, когда вы бесплатно продлеваете подписку пользователя: через отсрочку по Google Play Developer API или через продление даты продления по App Store Server API. Доступ к премиум-функциям сохраняется до новой даты продления.
non_subscription_purchaseЛюбая разовая покупка: пожизненный доступ или расходуемая покупка, например внутриигровая валюта.
trial_startedСрабатывает, когда пользователь активирует пробную подписку.
trial_activeПодтверждает, что триал всё ещё активен после события trial_started. Вы задаёте количество дней между началом триала и этой проверкой. Событие приходит, если триал ещё идёт. Если к моменту проверки триал завершился или конвертировался, либо пользователь отключил автопродление, событие не поступает и Adapty больше не проверяет.
trial_convertedПроисходит, когда триал завершается и с пользователя списываются средства (первая оплата). Например, если у пользователя триал до 14 января, но списание происходит 7 января, событие фиксируется 7 января.
trial_renewal_cancelledПользователь отключил автопродление подписки во время пробного периода. Доступ к премиум-функциям сохраняется до конца триала, но списания не будет и подписка не оформится.
trial_renewal_reactivatedПроисходит, когда пользователь снова включает автопродление подписки во время пробного периода.
trial_expiredСрабатывает, когда триал завершается без конвертации в подписку.
entered_grace_periodПроисходит, когда попытка списания не удаётся и пользователь входит в льготный период (если он включён). На это время доступ к премиум-функциям сохраняется.
billing_issue_detectedСрабатывает при ошибке оплаты во время попытки списания (например, недостаточно средств на карте).
subscription_refundedСрабатывает при возврате средств за подписку (например, по запросу в Apple Support).
non_subscription_purchase_refundedСрабатывает при возврате средств за разовую покупку.
access_level_updatedПроисходит при изменении уровня доступа пользователя.
Note

subscription_renewal_reactivated содержит предыдущий идентификатор продукта — тот, который был активен на момент отмены, — даже если пользователь впоследствии реактивировал подписку, купив другой продукт. Apple сохраняет один и тот же original_transaction_id на протяжении всей цепочки «отмена → реактивация», поэтому событие отражает исходный продукт. Новый продукт появится в следующем событии subscription_renewed, когда начнётся списание за новый продукт.

Note

В Google Play Adapty может отправить событие subscription_started со всеми денежными полями, равными нулю — например, когда Google заменяет одну подписку другой или когда подписка начинается с бесплатного периода. Не учитывайте такие события как доход. При замене подписки Google выдаёт новый токен покупки, поэтому Adapty фиксирует оплаченную транзакцию с другим store_transaction_id.

Структура события вебхука

Adapty будет отправлять только те события, которые вы выбрали в разделе Events names на странице Integrations -> Webhooks.

События webhook сериализуются в JSON. Тело POST-запроса к вашему серверу будет содержать сериализованное событие, обёрнутое в структуру ниже. Все события следуют одной и той же структуре, но их поля различаются в зависимости от типа события, стора и вашей конкретной конфигурации. Атрибуты пользователя — это пользовательские атрибуты, которые вы настроили, поэтому они содержат именно те данные, которые вы задали. Поля данных атрибуции одинаковы для всех типов событий, однако список атрибуций зависит от того, какие источники атрибуции вы используете в мобильном приложении. Ниже приведён пример события:

{
  "profile_id": "00000000-0000-0000-0000-000000000000",
  "customer_user_id": "UserIdInYourSystem",
  "idfv": "00000000-0000-0000-0000-000000000000",
  "idfa": "00000000-0000-0000-0000-000000000000",
  "advertising_id": "00000000-0000-0000-0000-000000000000",
  "profile_install_datetime": "2000-01-31T00:00:00.000000+0000",
  "user_agent": "ExampleUserAgent/1.0 (Device; OS Version) Browser/Engine",
  "email": "john.doe@company.com",
  "event_type": "subscription_started",
  "event_datetime": "2000-01-31T00:00:00.000000+0000",
  "event_properties": {
    "store": "play_store",
    "currency": "USD",
    "price_usd": 4.99,
    "profile_id": "00000000-0000-0000-0000-000000000000",
    "cohort_name": "All Users",
    "environment": "Production",
    "price_local": 4.99,
    "original_price_usd": 4.99,
    "original_price_local": 4.99,
    "discount_amount_usd": 0,
    "discount_amount_local": 0,
    "base_plan_id": "b1",
    "developer_id": "onboarding_placement",
    "ab_test_id": "00000000-0000-0000-0000-000000000000",
    "ab_test_name": "onboarding_ab_test",
    "ab_test_revision": 1,
    "ab_test_variant_id": "00000000-0000-0000-0000-000000000000",
    "ab_test_variant_name": "Variant B",
    "paywall_name": "UsedPaywall",
    "proceeds_usd": 4.2315,
    "variation_id": "00000000-0000-0000-0000-000000000000",
    "purchase_date": "2024-11-15T10:45:36.181000+0000",
    "store_country": "AR",
    "event_datetime": "2000-01-31T00:00:00.000000+0000",
    "proceeds_local": 4.2415,
    "tax_amount_usd": 0,
    "transaction_id": "0000000000000000",
    "net_revenue_usd": 4.2415,
    "profile_country": "AR",
    "paywall_revision": "1",
    "profile_event_id": "00000000-0000-0000-0000-000000000000",
    "tax_amount_local": 0,
    "net_revenue_local": 4.2415,
    "vendor_product_id": "onemonth_no_trial",
    "profile_ip_address": "10.10.1.1",
    "consecutive_payments": 1,
    "rate_after_first_year": false,
    "original_purchase_date": "2000-01-31T00:00:00.000000+0000",
    "original_transaction_id": "0000000000000000",
    "subscription_expires_at": "2000-01-31T00:00:00.000000+0000",
    "profile_has_access_level": true,
    "profile_total_revenue_usd": 4.99,
    "promotional_offer_id": null,
    "store_offer_category": null,
    "store_offer_discount_type": null
  },
  "event_api_version": 1,
  "profiles_sharing_access_level": [{"profile_id": "00000000-0000-0000-0000-000000000000", "customer_user_id": "UserIdInYourSystem"}],
   "attributions": {
    "appsflyer": {
      "ad_set": "Keywords 1.12",
      "status": "non_organic",
      "channel": "Google Ads",
      "ad_group": null,
      "campaign": "Social media influencers - Rest of the world",
      "creative": null,
      "created_at": "2000-01-31T00:00:00.000000+0000"
    }
  },
  "user_attributes": {"Favourite_color": "Violet", "Pet_name": "Fluffy"},
  "integration_ids": {"firebase_app_instance_id": "val1", "branch_id": "val2", "one_signal_player_id": "val3"},
  "play_store_purchase_token": {
    "product_id": "product_123",
    "purchase_token": "token_abc_123",
    "is_subscription": true
  }
}

Поля события

Параметры события одинаковы для всех типов событий.

ПолеТипОписание
advertising_idUUIDAdvertising ID (только Android).
attributionsJSONДанные атрибуции. Включается, если в настройках вебхука включён параметр Send Attribution.
customer_user_idStringID пользователя из вашего приложения (UUID, email или другой идентификатор), если вы задаёте его в коде приложения при идентификации пользователей. Если пользователи не идентифицируются или конкретный пользователь анонимен (не вошёл в систему), поле равно null.
emailStringEmail пользователя, если вы задаёте его с помощью метода updateProfile в SDK Adapty или при создании/обновлении профилей через серверный API. Если значение email не передаётся в метод SDK или API, поле равно null.
event_api_versionIntegerВерсия API Adapty (текущая: 1).
event_datetimeISO 8601Фактическое (бизнес-) время события: например, дата покупки для события покупки или дата истечения для события истечения — не момент получения или отправки события в Adapty. Формат ISO 8601 (например, 2020-07-10T15:00:00.000000+0000). Подробнее о порядке событий см. примечание ниже.
event_propertiesJSONСвойства события.
event_typeStringНазвание события в формате Adapty. Полный список см. в разделе Типы событий вебхука.
idfaUUIDAdvertising ID (только Apple). IDFA в профиле в дашборде Adapty. Может быть null, если недоступен из-за ограничений отслеживания, детского режима или настроек конфиденциальности.
idfvUUIDIdentifier for Vendors (IDFV), уникальный для каждого разработчика. IDFV в профиле в дашборде Adapty.
integration_idsJSONИдентификаторы интеграций пользователя, если вы задаёте их с помощью метода setIntegrationIdentifier в SDK Adapty или при создании/обновлении профилей через серверный API. null, если недоступно или интеграции отключены.
play_store_purchase_tokenJSONТокен покупки Play Store. Включается, если в настройках вебхука включён параметр Send Play Store purchase token.
profile_idUUIDID профиля, автоматически генерируемый Adapty для каждого профиля. Один Apple/Google ID может быть связан с разными profile ID, если пользователи не идентифицируются или совершают покупки до входа в систему. Подробнее о том, как Adapty работает с родительскими и производными профилями.
profile_install_datetimeISO 8601Временная метка установки в формате ISO 8601 (например, 2020-07-10T15:00:00.000000+0000).
profiles_sharing_access_levelJSONСписок пользователей, совместно использующих уровень доступа, за исключением текущего профиля. Если совместное использование уровней доступа включено для вашего приложения, список содержит другие профили, привязанные к тому же Apple/Google ID.
Формат:
  • profile_id: (UUID) Adapty ID
  • customer_user_id: (String) Customer User ID, если указан
user_agentStringUser-agent браузера устройства.
user_attributesJSONПользовательские данные для обогащения профилей информацией, специфичной для приложения. Обычно используются для отслеживания предпочтений пользователя (например, тема, язык) или поведенческих флагов (завершение онбординга, использование функций).
Задаются в формате ключ-значение, где ключи — строки, а значения — строки или числа (например, {"Favourite_color": "Violet", "Pet_name": "Fluffy"}).
Пользовательские атрибуты можно задавать вручную в дашборде Adapty для отдельных профилей, программно через метод updateProfile в SDK Adapty или через серверный API при создании/обновлении профилей.
Включается, если в настройках вебхука включён параметр Send User Attributes.

Хотя в коде мобильного приложения значения пользовательских атрибутов могут задаваться как float или строки, атрибуты, полученные через серверный API или исторический импорт, могут иметь другие форматы. В этом случае булевы и целочисленные значения будут преобразованы в float.

Note

event_datetime отражает момент, когда событие произошло в жизненном цикле подписки, а не когда Adapty его обработал или доставил. Из-за этого события могут иметь одинаковое значение event_datetime или поступать не в хронологическом порядке. Например, событие subscription_expired может иметь более раннее значение event_datetime, чем событие subscription_renewal_cancelled, которое Adapty доставит раньше него. Не используйте event_datetime для упорядочивания событий. Вместо этого сортируйте события по времени получения на своей стороне и дедуплицируйте их с помощью profile_event_id или идентификаторов транзакций.

Атрибуции

Чтобы отправлять данные атрибуции, включите опцию Send Attribution на странице Integrations -> Webhooks. Если вы включили отправку данных атрибуции и настроили интеграции атрибуции, данные ниже будут отправляться вместе с событием для каждого источника. Одни и те же данные атрибуции отправляются для всех типов событий.

{
  "attributions": {
    "appsflyer": {
      "ad_set": "sample_ad_set_123",
      "status": "non_organic",
      "channel": "sample_channel",
      "ad_group": "sample_ad_group_456",
      "campaign": "sample_ios_campaign",
      "creative": "sample_creative_789",
      "created_at": "2000-01-31T00:00:00.000000+0000",
      "network_user_id": "0000000000000-0000000"
    }
  }
}
Название поляТип поляОписание
ad_setStringРекламный набор атрибуции.
statusStringМожет быть organic, non_organic, или unknown.
channelStringНазвание маркетингового канала.
ad_groupStringРекламная группа атрибуции.
campaignStringНазвание маркетинговой кампании.
creativeStringКлючевое слово креатива атрибуции.
created_atISO 8601 dateДата и время создания записи атрибуции.
network_user_idStringID, присвоенный пользователю источником атрибуции.

Integration IDs

В событиях сейчас используются следующие integration ID:

  • adjust_device_id
  • airbridge_device_id
  • amplitude_device_id
  • amplitude_user_id
  • appmetrica_device_id
  • appmetrica_profile_id
  • appsflyer_id
  • branch_id
  • facebook_anonymous_id
  • firebase_app_instance_id
  • mixpanel_user_id
  • pushwoosh_hwid
  • one_signal_player_id
  • one_signal_subscription_id
  • tenjin_analytics_installation_id
  • posthog_distinct_user_id
  • singular_sdid

Токен покупки Play Store

Это поле содержит все данные, необходимые для повторной валидации покупки при необходимости. Оно отправляется только если включена опция Send Play Store purchase token в настройках интеграции с Webhook.

FieldTypeDescription
product_idStringУникальный идентификатор продукта (SKU), приобретённого в Play Store.
purchase_tokenStringТокен, сгенерированный Google Play для уникальной идентификации транзакции покупки.
is_subscriptionBooleanУказывает, является ли приобретённый продукт подпиской (true) или разовой покупкой (false).

Свойства событий

Свойства событий могут различаться в зависимости от типа события и даже между событиями одного типа. Например, событие из App Store не будет содержать Android-специфичные свойства, такие как base_plan_id.

У события Access Level Updated есть особые свойства, поэтому мы выделили для него отдельный раздел. Аналогично, мы вынесли Дополнительные свойства событий налогов и выручки в отдельный раздел, поскольку они характерны лишь для отдельных типов событий.

Для большинства типов событий

Свойства событий для большинства типов событий одинаковы (кроме события Access Level Updated, которое описано в отдельном разделе). Ниже представлена подробная таблица свойств с указанием, к каким событиям они относятся.

Note

Adapty конвертирует другие валюты в USD по курсу currencylayer.com (обновляется каждые 8 часов). Курс фиксируется на момент транзакции — последующие изменения не влияют на результат конвертации.

ПолеТипОписание
ab_test_idUUIDID A/B-теста Adapty, в котором была совершена транзакция. Для кросс-плейсментного A/B-теста — ID кросс-плейсментного теста, одинаковый для каждого плейсмента. См. Поля флоу и A/B-теста.
ab_test_nameStringНазвание A/B-теста Adapty, в котором была совершена транзакция. Для кросс-плейсментного A/B-теста — название теста на одном плейсменте в формате <test name> child-N, где N — номер плейсмента, а не варианта. Чтобы группировать кросс-плейсментный тест по плейсментам, используйте ab_test_id и берите его название из ab_test_parent_name.
ab_test_parent_nameStringНазвание кросс-плейсментного A/B-теста, в котором была совершена транзакция. Присутствует только для кросс-плейсментных A/B-тестов.
ab_test_revisionIntegerРевизия A/B-теста, в котором была совершена транзакция.
ab_test_variant_idUUIDID варианта A/B-теста, в котором была совершена транзакция. В обычном A/B-тесте пейвола совпадает с variation_id. В A/B-тесте флоу совпадает с flow_variation_id. В кросс-плейсментном A/B-тесте одинаков для варианта на каждом плейсменте. Используйте его для разбивки транзакций по варианту теста.
ab_test_variant_nameStringНазвание варианта A/B-теста. Для кросс-плейсментного A/B-теста — название варианта из настроек теста. Для остальных тестов — название варианта, либо название пейвола или флоу, если у варианта нет имени. Присутствует вместе с ab_test_variant_id.
base_plan_idStringID базового плана в Google Play Store или ID цены в Stripe.
cancellation_reasonString

Возможные причины отмены: voluntarily_cancelled, billing_error, price_increase, product_was_not_available, refund, cancelled_by_developer, new_subscription_replace, upgraded, unknown, adapty_revoked.

Присутствует в следующих типах событий:

subscription_cancelled, subscription_refunded и trial_cancelled.
cohort_nameStringНазвание аудитории, которая определила, какой пейвол был показан пользователю.
consecutive_paymentsIntegerКоличество периодов, в течение которых пользователь непрерывно подписан. Включает текущий период.
currencyStringЛокальная валюта. null в trial_started, если не включена опция Send trial price. См. Дополнительные свойства событий налогов и выручки.
developer_idStringID плейсмента, в котором была совершена транзакция.
discount_amount_localFloatСкидка, применённая к транзакции: стандартная цена минус фактически списанная сумма до вычета комиссии Apple/Google, в локальной валюте. 0 для покупки по полной цене. Для бесплатного пробного периода равна полной стандартной цене (original_price_local), поскольку ничего не списывается. null, если скидка была применена, но стандартная цена неизвестна (см. original_price_local). Всегда null для App Store pay-up-front предложений: единовременный платёж охватывает несколько расчётных периодов, поэтому его нельзя сравнить со стандартной ценой за один период.
discount_amount_usdFloatЗначение discount_amount_local в USD.
environmentStringВозможные значения: Sandbox или Production.
event_datetimeISO 8601 dateДата и время события. Совпадает со значением на корневом уровне события.
flow_idUUIDID флоу, в котором была совершена транзакция. Присутствует для каждой транзакции, совершённой во флоу, — независимо от того, является ли она частью A/B-теста.
flow_nameStringНазвание флоу, в котором была совершена транзакция. Присутствует вместе с flow_id.
flow_variation_idUUIDID варианта флоу на данном плейсменте. Это то же значение, которое SDK возвращает приложению как flow.variationId. Присутствует вместе с flow_id.
original_price_localFloatСтандартная цена продукта без скидки до вычета комиссии Apple/Google, в локальной валюте. Для подписок — это цена продления. Равна price_local для покупки по полной цене и всегда равна price_local для разовых покупок, поскольку сторы не предоставляют отдельную стандартную цену для них. null для покупки со скидкой, если стор не сообщает достоверную стандартную цену (например, автопродление отключено, продление всё ещё содержит предложение или ожидается смена продукта).
original_price_usdFloatТо же, что original_price_local, в USD.
original_purchase_dateISO 8601 dateДля периодических подписок первоначальная покупка — это первая транзакция в цепочке; её ID (original transaction ID) связывает цепочку продлений, а последующие транзакции являются её продолжением. Дата первоначальной покупки — это дата и время этой первой транзакции.
original_transaction_idString

Для периодических подписок это ID первоначальной транзакции, связывающий цепочку продлений. Первоначальная транзакция — первая в цепочке; последующие транзакции являются её продолжением.

Если продлений не было, original_transaction_id совпадает с store_transaction_id.

paywall_nameStringНазвание пейвола, в котором была совершена транзакция. Для флоу — это ID экрана пейвола внутри флоу (scr_...), а не название. Название флоу находится в flow_name.
paywall_revisionStringРевизия пейвола, в котором была совершена транзакция. Значение по умолчанию — 1.
price_localFloatСумма, списанная за транзакцию до вычета комиссии Apple/Google, в локальной валюте. null в trial_started, поскольку ничего не списывается, если не включена опция Send trial price.
price_usdFloatСумма, списанная за транзакцию до вычета комиссии Apple/Google, в USD. null в trial_started, поскольку ничего не списывается, если не включена опция Send trial price.
profile_countryStringОпределяется Adapty на основе IP-адреса профиля.
profile_event_idUUIDУникальный ID события, который можно использовать для дедупликации.
profile_has_access_levelBooleanБулево значение, указывающее, есть ли у профиля активный уровень доступа.
profile_idUUIDID профиля, сгенерированный Adapty. Совпадает со значением на корневом уровне события.
profile_ip_addressStringIP-адрес профиля (может быть IPv4 или IPv6; при наличии предпочтение отдаётся IPv4). null, если опция Collect users’ IP addresses отключена в настройках приложения.
profile_total_revenue_usdFloatОбщая выручка по профилю с вычтенными возвратами средств.
promotional_offer_idStringAdapty ID использованного promotional offer. Этот ID вы задаёте при создании предложения в дашборде.
purchase_dateISO 8601 dateДата и время покупки продукта.
rate_after_first_yearBooleanБулево значение, указывающее, что подписка соответствует условиям сниженной комиссии (как правило, 15%) после одного года непрерывного продления. Размер комиссии зависит от участия в программе и страны. Подробнее см. в разделе Комиссия стора и налоги.
storeStringСтор, в котором был куплен продукт. Стандартные значения: app_store, play_store, stripe, paddle.
Если вы задаёте пользовательские транзакции стора через серверный API, используется значение из параметра store.
store_countryStringСтрана, переданная нам магазином приложений.
store_offer_categoryStringПрименённая категория предложения. Возможные значения: introductory, promotional, winback.
store_offer_discount_typeStringПрименённый тип предложения. Возможные значения: free_trial, pay_as_you_go и pay_up_front.
store_offer_number_of_periodsIntegerКоличество базовых расчётных периодов, на которые распространяется скидка предложения (1 или более). Присутствует только при наличии предложения. null для App Store pay-up-front предложений и в случаях, когда стор не сообщает продолжительность предложения.
subscription_expires_atISO 8601 date

Дата истечения подписки.

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

transaction_idStringУникальный идентификатор транзакции.
trial_durationStringПродолжительность пробного периода в днях. Передаётся в формате « days», например «7 days». Присутствует только в типах событий, связанных с пробным периодом: trial_started, trial_converted, trial_cancelled.
variation_idUUIDУникальный ID пейвола, в котором была совершена покупка. Для флоу — это ID экрана пейвола внутри флоу, а не вариант A/B-теста. Каждая опубликованная версия флоу получает новые ID экранов, поэтому Adapty со временем отправляет один вариант с разными значениями variation_id. Для разбивки транзакций по варианту теста используйте ab_test_variant_id.
vendor_product_idString

ID продукта в Apple App Store, Google Play Store или Stripe.

Для 12-месячного плана с обязательством значение имеет вид <product_id>:monthly.

Если доступ был предоставлен без реальной транзакции в сторе, vendor_product_id будет одним из следующих:

Поля флоу и A/B-теста

Поля флоу и A/B-теста показывают, из какого флоу, A/B-теста и варианта пришла транзакция. Они работают для всех типов A/B-тестов: обычных A/B-тестов на пейволах и флоу, а также кросс-плейсментных A/B-тестов на пейволах и флоу.

Adapty отправляет эти поля в событиях транзакции, совершённой на плейсменте, — тех же событиях, которые содержат developer_id и variation_id. Продления, возвраты, отмены и другие события подписки содержат тот же флоу, A/B-тест и вариант, что и исходная покупка, даже после завершения A/B-теста. Если поле не имеет значения, оно не включается в событие: эти поля никогда не бывают пустыми или null.

Источник транзакцииflow_id, flow_name, flow_variation_idab_test_idab_test_variant_id, ab_test_variant_nameab_test_parent_name
Обычный A/B-тест пейвола—ID A/B-тестаСовпадает с variation_id—
Пейвол вне A/B-теста————
A/B-тест флоу✅ID A/B-тестаСовпадает с flow_variation_id—
Флоу вне A/B-теста✅———
Кросс-плейсментный A/B-тест на пейволах—ID кросс-плейсментного тестаОбщий для всех плейсментов✅
Кросс-плейсментный A/B-тест на флоу✅, с вариантом флоу на этом плейсментеID кросс-плейсментного тестаОбщий для всех плейсментов✅
Не плейсмент————

Например, для покупки в варианте A на втором плейсменте межплейсментного A/B-теста на флоу Adapty отправляет:

{
  "variation_id": "<paywall screen ID on this placement>",
  "ab_test_name": "Onboarding test child-1",
  "paywall_name": "scr_a1b2c3d4",
  "flow_id": "<flow ID>",
  "flow_name": "Onboarding X",
  "flow_variation_id": "<variant A on this placement>",
  "ab_test_id": "<crossplacement test ID>",
  "ab_test_variant_id": "<variant A, shared by all placements>",
  "ab_test_variant_name": "A",
  "ab_test_parent_name": "Onboarding test"
}

Чтобы строить отчёты по этим полям, группируйте транзакции по ID (ab_test_id, ab_test_variant_id, flow_id) и используйте названия в качестве меток. Adapty берёт названия в момент отправки события, поэтому после переименования теста, варианта или флоу новые события будут содержать новое название. Уже отправленные события не отправляются повторно и не обновляются.

Note

Общий ID варианта кросс-плейсментного A/B-теста совпадает с ID варианта только на одном плейсменте — как правило, на первом. Чтобы сопоставить событие с вариантом, который SDK вернул для конкретного плейсмента, используйте flow_variation_id или variation_id.

Warning

В кросс-плейсментном A/B-тесте, где один и тот же флоу присутствует в нескольких вариантах, по одной только покупке невозможно определить, в каком варианте находился пользователь. Adapty берёт вариант из записи о назначении пользователя. Если эта запись недоступна, Adapty отправляет flow_id, flow_name и ab_test_id, но не flow_variation_id, ab_test_variant_id и ab_test_variant_name. Это происходит, когда пользователь совершает покупку сразу после просмотра флоу, до сохранения записи, а также при возобновлениях, которые происходят уже после истечения срока действия записи. Дашборд Adapty учитывает такие транзакции в первом варианте, поэтому данные интеграции могут расходиться с данными дашборда.

Дополнительные свойства событий для налогов и выручки

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

Типы событий, имеющие свойства событий для налогов и выручки:

  • subscription_renewed
  • subscription_initial_purchase (также называется subscription_started — одно и то же событие)
  • subscription_refunded
  • non_subscription_purchase
  • non_subscription_purchase_refunded
  • trial_started
  • trial_converted
ПолеТипОписание
net_revenue_localFloatЧистая выручка (доход после вычета комиссии Apple/Google и налогов) в местной валюте.
net_revenue_usdFloatЧистая выручка (доход после вычета комиссии Apple/Google и налогов) в USD.
proceeds_localFloatprice_local после вычета комиссии Apple/Google.
proceeds_usdFloatprice_usd после вычета комиссии Apple/Google.
tax_amount_localFloatРасчётный налог, включённый в price_local. 0 для Stripe и Paddle, даже если пользователь платил налог.
tax_amount_usdFloatРасчётный налог, включённый в price_usd. 0 для Stripe и Paddle, даже если пользователь платил налог.

Для чистой выручки используйте net_revenue_* напрямую. Если tax_amount_* не равно 0, то proceeds_* минус tax_amount_* даёт меньшую сумму. Например, при цене 12, комиссии 30% и ставке налога 20% Adapty вычисляет:

  • proceeds_* = price_* × (1 − комиссия) = 12 × 0.7 = 8.40
  • tax_amount_* = price_* × ставка налога ÷ (1 + ставка налога) = 12 × 0.2 ÷ 1.2 = 2.00
  • net_revenue_* = proceeds_* ÷ (1 + ставка налога) = 8.40 ÷ 1.2 = 7.00

Бесплатный пробный период не предполагает списания средств, поэтому в trial_started поля с ценой (price_*, proceeds_*, net_revenue_*, tax_amount_*) и currency по умолчанию равны null. Чтобы получать их, включите Send trial price в настройках вебхука. Adapty рассчитает их на основе цены подписки, умноженной на Trial price percentage, и передаст currency. Эти значения описывают подписку, а не фактическое списание, поэтому не включайте trial_started в итоги по выручке.

Пример полезной нагрузки non_subscription_purchase

non_subscription_purchase следует той же структуре, что и события подписки, но отражает разовую или расходуемую покупку. Поля, применимые только к подпискам, отсутствуют: cancellation_reason, will_renew, is_in_grace_period, is_refund, is_lifetime и trial_duration. Поле subscription_expires_at присутствует, но имеет значение null. Поля налогов и выручки (net_revenue_*, proceeds_*, tax_amount_*) включены.

Пример payload (нажмите, чтобы раскрыть)
{
  "profile_id": "00000000-0000-0000-0000-000000000000",
  "customer_user_id": "UserIdInYourSystem",
  "event_type": "non_subscription_purchase",
  "event_datetime": "2000-01-31T00:00:00.000000+0000",
  "event_properties": {
    "store": "app_store",
    "currency": "USD",
    "price_usd": 4.99,
    "price_local": 4.99,
    "original_price_usd": 4.99,
    "original_price_local": 4.99,
    "discount_amount_usd": 0,
    "discount_amount_local": 0,
    "proceeds_usd": 4.2415,
    "proceeds_local": 4.2415,
    "net_revenue_usd": 4.2415,
    "net_revenue_local": 4.2415,
    "tax_amount_usd": 0,
    "tax_amount_local": 0,
    "profile_id": "00000000-0000-0000-0000-000000000000",
    "environment": "Production",
    "vendor_product_id": "100coins",
    "transaction_id": "0000000000000000",
    "original_transaction_id": "0000000000000000",
    "purchase_date": "2024-11-15T10:45:36.181000+0000",
    "original_purchase_date": "2024-11-15T10:45:36.181000+0000",
    "subscription_expires_at": null,
    "store_country": "US",
    "profile_country": "US",
    "profile_ip_address": "10.10.1.1",
    "profile_has_access_level": false,
    "profile_total_revenue_usd": 4.99,
    "consecutive_payments": 1,
    "rate_after_first_year": false,
    "profile_event_id": "00000000-0000-0000-0000-000000000000"
  },
  "event_api_version": 1
}

Для события Access Level Updated

Событие Access Level Updated — это специфическое webhook-событие, которое генерируется только при активной интеграции Webhook и включённом типе этого события. Если оно включено, оно отправляется на настроенный Webhook и отображается в Event Feed. Если не включено, событие не создаётся.

Если вы включили общий доступ к уровням доступа, событие access level updated будет отправлено для всех профилей, имеющих доступ к данному уровню доступа.

Tip

Используйте это событие для обновления уровня доступа пользователя в вашей базе данных, предоставления или отзыва премиум-функций на бэкенде и синхронизации доступа между устройствами или платформами.

СвойствоТипОписание
ab_test_idUUIDID A/B-теста, в котором была совершена транзакция. См. Поля флоу и A/B-теста.
ab_test_nameStringНазвание A/B-теста, в котором была совершена транзакция. Для кросс-плейсментного A/B-теста — название теста на одном плейсменте (<название теста> child-N).
ab_test_parent_nameStringНазвание кросс-плейсментного A/B-теста. Присутствует только для кросс-плейсментных A/B-тестов.
ab_test_variant_idUUIDID варианта A/B-теста, в котором была совершена транзакция.
ab_test_variant_nameStringНазвание варианта A/B-теста.
access_level_idStringID уровня доступа.
activated_atISO 8601 dateДата и время последней активации доступа.
active_introductory_offer_typeStringТип применённого introductory offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front.
active_promotional_offer_idStringID promotional offer, указанного в разделе Product дашборда Adapty.
active_promotional_offer_typeStringТип применённого promotional offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front.
base_plan_idStringID базового плана в Google Play Store или ID цены в Stripe.
billing_issue_detected_atISO 8601 dateДата и время обнаружения проблемы с оплатой.
cancellation_reasonStringВозможные причины отмены: voluntarily_cancelled, billing_error, price_increase, product_was_not_available, refund, cancelled_by_developer, new_subscription_replace, upgraded, unknown, adapty_revoked.
cohort_nameStringНазвание аудитории, к которой относится профиль.
currencyStringЛокальная валюта (по умолчанию USD).
developer_idStringID плейсмента, в котором была совершена транзакция.
environmentStringВозможные значения: Sandbox или Production.
event_datetimeISO 8601 dateДата и время события.
expires_atISO 8601 date

Дата и время истечения доступа. Adapty вычисляет is_active на основе этого поля.

Во время льготного периода содержит дату его окончания; после возврата средств или отмены — дату отмены. Отдельного поля для окончания льготного периода нет.

flow_idUUIDID флоу, в котором была совершена транзакция.
flow_nameStringНазвание флоу, в котором была совершена транзакция.
flow_variation_idUUIDID варианта флоу на данном плейсменте — совпадает с flow.variationId в SDK.
is_activeBooleanПризнак того, активен ли уровень доступа. Вычисляется на основе expires_at (вместе с starts_at и is_lifetime) в момент генерации события.
is_in_grace_periodBooleanПризнак того, находится ли профиль в льготном периоде. Пока значение true, поле expires_at содержит дату окончания льготного периода.
is_lifetimeBooleanПризнак того, является ли уровень доступа пожизненным.
is_refundBooleanПризнак того, является ли транзакция возвратом средств.
original_purchase_dateISO 8601 dateДля возобновляемых подписок: исходная покупка — это первая транзакция в цепочке; её ID (original transaction ID) связывает всю цепочку продлений; последующие транзакции являются её расширением. Дата исходной покупки — дата и время этой первой транзакции.
original_transaction_idString

Для возобновляемых подписок — это ID исходной транзакции, связывающий цепочку продлений. Исходная транзакция является первой в цепочке; последующие транзакции являются её расширением.

Если продлений не было, original_transaction_id совпадает с store_transaction_id.

Идентификатор транзакции исходной покупки.
paywall_nameStringНазвание пейвола, в котором была совершена транзакция. Для флоу — ID экрана пейвола (scr_...).
paywall_revisionStringРевизия пейвола, в котором была совершена транзакция. Значение по умолчанию: 1.
profile_countryStringОпределяется Adapty на основе IP-адреса профиля.
profile_event_idUUIDУникальный ID события, который можно использовать для дедупликации.
profile_has_access_levelBooleanПризнак того, есть ли у профиля активный уровень доступа.
profile_idUUIDВнутренний ID профиля пользователя в Adapty.
profile_ip_addressStringIP-адрес профиля (может быть IPv4 или IPv6; IPv4 имеет приоритет, если доступен). null, если в настройках приложения отключена опция Collect users’ IP addresses.
profile_total_revenue_usdFloatОбщая выручка по профилю с учётом возвратов.
purchase_dateISO 8601 dateДата и время покупки продукта.
renewed_atISO 8601 dateДата и время последнего начала текущего периода платного доступа. До первого продления совпадает с activated_at.
starts_atISO 8601 dateДата и время начала действия уровня доступа.
storeStringСтор, в котором был куплен продукт. Стандартные значения: app_store, play_store, stripe, paddle.
Если вы устанавливаете пользовательские транзакции стора через серверный API, используется значение из параметра store.
store_countryStringСтрана, переданная в Adapty магазином приложений.
subscription_expires_atISO 8601 dateДата истечения подписки. В данном событии содержит то же значение, что и expires_at: во время льготного периода — дату его окончания; после возврата средств или отмены — дату отмены.
transaction_idStringУникальный идентификатор транзакции.
trial_durationStringПродолжительность пробного периода в днях (например, «7 days»).
variation_idUUIDИдентификатор варианта, используемый для атрибуции покупок данному пейволу. Для флоу — ID экрана пейвола внутри флоу, а не варианта A/B-теста.
vendor_product_idString

ID продукта в сторе (Apple/Google/Stripe).

Для 12-месячного тарифа с обязательством значение имеет вид <product_id>:monthly.

Если доступ был предоставлен без реальной транзакции стора, vendor_product_id принимает одно из следующих значений:

will_renewBooleanУказывает, будет ли платный уровень доступа продлён.
Warning

Обратите внимание, что эта структура может расширяться со временем — по мере того как мы или наши партнёры добавляем новые данные. Убедитесь, что ваш код, обрабатывающий её, достаточно устойчив и опирается на конкретные поля, а не на всю структуру целиком.