ライブアクティビティ

Pushly PushSDK を使用して Android アプリケーションにライブアクティビティ通知サポートを追加するためのクイックスタートガイド

Android Live Activity 通知は、 iOS Live Activities と同様の機能セットと体験を Android プラットフォーム上で提供し、プッシュ通知を通じてリアルタイムに更新されたコンテンツを配信できます。

PushSDK は、開発者が Live Activity のハンドラーを登録・管理できるようにすることで、Live Activity の登録と更新を効率化します。登録されたハンドラーは、当社のサーバー API 経由で更新できます。

前提条件

SDKにLive Activitiesを統合する前に、以下の要件を満たしている必要があります:

• Firebase Sender ID と Server API Key、または Service Account を使用して設定された Android Send Integration。

• Android アプリ。

• Google Play Store Services がインストールされた API 19 以上（Android 4.4）を実行するデバイスまたはエミュレーター。

• Live Activities をサポートする PushSDK リリース（下のバージョンサポート表を参照）。

ステップ 1: Android SDK のセットアップ

アプリケーションが まだ PushSDKを使用していない場合は、ネイティブアプリのPushセットアップガイドを参照してください。 Android.

すでにPushSDKを使用しているアプリケーションでは、Live Activity対応を含む後のバージョンへのアップグレードが必要になる場合があります。以下の表を使って、インストールのアップグレードが必要かどうかを確認してください。

SDK	Live Activitiesを含む最初のバージョン
Kotlin / Java	1.3.0+

app/build.gradle

dependencies {
    ...
    implementation 'com.pushly.android:pushsdk:[1.3, 2.0['
}

ステップ 2: Live Activity 更新用ハンドラーの作成

更新を処理して表示するには、 PNLiveActivityHandler クラスを実装する必要があります。このハンドラーには、 name この種のアクティビティを一意に識別し、プッシュ経由で開始するためのものです。任意の通知 channelId も指定でき、Live Activity 通知を専用チャネルにまとめられます。カスタム channel ID が指定されない場合、PushSDK はデフォルトのチャネルを使用します。

1つの onUpdate メソッドを実装する必要があり、受信したすべての Live Activity イベント（開始、更新、終了）を処理します。このメソッドを使って、更新内容の表示方法をカスタマイズしてください。

Kotlin

class MyActivityHandler : PNLiveActivityHandler(
    name = "game_updates",
    channelId = "sports_channel"
) {
    override fun onUpdate(context: Context, contentState: ContentState): PNLiveActivityUpdateResult {
        // 通知ビルダーを作成
        val builder = Notification.Builder(context, channelId)
            .setSmallIcon(R.drawable.ic_notification)
            .setContentTitle("Game Update")
            .setContentText("${contentState.getString("home_team")} vs ${contentState.getString("away_team")}")
        
        // 結果とともにビルダーを返す
        return PNLiveActivityUpdateResult.Ok(builder)
    }
}

Java

ハンドラーの登録

ハンドラーを実装したら、PushSDK に登録する必要があります。以下のコードスニペットは、ハンドラーの登録方法を示しています。

Kotlin

class MainApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        
        // ... PushSDK の設定コード

        PushSDK.LiveActivities.register(MyActivityHandler())
    }
}

Java

ステップ 3: Live Activity の開始

アプリ内から開始する

以下のコードスニペットでは、一意の activityId 、 handler 名、以前に登録したハンドラークラスに対応する名前、およびアクティビティの初期 contentState を指定して Live Activity の開始を要求します。このシナリオでは、 PNLiveActivityHandler クラスを次の名前で登録して使用します: game_updates.

Kotlin

class MainActivity : AppCompatActivity() {
    public fun startLiveActivity() {
        PushSDK.LiveActivities.start(
            activityId = "my_activity_id",
            handler = "game_updates", // 登録済みハンドラー名と一致する必要があります
            contentState = contentStateOf(
                "home_team" to "Chiefs",
                "home_team_score" to 0,
                "away_team" to "Chargers",
                "away_team_score" to 0
            )
        )
    }
}

Java

コンテンツ状態

ContentState は、Live Activities にデータを渡すために使用されます。便利なメソッド contentStateOf():

Kotlin

val state = contentStateOf(
    "key1" to "value1",
    "key2" to 42,
    "key3" to null
)

Java

ContentState は、次の値の型をサポートしています: String、Int、Long、Float、Double、Boolean、null。

プッシュ経由で開始

ハンドラーを PushSDK に登録したら、当社の Live Activity APIドキュメント を使用して、対応するハンドラー名を activity.android.data.handler_name プロパティに指定し、リクエストパスに関連付けられた一意のアクティビティ識別子を渡すことで、開始イベントを送信できます。このシナリオでは、 my_activity_id に設定して使用しました。これは後続の更新イベントで使用できます。

開始リクエストの例

POSTリクエスト先:
https://api.pushly.com/domains/{domain_id}/live-activities/my_activity_id
{
    "name": "my-request-event-name",
    "event": "start",
    "activity": {
        "android": {
            "data": {
                "handler_name": "game_updates",
                "content_state": {
                    "home_team": "Chiefs",
                    "home_team_score": 0,
                    "away_team": "Chargers",
                    "away_team_score": 0
                },
                "notification": {
                    "title": "The Game Has Begun",
                    "body": "今後の更新をお待ちください！"
                }
            }
        }
    }
}

ステップ 4: Live Activity を更新する

Live Activity がローカルまたはプッシュ経由で開始されたら、当社の Live Activity APIドキュメント を使って、単一のリクエストで登録済みのすべてのLive Activityに更新を送信できます。

更新イベントの例

POSTリクエスト先:
https://api.pushly.com/domains/{domain_id}/live-activities/my_activity_id
{
    "name": "my-request-event-name",
    "event": "update",
    "activity": {
        "android": {
            "data": {
                "content_state": {
                    "home_team": "Chiefs",
                    "home_team_score": 7,
                    "away_team": "Chargers",
                    "away_team_score": 0
                }
            }
        }
    }
}

ステップ 5: Live Activities の削除

iOS Live Activities の仕組みと同様に、Android Live Activity 通知は開始から 12 時間後に自動的に終了し、クリーンアップされます。ただし、その時間制限に達する前にアクティビティをクリーンアップしたい場合もあるでしょう。そのような場合は、次のメソッドで単一のアクティビティを削除するか、すべてのアクティブなアクティビティを削除できます。

特定のアクティビティを削除

Kotlin

PushSDK.LiveActivities.remove(activityId = "my_activity_id")

Java

すべてのアクティビティを削除

Kotlin

PushSDK.LiveActivities.removeAll()

Java

ベストプラクティス

1. アプリケーションの onCreate メソッドで常にハンドラーを登録し、適切に初期化してください。

2. 適切に設定された Notification.Builder をハンドラーの onUpdate メソッド内に追加します。

3. 一貫したアクティビティ ID を使用して、特定のアクティビティを正しく追跡・更新してください。

4. ハンドラーの onUpdate メソッド内に追加します。

5. すべての可能な状態を処理してください。

6. 目的を反映した意味のあるハンドラー名を使用してください。

7. 不要になったアクティビティは、を使用して、または手動でいずれかの削除メソッドを呼び出してクリーンアップしてください。 end イベント