アナリティクス連携

Adaptyは、サブスクリプションイベントAmplitudeMixpanelAppMetricaなどの分析サービスに送信します。また、webhook連携を使用してサーバーにイベントを送信することもできます。イベントの送信はAdaptyが自動で行うため、手動で送信する必要はありません。Adapty ダッシュボードで連携を設定するだけです。

Adaptyは以下のサードパーティ分析サービスとの連携をサポートしています:

Note

お使いのアナリティクスプロバイダーが見当たりませんか?

ぜひお知らせください!機能リクエストを作成すると、追加を検討します。

イベントのプロパティ

WebhookイベントはJSON形式で送信されます。すべてのイベントは同じ構造に従いますが、フィールドはイベントタイプ、ストア、および設定内容によって異なります。

Note

Adaptyは、currencylayer.comの為替レート(8時間ごとに更新)を使用して他の通貨をUSDに換算します。レートは取引時点で固定されるため、その後の変動は換算結果に影響しません。

プロパティ説明
profile_iduuidAdapty ユーザー ID。
currencystrローカル通貨(デフォルトは USD)。
price_usdfloatApple/Google の手数料控除前のプロダクト価格。収益。
proceeds_usdfloatApple/Google の手数料控除後のプロダクト価格。純収益。
net_revenue_usdfloatUSD での純収益(Apple/Google の手数料および税金控除後の収入)。空の場合あり。
price_localfloatローカル通貨での Apple/Google の手数料控除前のプロダクト価格。収益。
proceeds_localfloatローカル通貨での Apple/Google の手数料控除後のプロダクト価格。純収益。
transaction_idstr購入や更新などのトランザクションの一意の識別子。
original_transaction_idstr元の購入のトランザクション識別子。
purchase_dateISO 8601 dateプロダクト購入の日時。
original_purchase_dateISO 8601 date元の購入の日時。
environmentstrSandbox または Production
vendor_product_idstrApple App Store、Google Play ストア、または Stripe のプロダクト ID。
base_plan_idstrGoogle Play ストアのベースプラン ID または Stripe の価格 ID
event_datetimeISO 8601 dateイベントの日時。
storestrapp_store または play_store
trial_durationstrトライアル期間の日数。” days” の形式で送信されます(例:「7 days」)。
cancellation_reasonstr

ユーザーがサブスクリプションをキャンセルした理由。

以下のいずれかです。

iOS & Android

voluntarily_cancelled, billing_error, refund

iOS

price_increase, product_was_not_available, unknown

Android

new_subscription_replace, cancelled_by_developer

subscription_expires_atISO 8601 dateサブスクリプションの有効期限。通常は将来の日付。
consecutive_paymentsintユーザーが中断なくサブスクリプションを継続している期間数。現在の期間を含む。
rate_after_first_yearbool1 年間継続して更新された後に、サブスクリプションが低率手数料(通常 15%)の対象となるかを示すブール値。手数料率はプログラムの適格性と国によって異なります。詳細はストア手数料と税金をご覧ください。
promotional_offer_idstrAdapty ダッシュボードのプロダクトセクションに記載されているプロモーションオファーの ID。
store_offer_categorystrintroductory または promotional
store_offer_discount_typestrfree_trialpay_as_you_go、または pay_up_front
paywall_namestrトランザクションが発生したペイウォールの名前。
paywall_revisionintトランザクションが発生したペイウォールのリビジョン。値は 1 に設定されます。
developer_idstrトランザクションが発生したプレースメントのデベロッパー(SDK)ID。
ab_test_namestrトランザクションが発生した A/B テストの名前。
ab_test_revisionintトランザクションが発生した A/B テストのリビジョン。値は 1 に設定されます。
cohort_namestrプロファイルが属するオーディエンスの名前。
profile_event_iduuid重複排除に使用できる一意のイベント ID。
store_countrystrストアから送信された国情報。
profile_ip_addressstrプロファイルの IP アドレス(IPv4 または IPv6。利用可能な場合は IPv4 が優先)。デバイスの IP が変わるたびに更新されます。
profile_countrystrプロファイルの IP アドレスをもとに Adapty が判定した国。
profile_total_revenue_usdfloatプロファイルの総収益(返金分を含む)。
variation_iduuid購入が行われたペイウォールの一意の ID。
access_level_idstr有料アクセスレベルの ID。
is_activeboolプロファイルで有料アクセスレベルが有効かどうかを示すブール値。
will_renewbool有料アクセスレベルが更新されるかどうかを示すブール値。
is_refundboolトランザクションが返金済みかどうかを示すブール値。
is_lifetimebool有料アクセスレベルが永続アクセスかどうかを示すブール値。
is_in_grace_periodboolプロファイルがグレース期間中かどうかを示すブール値。
starts_atISO 8601 dateユーザーの有料アクセスレベルが開始する日時。
renewed_atISO 8601 date有料アクセスの現在の期間が最後に開始した日時。初回更新までは activated_at と同じ値になります。
expires_atISO 8601 date有料アクセスが終了する日時。
activated_atISO 8601 date有料アクセスが有効化された日時。
billing_issue_detected_atISO 8601 date請求問題が発生した日時。
profile_has_access_levelBoolプロファイルにアクティブなアクセスレベルがあるかどうかを示すブール値(Webhook のみ)。

各イベントには以下のプロパティが含まれます:

transaction_id, original_transaction_id, purchase_date, original_purchase_date, environment, vendor_product_id, event_datetime, store

また、一部のイベントには追加プロパティがあります。subscription_refundednon_subscription_purchase_refunded イベントでは、price_usdproceeds_usd の値を追加プロパティとして必ず指定する必要があります。

イベント名プロパティ
subscription_initial_purchaseprice_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration
subscription_renewedprice_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration
subscription_cancelledcancellation_reason, trial_duration
trial_startedsubscription_expires_at, trial_duration
trial_convertedprice_usd, proceeds_usd, subscription_expires_at, consecutive_payments, rate_after_first_year, trial_duration
trial_cancelledcancellation_reason, trial_duration
non_subscription_purchaseprice_usd, proceeds_usd
billing_issue_detectedsubscription_expires_at, trial_duration
entered_grace_periodsubscription_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と異なる場合はIPが更新されます。

プロファイルの識別子の設定

  • 選択したアナリティクス向けにプロファイルの識別子を設定するには、 アプリでユーザー属性を設定する手順 をご参照ください。
Warning

重複を避けるために

デバイスとサーバーの両方からサブスクリプションイベントを送信すると重複が発生するため、どちらか一方からのみ送信するようにしてください。

特定のユーザーに対して外部アナリティクスを無効化する

特定のユーザーへのアナリティクスイベント送信を停止したい場合があります。これは、アプリにアナリティクスサービスのオプトアウト機能を設けている場合などに便利です。

特定ユーザーの外部アナリティクスを無効化するには、updateProfile() メソッドを使用します。AdaptyProfileParameters.Builder オブジェクトを作成し、対応する値を設定してください。
外部アナリティクスがブロックされると、Adaptyは対象ユーザーに関するイベントをいずれの連携サービスにも送信しなくなります。アプリのすべてのユーザーに対して連携を無効化したい場合は、Adapty ダッシュボードで該当の連携をオフにしてください。

Warning

外部アナリティクスをブロックすると、カスタムwebhookを含むすべてのインテグレーションへのイベント配信が、このユーザーに対して停止されます。バックエンドがwebhookイベントを使ってこのユーザーのアクセスを管理している場合は使用しないでください。

この設定は遡及的には適用されません。設定前に作成されたイベントは引き続き配信されます。また、Adapty自身のアナリティクスには影響しません。ユーザーのトランザクションは引き続きダッシュボードのチャートに反映されます。

広告識別子の収集を無効化する