ライブアクティビティを開始

このエンドポイントを使用して、iOSアプリに表示されるライブアクティビティをリモートで開始します。このエンドポイントには追加の設定が必要です。

ライブアクティビティを作成したら、セグメント、接続オーディエンス、または特定のユーザーをターゲットにしてPOSTリクエストを送信します。特定のユーザーは、外部ユーザー ID、ユーザーエイリアス、またはその両方で指定します。Appleのライブアクティビティの詳細については、Starting and updating Live Activities with ActivityKit push notificationsを参照してください。

content-available が設定されていない場合、Appleプッシュ通知サービス（APNs）のデフォルトの優先度は10です。content-available が設定されている場合、この優先度は5になります。詳細については、Appleプッシュオブジェクトを参照してください。

重要

/messages/live_activity/start リクエストが成功した後、同じ activity_id に対して最初の /messages/live_activity/update リクエストを送信するまで、少なくとも5分間待ってください。この待機時間により、BrazeとAPNsが新しいライブアクティビティとそのトークンマッピングを登録できます。最初の更新を早く送信しすぎると、その更新がアクティビティに適用されない場合があります。

ヒント

ライブアクティビティを終了するには、end_activity を true に設定して/messages/live_activity/updateエンドポイントを使用します。

自動非表示の設定

ライブアクティビティの開始後に自動で非表示にするには、バックエンドから更新エンドポイントへのフォローアップリクエストをスケジュールします。

1. 後で再利用できる activity_id を指定して /messages/live_activity/start リクエストを送信します。
2. その activity_id とターゲット終了時刻をバックエンドのスケジューラーに保存します。
3. ターゲット終了時刻に、end_activity を true に設定した /messages/live_activity/update リクエストを送信します。
4. 同じ更新リクエストで非表示の動作を設定します。詳細については、/messages/live_activity/updateエンドポイントを参照してください。
5. メッセージアクティビティログで送信イベントと結果イベントを確認します。