数据分析集成

Adapty 会将所有订阅事件发送给各类分析服务，例如 Amplitude、Mixpanel 和 AppMetrica。我们也可以通过 webhook 集成将事件发送到你的服务器。最棒的是，你无需自行发送任何事件，我们会替你完成。只需在 Adapty 看板中完成相应集成的配置即可。

Adapty 支持与以下第三方分析服务集成：

没有看到你使用的分析工具？

告诉我们！提交功能请求，我们会考虑添加。

事件属性

Webhook 事件以 JSON 格式发送。所有事件遵循相同的结构，但字段内容会根据事件类型、应用商店以及你的具体配置有所不同。

属性	类型	描述
profile_id	uuid	Adapty 用户 ID。
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	Apple App Store、Google Play Store 或 Stripe 中的产品 ID。
base_plan_id	str	Google Play Store 中的基础方案 ID 或 Stripe 中的价格 ID。
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	Adapty 看板产品部分中设置的促销活动 ID。
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	交易来源版位的开发者（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 保持同步。每次 Adapty 服务器收到 SDK 上报的数据时，如果 IP 与已记录的不同，则会自动更新。

设置用户画像标识符

使用 instructions for setting user attributes in your app iOS、Android、React Native、Flutter 和 Unity 为所选分析工具设置用户画像标识符。

避免重复

请记得关闭从设备和服务器发送订阅事件的功能，以避免重复计数。

为特定用户禁用外部分析

如果你的应用提供了退出分析服务的选项，你可能希望停止为某个特定用户发送分析事件。

要为某个用户禁用外部分析，请使用 updateProfile() 方法。创建 AdaptyProfileParameters.Builder 对象并设置相应的值。
当外部分析被禁用后，Adapty 将不再向任何集成发送该用户的任何事件。如果你想为应用的所有用户禁用某个集成，只需在 Adapty 看板中将其关闭即可。

let builder = AdaptyProfileParameters.Builder()
    .with(analyticsDisabled: true)

Adapty.updateProfile(parameters: builder.build())

val parameters = AdaptyProfileParameters(
    analyticsDisabled = true
)

Adapty.updateProfile(parameters) { error ->
    if (error == null) {
        // successful update
    }
}

AdaptyProfileParameters.Builder builder = new AdaptyProfileParameters.Builder()
    .withExternalAnalyticsDisabled(true);

Adapty.updateProfile(builder.build());

final builder = AdaptyProfileParametersBuilder()
  ..setAnalyticsDisabled(true);

try {
  await Adapty().updateProfile(builder.build());
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
}

var builder = new AdaptyProfileParameters.Builder()
    .SetAnalyticsDisabled(true);

Adapty.UpdateProfile(builder.Build(), (error) => {
    if(error != null) {
      // handle the error
    }
});

adapty.updateProfile({ analyticsDisabled: true });

禁用广告标识符收集

你可以通过 idfaCollectionDisabled 属性禁用 IDFA 收集。请确保在调用 .activate() 方法之前设置该属性。

// In your AppDelegate class:

let configurationBuilder =
    AdaptyConfiguration
        .builder(withAPIKey: "PUBLIC_SDK_KEY")
        .with(idfaCollectionDisabled: true) // set to `true`

Adapty.activate(with: configurationBuilder.build()) { error in
  // handle the error
}

您可以在激活 Adapty SDK 时，通过 withAdIdCollectionDisabled 属性禁用 AAID/GAID 收集：

override fun onCreate() {
    super.onCreate()
    Adapty.activate(
      applicationContext,
      AdaptyConfig.Builder("PUBLIC_SDK_KEY")
          .withAdIdCollectionDisabled(true) // set to `true`
          .build()
    )  
}

您可以在激活 Adapty SDK 时，通过 withAdIdCollectionDisabled 属性禁用 AAID/GAID 收集：

@Override
public void onCreate() {
    super.onCreate();
    Adapty.activate(
      applicationContext,
      new AdaptyConfig.Builder("PUBLIC_SDK_KEY")
          .withAdIdCollectionDisabled(true) // 设置为 `true`
          .build()
    );
}

您可以通过 withAppleIdfaCollectionDisabled 属性禁用 IDFA 收集，通过 withGoogleAdvertisingIdCollectionDisabled 属性禁用 Google/Android 广告 ID 收集。在激活 Adapty SDK 时将它们设置为 true：

try {
    await Adapty().activate(
        configuration: AdaptyConfiguration(apiKey: 'YOUR_API_KEY')
          ..withGoogleAdvertisingIdCollectionDisabled(true), // set to `true`
          ..withAppleIdfaCollectionDisabled(true), // set to `true`
    );
} catch (e) {
    // handle the error
}

您可以在激活 Adapty SDK 时，通过 SetIDFACollectionDisabled 属性禁用 IDFA 采集。目前暂不支持禁用 AAID/GAID 采集。

var builder = new AdaptyConfiguration.Builder("YOUR_API_KEY")
    .SetIDFACollectionDisabled(true); // 设置为 `true`

Adapty.Activate(builder.Build(), (error) => {
    // handle the error
}

你也可以在激活 Adapty SDK 时使用 idfaCollectionDisabled 属性禁用 IDFA 收集，或使用 adIdCollectionDisabled 属性禁用 AAID/GAID 收集。

adapty.activate('PUBLIC_SDK_KEY', {
  ios: {
      idfaCollectionDisabled: true, // set to `true`
  }, 
  android: {
      adIdCollectionDisabled: true,
  },
});