OneSignal

OneSignal は、プッシュ通知・メール・SMS・アプリ内メッセージングを提供する主要なカスタマーエンゲージメントプラットフォームです。Adapty と OneSignal を連携することで、すべてのサブスクリプションイベントを一か所で確認でき、それらのイベントをトリガーとした自動コミュニケーションを設定できます。

Adapty を使えば、複数のストアにわたるサブスクリプションイベントを追跡し、ユーザー行動を分析して、よりターゲットを絞ったコミュニケーションに活用できます。この連携により、OneSignal ダッシュボード内でサブスクリプションイベントを監視し、獲得キャンペーンにマッピングすることが可能です。

Adapty はサブスクリプションイベントに基づいて OneSignal のタグを更新するため、最小限の設定でパーソナライズされたプッシュ通知を配信できます。

連携の特性

連携の特性	説明
スケジュール	リアルタイム更新
データの方向	一方向：Adapty から OneSignal サーバーへ
Adapty の連携ポイント	モバイルアプリのコード内の OneSignal と Adapty SDK Adapty サーバー

OneSignal 連携の設定

連携を設定するには：

Adapty ダッシュボードの Integrations → OneSignal を開きます。
連携トグルを有効にします。
OneSignal App ID を入力します。

OneSignal との連携を設定するには、Adapty ダッシュボードの Integrations -> OneSignal に移動し、トグルをオンにして連携の認証情報を設定してください。

OneSignal App ID の取得

OneSignal App ID は OneSignal ダッシュボードで確認できます：

Settings → Keys & IDs に移動します。
OneSignal App ID をコピーして、Adapty ダッシュボードの App ID フィールドに貼り付けます。

OneSignal ID の詳細については、こちらのドキュメントをご覧ください。

イベントの設定

Adapty では、3 つのグループのイベントを OneSignal に送信できます。Adapty ダッシュボードで必要なものをトグルでオンにしてください。利用可能なイベントの完全なリストと詳細な説明はこちらで確認できます。

Adapty はサーバー間連携を使用してサブスクリプションイベントを OneSignal に送信するため、OneSignal ですべてのサブスクリプション関連のアクティビティを追跡できます。

2023 年 4 月 17 日より、OneSignal の無料プランではこの連携がサポートされなくなりました。Growth、Professional、およびそれ以上のプランでのみ利用可能です。詳細は OneSignal Pricing をご覧ください。

カスタムタグ

この連携では、Adapty ユーザーのさまざまなプロパティをタグとして更新・付与し、OneSignal に送信します。以下のタグ一覧から、ニーズに合ったものをご確認ください。

OneSignal にはタグの上限があります。これには Adapty が生成するタグと OneSignal に既存するタグの両方が含まれます。上限を超えると、イベント送信時にエラーが発生する可能性があります。

タグ	型	説明
`adapty_customer_user_id`	String	アプリ内でのユーザーの一意の識別子。システム、Adapty、OneSignal 全体で一貫している必要があります。
`adapty_profile_id`	String	Adapty のユーザープロファイル ID。Adapty ダッシュボードで確認できます。
`environment`	String	ユーザーの現在の環境を示す `Sandbox` または `Production`。
`store`	String	プロダクトが購入されたストア。選択肢：app_store、play_store、stripe、またはカスタムストアの名前。
`vendor_product_id`	String	アプリストアにおけるプロダクト ID（例：`org.locals.12345`）。
`subscription_expires_at`	String	最新のサブスクリプションの有効期限（`YYYY-MM-DDTHH:MM:SS+0000`、例：`2023-02-10T17:22:03.000000+0000`）。
`last_event_type`	String	Adapty イベントリストにおける最新のイベントタイプ。注意点： - Subscription expired イベントの場合、Adapty は `last_event_type` プロパティを `subscription_cancelled` として送信します。 - Trial renew canceled の場合は `auto_renew_off` として送信します。 - Subscription renew canceled の場合は `auto_renew_off_subscription` として送信します。
`purchase_date`	String	最後のトランザクション日時（`YYYY-MM-DDTHH:MM:SS+0000`、例：`2023-02-10T17:22:03.000000+0000`）。
`active_subscription`	String	ユーザーがアクティブなサブスクリプションを持つ場合は `true`、サブスクリプションが終了している場合は `false`。
`period_type`	String	購入または更新における最新の期間タイプを示します。使用可能な値：試用期間の場合は `trial`、それ以外のすべての場合は `normal`。

すべての float 値は整数に丸められます。文字列はそのまま変更されません。

事前定義されたタグに加えて、カスタム属性をタグとして送信することで、含めるデータの柔軟性を高めることができます。これは、プロダクトやサービスに関連する特定の詳細を追跡するのに役立ちます。

カスタムユーザー属性は、連携ページの Send user attributes チェックボックスが有効になっている場合、自動的に OneSignal に送信されます。チェックを外した場合、Adapty はちょうど 10 個のタグを送信します。チェックを入れると 10 個を超えるタグを送信でき、より多くのデータをキャプチャできます。

SDK の設定

OneSignal と Adapty を連携する方法は 2 つあります：

レガシー（v5 以前）： playerId を使用します（OneSignal SDK v5 では非推奨）。
現行（v5 以降）： subscriptionId を使用します。

Adapty に playerId（OneSignal SDK v5 以前の場合）または subscriptionId（OneSignal SDK v5 以降の場合）を必ず送信してください。これを行わないと、OneSignal のタグが更新されず、連携が正しく機能しません。

// SubscriptionID
OneSignal.Notifications.requestPermission({ accepted in
    Task {
        // Adapty SDK 4.x
        try await Adapty.setIntegrationIdentifier(.oneSignalSubscriptionId(OneSignal.User.pushSubscription.id))
        // Adapty SDK 3.x
        try await Adapty.setIntegrationIdentifier(
            key: "one_signal_subscription_id", 
            value: OneSignal.User.pushSubscription.id
        )
    }
}, fallbackToSettings: true)

// SubscriptionID
val oneSignalSubscriptionObserver = object: IPushSubscriptionObserver {
    override fun onPushSubscriptionChange(state: PushSubscriptionChangedState) {
        Adapty.setIntegrationIdentifier("one_signal_subscription_id", state.current.id) { error ->
            if (error != null) {
                // handle the error
            }
        }
    }
}

// SubscriptionID
IPushSubscriptionObserver oneSignalSubscriptionObserver = state -> {
    Adapty.setIntegrationIdentifier("one_signal_subscription_id", state.getCurrent().getId(), error -> {
        if (error != null) {
            // handle the error
        }
    });
};

// 1. Since OneSignal.User.pushSubscription.id may return null if called too early, 
// OneSignal suggests to listen for the updates:

OneSignal.User.pushSubscription.addObserver((state) {
   if (state.current.optedIn) {
      // now you can try to retrieve subscriptionId
   }
});

// 2. Then you can push subscriptionId to Adapty:
final subscriptionId = OneSignal.User.pushSubscription.id;
if (subscriptionId != null) {
   await Adapty().setIntegrationIdentifier(key: "one_signal_subscription_id", value: subscriptionId);
}

using AdaptySDK;
using OneSignalSDK;

var pushUserId = OneSignal.Default.PushSubscriptionState.userId;

Adapty.SetIntegrationIdentifier(
  "one_signal_player_id", 
  pushUserId, 
  (error) => {
  // handle the error
});


OneSignal.User.pushSubscription.addEventListener('change', (subscription) => {
  const subscriptionId = subscription.current.id;

  if (subscriptionId) {
    adapty.setIntegrationIdentifier("one_signal_subscription_id", subscriptionId);
  }
});

// PlayerID
// in your OSSubscriptionObserver implementation
func onOSSubscriptionChanged(_ stateChanges: OSSubscriptionStateChanges) {
    if let playerId = stateChanges.to.userId {
        Task {
            // Adapty SDK 4.x
            try await Adapty.setIntegrationIdentifier(.oneSignalPlayerId(playerId))
            // Adapty SDK 3.x
            try await Adapty.setIntegrationIdentifier(
                key: "one_signal_player_id", 
                value: playerId
            )
        }
    }
}

// PlayerID
val osSubscriptionObserver = OSSubscriptionObserver { stateChanges ->
    stateChanges?.to?.userId?.let { playerId ->
        Adapty.setIntegrationIdentifier("one_signal_player_id", playerId) { error ->
            if (error != null) {
                // handle the error
            }
        }
    }
}

// PlayerID
OSSubscriptionObserver osSubscriptionObserver = stateChanges -> {
    OSSubscriptionState to = stateChanges != null ? stateChanges.getTo() : null;
    String playerId = to != null ? to.getUserId() : null;
    
    if (playerId != null) {
        Adapty.setIntegrationIdentifier("one_signal_player_id", playerId, error -> {
            if (error != null) {
                // handle the error
            }
        });
    }
};

// PlayerID (pre-v5 OneSignal SDK)
// in your OSSubscriptionObserver implementation
func onOSSubscriptionChanged(_ stateChanges: OSSubscriptionStateChanges) {
    if let playerId = stateChanges.to.userId {
        Task {
            try await Adapty.setIntegrationIdentifier(
                key: "one_signal_player_id", 
                value: playerId
            )
        }
    }
}


OneSignal.addSubscriptionObserver(event => {
  const playerId = event.to.userId;
  
  adapty.setIntegrationIdentifier("one_signal_player_id", playerId);
});

OneSignal ドキュメントの詳細はこちらをご覧ください：

複数デバイスへの対応

ユーザーが複数のデバイスを持っている場合、購入イベントやサブスクリプションの追跡が難しくなることがあります。OneSignal では、external user ID を使ってこの問題に対処できます。

デバイス間でユーザーデータを一貫させるには：

サーバーサイドで異なるデバイスを照合し、そのデータを OneSignal に送信します。
Adapty の customer_user_id を OneSignal の externalUserId として使用します。アプリに登録システムがない場合は、ユーザーのデバイス間で一貫性を保つ別の一意の識別子の使用を検討してください。

すべてのデバイスでユーザー識別子の一貫性を維持し、ユーザーの ID が変わるたびに OneSignal を更新することが重要です。これにより、ユーザーのアクティビティとサブスクリプションの追跡が簡素化され、一貫したメッセージングが確保されるとともに、より正確な分析とより良いユーザー体験が実現できます。詳細については、OneSignal の external user ID ドキュメントをご覧ください。