インターフェイス: UpdatePayload
context.updateAsync のペイロード。コンテキストに送信するメッセージを定義します。
目次
プロパティ
プロパティ
action
• Optional action: "CUSTOM"
使用するメッセージフォーマット。
cta
• Optional cta: string | LocalizableContent
call-to-action ボタンのテキスト。
data
• Optional data: Record<string, unknown>
このコンテキスト・メッセージから起動されるセッションに渡されるオブジェクト。文字列に変換する場合、文字数は1000文字以下でなければなりません。 また、Wortal.session.getEntryPointData() からアクセスが可能です。
image
• image: string
表示する base64 エンコード画像のデータURL。こちらは、ペイロードを送信するために必要です。
media
• Optional media: MediaParams
GIFまたはビデオの任意のコンテンツ。レンダリングするためには、少なくとも1つの画像またはメディアを提供する必要があります。
プラットフォーム： Facebookのみ
notifications
• Optional notifications: "NO_PUSH" | "PUSH"
更新通知の設定を指定します。”NO_PUSH” または ”PUSH” で設定し、デフォルトは ”NO_PUSH” となります。プッシュ通知は、受信者がすぐに実行可能なアップデートにのみ使用してください。ただし、ユーザー設定やプラットフォームのポリシーによっては、プッシュ通知が許可されない場合があります。
strategy
• Optional strategy: "IMMEDIATE" | "LAST" | "IMMEDIATE_CLEAR"
アップデートの配信方法を指定します。以下から指定することができます：
- 'IMMEDIATE' - アップデートはすぐに配信されます。
- 'LAST' - ゲームセッションが終了すると、アップデートが配信されます。送信されるのは、'LAST' ストラテジーが使用された最新版です。
- 'IMMEDIATE_CLEAR': すぐに送信され、同じセッションで保留中の LAST ペイロードも破棄されます。
ストラテジーの指定がない場合、デフォルトは ”IMMEDIATE” となります。
template
• Optional template: string
こちらのカスタムアップデートが使用しているテンプレートID。テンプレートはあらかじめ fbapp-config.json で定義しておく必要があります。 fbapp-config.json については、Bundle Config documentationを参照してください。
プラットフォーム： Facebookのみ
text
• text: string | LocalizableContent
テキストメッセージ、若しくはデフォルトのテキストを default の値とするオブジェクトや、ロケールのキーをマッピングした localizations の値とする別のオブジェクト。