Skip to content

ライブアクティビティを更新する

post

/messages/live_activity/update

このエンドポイントを使用して、iOSアプリが表示するライブ・アクティビティを更新・終了する。このエンドポイントには追加の設定が必要である。

ライブ・アクティビティを登録した後、アップル・プッシュ・ノーティフィケーション・サービス(APN)をアップデートするためにJSONペイロードを渡すことができる。詳しくは、プッシュ通知ペイロードを使ったライブアクティビティの更新 に関する Apple のドキュメントを参照してください。

前提条件

このエンドポイントを使用するには、以下を完了する必要がある:

  • messages.live_activity.update 権限を持つ API キーを生成する。
  • Braze Swift SDK を使用して、リモートまたはローカルでライブアクティビティを登録する。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

Request body

リクエストパラメーター

パラメーター required データ型 説明
app_id 必須 string API キーページから取得したアプリ API 識別子
activity_id 必須 string launchActivity を使用してライブアクティビティを登録する場合は、pushTokenTag パラメーターを使用して、アクティビティのプッシュトークンにカスタム文字列を名前として付けます。

activity_id をこのカスタム文字列に設定して、更新するライブアクティビティを定義します。
content_state required オブジェクト ライブアクティビティを作成する際は、ContentState パラメーターを定義します。このオブジェクトを使って、ContentState の更新値を渡す。

このリクエストのフォーマットは、最初に定義した形状と一致していなければなりません。
end_activity オプション ブール値 true の場合、このリクエストはライブアクティビティを終了します。
dismissal_date オプション 日付
(ISO-8601 文字列)
このパラメーターは、ユーザーの UI からライブアクティビティを削除する時間を定義します。この時間が過去のもので、end_activitytrue の場合、ライブアクティビティは直ちに削除されます。

end_activityfalse であるか、省略された場合、このパラメーターはライブアクティビティのみを更新します。
stale_date オプション 日付
(ISO-8601 文字列)
このパラメーターは、ライブアクティビティのコンテンツがユーザーの UI で古いものとしてマークされたときに、システムに通知します。
notification オプション オブジェクト プッシュ通知を定義する apple_pushオブジェクトを含める。このプッシュ通知の動作は、ユーザーがアクティブかどうか、またはユーザーがプロキシデバイスを使用しているかどうかに依存する。
  • もし notification が含まれており、アップデートが配信されたときにユーザーがiPhoneでアクティブになっていると、更新されたライブ・アクティビティUIがスライドダウンし、プッシュ通知のように表示される。
  • もし notification が含まれており、ユーザーがiPhoneをアクティブにしていない場合、画面が点灯し、ロック画面に更新されたライブ・アクティビティUIが表示される。
  • その notification alert は標準のプッシュ通知としては表示されません。さらに、ユーザーがApple Watchのようなプロキシデバイスを持っている場合は alert が表示される。

リクエスト例

応答

このエンドポイントには、2014XX の2つのステータスコード応答があります。

成功応答の例

リクエストが正しくフォーマットされ、当社がそのリクエストを受け取った場合、201 ステータスコードが返されます。ステータスコード 201 は、次の応答本文を返す可能性があります。

エラー応答例

4XX クラスのステータスコードは、クライアントのエラーを示す。遭遇する可能性のあるエラーの詳細については、APIエラーとレスポンスの記事を参照のこと。

ステータスコード 400 は、次の応答本文を返す可能性があります。

「このページはどの程度役に立ちましたか?」
New Stuff!