Webhookイベントタイプとフィールド

Adaptyはサブスクリプションイベントに応じてWebhookを送信します。このセクションでは、イベントタイプと各Webhookに含まれるデータを説明します。

Webhookイベントタイプ

すべてのイベントタイプをWebhookに送信するか、一部のみを選択して送信できます。受信データの内容やビジネスロジックの構築方法については、イベントフローを参照してください。不要なイベントタイプは、Webhook連携の設定時に無効化できます。また、必要に応じてAdaptyのデフォルトイベントIDを独自のIDに置き換えることも可能です。

Webhookイベントの構造

Adaptyは、Integrations -> WebhooksページのEvents namesセクションで選択したイベントのみを送信します。 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": "[email protected]",
  "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,
    "base_plan_id": "b1",
    "developer_id": "onboarding_placement",
    "ab_test_name": "onboarding_ab_test",
    "ab_test_revision": 1,
    "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
  }
}

イベントフィールド

イベントパラメーターはすべてのイベントタイプで共通です。

アトリビューション

アトリビューションデータを送信するには、Integrations -> Webhooks ページで Send Attribution オプションを有効にしてください。アトリビューションデータの送信を有効にしており、アトリビューション連携を設定済みの場合、以下のデータがすべてのソースのイベントに付与されて送信されます。同じアトリビューションデータはすべてのイベントタイプに送信されます。

{
  "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"
    }
  }
}

インテグレーション ID

現在、イベントで使用されているインテグレーション 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

Play Store の購入トークン

このフィールドには、必要に応じて購入を再検証するために必要なすべてのデータが含まれています。Webhookインテグレーションの設定で Send Play Store purchase token オプションが有効になっている場合にのみ送信されます。

イベントプロパティ

イベントプロパティは、イベントの種類によって、また同じ種類のイベント間でも異なる場合があります。たとえば、App Store から発生したイベントには、base_plan_id のような Android 固有のプロパティは含まれません。 アクセスレベル更新イベントには固有のプロパティがあるため、専用セクションを設けています。同様に、追加の税・収益イベントプロパティも特定のイベントタイプのみに該当するため、別セクションに分けています。

ほとんどのイベントタイプに共通

ほとんどのイベントタイプのイベントプロパティは共通です（Access Level Updated イベントを除く。このイベントについては専用のセクションで説明します）。以下は、各プロパティと、それが特定のイベントに属するかどうかを示す一覧表です。

税金と収益に関する追加イベントプロパティ

以下の税金と収益に関するイベントプロパティは、特定のイベントタイプにのみ適用される追加フィールドです。つまり、ここに列挙されているイベントタイプには、ほとんどのイベントタイプ共通のイベントプロパティに加えて、以下の追加フィールドが含まれます。

税金と収益に関するイベントプロパティを持つイベントタイプ：

• subscription_renewed
• subscription_initial_purchase（subscription_started とも呼ばれる — 同じイベント）
• subscription_refunded
• non_subscription_purchase | フィールド | 型 | 説明 | | :-------------------- | :---- | :----------------------------------------------------------- | | net_revenue_local | Float | ローカル通貨でのネット収益（Apple/Google の手数料および税金控除後の収入）。 | | net_revenue_usd | Float | USD でのネット収益（Apple/Google の手数料および税金控除後の収入）。 | | proceeds_local | Float | ローカル通貨での Apple/Google 手数料控除後のプロダクト価格。 | | proceeds_usd | Float | Apple/Google 手数料控除後のプロダクト価格（USD）。 | | tax_amount_local | Float | ローカル通貨での控除税額。 | | tax_amount_usd | Float | USD での控除税額。 |

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_*）は含まれます。

{
  "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,
    "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 イベントは、Webhook インテグレーションが有効であり、このイベントタイプが有効になっている場合にのみ生成される特定の Webhook イベントです。有効になっている場合、設定済みの Webhook に送信され、Event Feed に表示されます。有効になっていない場合、イベントは作成されません。

アクセスレベルの共有を有効にしている場合、access level updated イベントはアクセスレベルを共有しているすべてのプロファイルに対して送信されます。