Android live notifications

OneSignalのAndroid Live Notificationsを使用すると、単一の通知にリアルタイム更新を送信でき、混乱を減らしてエンゲージメントを向上させることができます。これらの通知は永続的に残り、コンテンツを動的に更新します。スポーツスコア、ダウンロード進行状況、またはイベント追跡に最適です。 Live Notificationsを受信するには、Androidユーザーはプッシュ通知を有効にする必要があります。

要件

アプリは最新バージョンのOneSignal SDKを使用する必要があります。
Androidユーザーはプッシュ通知権限を有効にする必要があります。

Live notificationsと標準プッシュの比較

通常のプッシュ通知は毎回新しい通知を送信しますが、Live Notificationsは時間の経過とともに更新される単一の通知を使用します。更新は、同じcollapse_idを使用してCreate Message APIを介して送信されます。

設定

1. Notification Service Extensionを実装する

INotificationServiceExtensionを実装するNotificationServiceExtensionクラスを作成します。このクラスは受信通知を傍受し、変更またはオーバーライドできます。

詳細については、Android Notification Service Extensionを参照してください。

NotificationServiceExtention.kt

package com.onesignal.sample.android

import android.app.NotificationChannel
import android.app.NotificationManager
import android.content.Context
import android.os.Build
import com.onesignal.notifications.INotificationReceivedEvent
import com.onesignal.notifications.INotificationServiceExtension
import org.json.JSONObject
import java.util.logging.Logger

class NotificationServiceExtension : INotificationServiceExtension {
  override fun onNotificationReceived(event: INotificationReceivedEvent) {
        val context = event.context
        val notificationManager = context.getSystemService(Context.NOTIFICATION_SERVICE) as? NotificationManager
            ?: run {
                logger.warning("NotificationManager not available.")
                return
            }

        notificationManager.let {
            if (!notificationChannelsCreated) {
                createNotificationChannels(notificationManager)
            }
        }

        // Use `additional_data`to submit the Live Notification payload.
    		val additionalData = event.notification.additionalData
        val liveNotificationPayload = additionalData?.optJSONObject("live_notification")
        if (liveNotificationPayload == null) {
            logger.info("No live notification payload found. Showing original notification.")
            return
        }

        event.preventDefault()
        handleLiveNotification(event, liveNotificationPayload, notificationManager, context)
    }
}

2. 拡張機能をAndroid Manifestに追加する

  <meta-data android:name="com.onesignal.NotificationServiceExtension"
              android:value="com.onesignal.sample.android.NotificationServiceExtension" />

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:name=".MainApplication"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.OneSignalAndroidSample"
        tools:targetApi="31">
        <meta-data android:name="com.onesignal.NotificationServiceExtension"
            android:value="com.onesignal.sample.android.NotificationServiceExtension" />
        <activity
            android:name=".MainActivity"
            android:exported="true">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

3. Live Notificationタイプを作成する

Live Notification Typeは、どのLive Notificationを開始するかを示します。

キーを定義する

Live Notificationsはkeyによって参照され、更新がどのようにルーティングされるかを決定します。

NotificationServiceExtention.kt

private const val PROGRESS_LIVE_NOTIFICATION = "progress"

通知チャネルを作成する

チャネルは通知の動作（サウンド、バイブレーション、外観）を定義します。Live Notificationタイプ用のチャネルを作成する必要があります。推奨事項：

進行状況通知には低重要度
バッジを無効にする
サウンドとバイブレーションを最小限に抑える

詳細については、Android Notification Channel Categoriesを参照してください。

Live Notificationをデザインする

Live Notificationをデザインする際、各更新タイプに対して通知デザインを作成する柔軟性があります。作成する各デザインには特定のタイプを割り当てる必要があり、Live Notificationのさまざまなプレゼンテーションが可能になります。

NotificationServiceExtention.kt

private fun updateProgressNotification(
        liveNotificationUpdates: JSONObject,
        context: Context,
        notificationManager: NotificationManager
    ) {
        val currentProgress = liveNotificationUpdates.optInt("current_progress", 0)

        val builder = NotificationCompat.Builder(context, PROGRESS_CHANNEL_ID)
            .setContentTitle("Progress Live Notifications")
            .setContentText("It's working...")
            .setSmallIcon(android.R.drawable.ic_media_play)
            .setLargeIcon(BitmapFactory.decodeResource(context.resources, android.R.drawable.ic_dialog_info))
            .setOngoing(true)
            .setOnlyAlertOnce(true)
            .setProgress(100, currentProgress, false)
            .setAutoCancel(false) // Prevent auto-dismissal of notification until you set the end event

        notificationManager.notify(keyMap[PROGRESS_LIVE_NOTIFICATION]!!, builder.build())
        logger.info("Updated progress notification with progress: $currentProgress")
    }

デザインの考慮事項：

小さいアイコンとアクセントカラー
大きいアイコン
大きい画像
アクションボタン

高度なデザインオプションについては、Android custom notification layoutを参照してください。

4. Live Notificationペイロードを抽出する

Live Notificationsは、構造化されたコンテンツを渡すためにadditional_dataフィールドを使用します。

NotificationServiceExtention.kt

val additionalData = event.notification.additionalData
val liveNotificationPayload = additionalData?.optJSONObject("live_notification")

Live Notificationスキーマ

Property	Required	Description
`key`	Yes	正しい通知UIを読み込むために使用されます。
`event`	Yes	Live Notificationに対して実行するアクション。
`event_attributes`	No	Live Notificationを初期化するために使用される静的データ。通知に必要なデータを定義する自己定義スキーマ。
`event_updates`	No	Live Notificationの動的コンテンツ。アプリのLive Notification内で定義されたContentStateインターフェースに準拠する必要があります。

Example Live Notification Payload

  {
      "key": "celtics-vs-lakers",
      "event": "start",
      "event_attributes": {
          "homeTeam": "Celtics",
          "awayTeam": "Lakers",
          "game": "Finals Game 1"
      },
      "event_updates": {
          "quarter": 1,
          "homeScore": 0,
          "awayScore": 0,
      }
  }

5. Live Notificationイベントを処理する

各Live Notificationは、以下のイベントに応答する必要があります：

Event	Description	Required fields
`start`	静的データと動的データでLive Notificationを開始します。	`event_attributes`, `event_updates`
`update`	新しい動的データでLive Notificationを更新します。	`event_updates`
`end`	Live Notificationを終了して削除します。	なし

NotificationServiceExtention.kt

val liveNotificationEvent = liveNotificationPayload.optString("event", "")

Live Notificationを開始する

Live Notificationを開始する準備ができたら：

event_attributesを設定して、Live Notificationの静的データを初期化します。このデータは、Live Notificationの存続期間中は変更されません。
event_updatesデータを設定して、Live Notificationの動的データを初期化します。これは、Live Notificationの存続期間中に変更される可能性があり、実際に変更されるデータです。
collapse_idを使用して、各更新が前の更新を上書きすることを確認します。このIDは、後続の更新が同じ通知に反映されるように、Live Notificationに固有である必要があります。

curl

  curl -X "POST" "https://api.onesignal.com/notifications" \
       -H 'Authorization: key YOUR_REST_API_KEY' \
       -H 'Content-Type: application/json; charset=utf-8' \
       -d $'{
    "app_id": "YOUR_APP_ID",
    "isAndroid": true,
    "collapse_id": "THE_UNIQUE_ID_FOR_THIS_LIVE_NOTIFICATION",
    "data": {
      "live_notification": {
        "key": "progress",
        "event": "start",
        "event_attributes": {},
        "event_updates": {
          "current_progress": 0
        }
      }
    },
    "headings": {
      "en": "Start"
    },
    "contents": {
      "en": "Starting Live Notification"
    },
    "include_aliases": {
      "external_id": ["EID1", "EID2"]
    },
    "target_channel": "push"
  }'

Live Notificationを更新する

最初に開始されている限り、Live Notificationは何度でも更新できます。

event_updatesデータを設定して、Live Notificationの動的データを初期化します。これは、Live Notificationの存続期間中に変更される可能性があり、実際に変更されるデータであり、Live Notificationのコンテンツを何で更新するかを通知します。

cURLリクエストの例

curl

  curl -X "POST" "https://api.onesignal.com/notifications" \
       -H 'Authorization: key YOUR_REST_API_KEY' \
       -H 'Content-Type: application/json; charset=utf-8' \
       -d $'{
    "app_id": "YOUR_APP_ID",
    "isAndroid": true,
    "collapse_id": "THE_UNIQUE_ID_FOR_THIS_LIVE_NOTIFICATION",
    "data": {
      "live_notification": {
        "key": "progress",
        "event": "update",
  			"event_attributes": {},
        "event_updates": {
          "current_progress": 80
        }
      }
    },
    "headings": {
      "en": "Update"
    },
    "contents": {
      "en": "Updating Live Notification"
    },
    "include_aliases": {
      "external_id": ["EID1", "EID2"]
    },
    "target_channel": "push"
  }'

Live Notificationを終了する

cURLリクエストの例

curl

  curl -X "POST" "https://api.onesignal.com/notifications" \
       -H 'Authorization: key YOUR_REST_API_KEY' \
       -H 'Content-Type: application/json; charset=utf-8' \
       -d $'{
    "app_id": "YOUR_APP_ID",
    "isAndroid": true,
    "collapse_id": "THE_UNIQUE_ID_FOR_THIS_LIVE_NOTIFICATION",
    "data": {
      "live_notification": {
        "key": "progress",
        "event": "dismiss"
      }
    },
    "headings": {
      "en": "Dismissing"
    },
    "contents": {
      "en": "Dismissing Live Notification"
    },
    "include_aliases": {
      "external_id": ["EID1", "EID2"]
    },
    "target_channel": "push"
  }'

Live Notificationの作成に成功しました！関連ドキュメント：

開発者ドキュメント

モバイルSDK

ウェブSDK

ライブアクティビティ

デスクトップ & ウォッチセットアップ

Android live notifications

要件

Live notificationsと標準プッシュの比較

設定

1. Notification Service Extensionを実装する

2. 拡張機能をAndroid Manifestに追加する

3. Live Notificationタイプを作成する

キーを定義する

通知チャネルを作成する

Live Notificationをデザインする

4. Live Notificationペイロードを抽出する

Live Notificationスキーマ

5. Live Notificationイベントを処理する

Live Notificationを開始する

Live Notificationを更新する

Live Notificationを終了する

​要件

​Live notificationsと標準プッシュの比較

​設定

​1. Notification Service Extensionを実装する

​2. 拡張機能をAndroid Manifestに追加する

​3. Live Notificationタイプを作成する

​キーを定義する

​通知チャネルを作成する

​Live Notificationをデザインする

​4. Live Notificationペイロードを抽出する

​Live Notificationスキーマ

​5. Live Notificationイベントを処理する

​Live Notificationを開始する

​Live Notificationを更新する

​Live Notificationを終了する

要件

Live notificationsと標準プッシュの比較

設定

1. Notification Service Extensionを実装する

2. 拡張機能をAndroid Manifestに追加する

3. Live Notificationタイプを作成する

キーを定義する

通知チャネルを作成する

Live Notificationをデザインする

4. Live Notificationペイロードを抽出する

Live Notificationスキーマ

5. Live Notificationイベントを処理する

Live Notificationを開始する

Live Notificationを更新する

Live Notificationを終了する