アプリ内メッセージ

アプリ内メッセージとBraze SDKの設定方法について学習する。

前提条件

この機能を使用する前に、Android Braze SDKを統合する必要があります。アプリ内メッセージも有効にする必要がある。

メッセージの種類

android

Braze には、メッセージ、”画像 s、フォントアウェゾームアイコン、アクションs、分析、カラースキームなど、カスタマイズ可能な複数のデフォルトアプリ内メッセージタイプがあります。

これらの基本的な動作と特性は、IInAppMessage インターフェイスによって定義されます。InAppMessageBase と呼ばれるサブクラスで定義されます。IInAppMessage には、サブインターフェイス、IInAppMessageImmersive も含まれます。これにより、アプリにclose、click-アクション、および分析ボタン

important:

ボタンを含むアプリ内メッセージs は、ボタンテキストを追加する前にクリックアクションが追加されている場合、最終的な支払い読み込むにclickAction メッセージを含めます。

slideup アプリ内メッセージは、画面の上部または下部から「スライドアップ」または「スライドダウン」するため、このような名前が付けられています。画面の一部分だけを覆い、効果的で邪魔にならないメッセージング機能を提供します。

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

携帯電話の画面の下部からスライドして表示されるアプリ内メッセージに「人間は複雑だ」と表示されています。カスタムエンゲージメントは、そうであってはなりません。バックグラウンドには、同じアプリ内メッセージが Web ページの下端に表示されています。

modal アプリ内メッセージは画面中央に表示され、半透明のパネルに囲まれます。より重要なメッセージングの場合に有用で、2 つのクリックアクションと分析対応ボタンを装備できます。

このメッセージタイプは、InAppMessageImmersiveBase のサブクラスです。これは、IInAppMessageImmersive を実装する抽象クラスで、ローカルに生成されたアプリ内メッセージs にカスタム機能を追加するオプションを提供します。

携帯電話の画面中央のモーダルアプリ内メッセージに「人間は複雑だ」と表示されています。カスタム・エンゲージメントはそうあるべきでない。バックグラウンドには、同じアプリ内メッセージが Web ページの中央に表示されています。

full アプリ内メッセージは、ユーザーコミュニケーションの内容とインパクトを最大化するのに有効です。full アプリ内メッセージの上半分には画像が含まれ、下半分にはテキストと最大 2 つのクリックアクションと分析対応ボタンが表示されます。

このメッセージタイプは、InAppMessageImmersiveBase を拡張し、ローカルで生成されたアプリ内メッセージs にカスタム機能を追加するオプションを提供します。

携帯電話の画面全体に表示されるアプリ内メッセージには、「人間は複雑だ。カスタムエンゲージメントは、そうであってはなりません。バックグラウンドには、同じアプリ内メッセージが Web ページの中央に大きく表示されています。

HTML アプリ内メッセージは、完全にカスタマイズされたユーザーコンテンツを作成するのに便利です。ユーザー定義の HTML アプリ内のメッセージコンテンツは、WebView に表示され、必要に応じて画像やフォントなどの他のリッチコンテンツを含めることができます。これにより、メッセージの外観と機能を完全に制御できます。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

Android アプリ内メッセージでは、JavaScript brazeBridge インターフェイスを使用してHTML内からBraze Android SDKのメソッドを呼び出すことができます。詳しくは、JavaScript bridge を参照してください。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

また、アプリのカスタムアプリ内メッセージビューを定義することもできます。詳細については、カスタムファクトリーの設定を参照してください。

アプリ内メッセージを有効にする

ステップ 1: 登録する `BrazeInAppMessageManager`

アプリ内メッセージ表示は BrazeInAppMessageManager クラスによって管理されまｓ。アプリ内のすべてのアクティビティを BrazeInAppMessageManager に登録して、アプリ内メッセージビューをビュー階層に追加できるようにする必要があります。これを行うには次の 2 つの方法があります。

自動的に
手動で

アクティビティライフサイクルコールバック統合はアプリ内メッセージ登録を自動的に処理するため、追加の統合は不要です。これはアプリ内メッセージ登録の推奨方法である。

warning:

自動登録にアクティビティ・ライフサイクル・コールバックを使用している場合は、このステップを完了させないこと。

あなたの Application.onCreate()を呼び出す ensureSubscribedToInAppMessageEvents():

java
kotlin

BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context);

BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context)

アプリ内メッセージを表示できるすべてのアクティビティで、そのアクティビティの registerInAppMessageManager()onResume()を呼び出す：

java
kotlin

@Override
public void onResume() {
  super.onResume();
  // Registers the BrazeInAppMessageManager for the current Activity. This Activity will now listen for
  // in-app messages from Braze.
  BrazeInAppMessageManager.getInstance().registerInAppMessageManager(activity);
}

public override fun onResume() {
  super.onResume()
  // Registers the BrazeInAppMessageManager for the current Activity. This Activity will now listen for
  // in-app messages from Braze.
  BrazeInAppMessageManager.getInstance().registerInAppMessageManager(this)
}

がコールされたすべてのアクティビティにおいてである。 registerInAppMessageManager()が呼び出されたすべてのアクティビティで、そのアクティビティの unregisterInAppMessageManager()onPause()を呼び出す：

java
kotlin

@Override
public void onPause() {
  super.onPause();
  // Unregisters the BrazeInAppMessageManager for the current Activity.
  BrazeInAppMessageManager.getInstance().unregisterInAppMessageManager(activity);
}

public override fun onPause() {
  super.onPause()
  // Unregisters the BrazeInAppMessageManager.
  BrazeInAppMessageManager.getInstance().unregisterInAppMessageManager(this)
}

ステップ 2:マネージャーのブロックリストを更新する（オプション）

統合では、アプリ内の特定のアクティビティにアプリ内メッセージを表示しないようにする必要が生じる場合があります。アクティビティライフサイクルコールバックの統合により、これを簡単に実現できます。

次のサンプルコードでは、アプリ内メッセージ登録禁止リストに SplashActivity と SettingsActivity という 2 つのアクティビティを追加します。

java
kotlin

public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    Set<Class> inAppMessageBlocklist = new HashSet<>();
    inAppMessageBlocklist.add(SplashActivity.class);
    inAppMessageBlocklist.add(SettingsActivity.class);
    registerActivityLifecycleCallbacks(new BrazeActivityLifecycleCallbackListener(inAppMessageBlocklist));
  }
}

class MyApplication : Application() {
  override fun onCreate() {
    super.onCreate()
    val inAppMessageBlocklist = HashSet<Class<*>>()
    inAppMessageBlocklist.add(SplashActivity::class.java)
    inAppMessageBlocklist.add(SettingsActivity::class.java)
    registerActivityLifecycleCallbacks(BrazeActivityLifecycleCallbackListener(inAppMessageBlocklist))
  }
}

前提条件

この機能を使用する前に、Swift Braze SDKを統合する必要があります。アプリ内メッセージs も有効にする必要があります。

メッセージの種類

swift

各アプリ内メッセージタイプは、コンテンツ、画像、アイコン、クリックアクション、分析、表示、配信に渡って高度にカスタマイズできます。これらは列挙型のBraze.InAppMessageで、すべてのアプリ内メッセージsの基本的な振る舞いと形質を定義します。アプリ内メッセージのプロパティーと使用法の完全な一覧については、InAppMessage クラスを参照してください。

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

Slideup アプリ内メッセージ s にはこの名前が付けられます。これは、slide up” または”slide down” が、スクリーンの上部または下部にあるためです。画面の一部分だけを覆い、効果的で邪魔にならないメッセージング機能を提供します。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

Modal アプリ内メッセージは画面中央に表示され、半透明のパネルに囲まれます。よりクリティカルなメッセージングに有用で、最大2つのアナリティクス対応ボタンを装備できる。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

Modal Image アプリ内メッセージは画面中央に表示され、半透明のパネルに囲まれます。これらのメッセージは、ヘッダーやメッセージテキストがないことを除けば、Modal タイプに似ている。よりクリティカルなメッセージングに有用で、最大2つのアナリティクス対応ボタンを装備できる。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

Full アプリ内メッセージは、ユーザーコミュニケーションの内容とインパクトを最大化するのに有効です。Full アプリ内メッセージの上半分には画像が含まれ、下半分にはテキストと最大2つの分析対応ボタンが表示されます。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

Full Image アプリ内メッセージは、ヘッダーやメッセージテキストがないことを除けば、Full アプリ内メッセージと似ている。このメッセージタイプは、ユーザーコミュニケーションの内容とインパクトを最大化するのに有効です。Full Image アプリ内メッセージには画面全体に広がる画像が含まれ、オプションで最大2つの分析対応ボタンが表示されます。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

HTML アプリ内メッセージは、完全にカスタマイズされたユーザーコンテンツを作成するのに便利です。ユーザー定義の HTML アプリ内のフルメッセージコンテンツは、WKWebView に表示され、必要に応じて画像やフォントなどの他のリッチコンテンツを含めることができます。これにより、メッセージの外観と機能を完全に制御できます。

iOS アプリ内メッセージは、HTML 内から Braze Web SDK のメソッドを呼び出すための JavaScript brazeBridge インターフェイスをサポートしています。詳細については、ベストプラクティスを参照してください。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

Control アプリ内メッセージには UI コンポーネントは含まれず、主に分析用に使用されます。このタイプは、コントロールグループに送信されたアプリ内メッセージの受信を確認するために使用される。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

アプリ内メッセージを有効にする

ステップ 1: インプリメンテーションを作成する `BrazeInAppMessagePresenter`

Braze にアプリ内メッセージs を表示させるには、BrazeInAppMessagePresenter プロトコールのインプリメンテーションを作成し、それをBrazeインスタンスのオプションのinAppMessagePresenter に割り当てます。BrazeInAppMessageUI オブジェクトをインスタンス化することで、デフォルトの Braze UI プレゼンターを使用することもできます。

BrazeInAppMessageUI クラスにアクセスするには、BrazeUI ライブラリーをインポートする必要があることに注意してください。

swift
objective-c

AppDelegate.braze?.inAppMessagePresenter = BrazeInAppMessageUI()

AppDelegate.braze.inAppMessagePresenter = [[BrazeInAppMessageUI alloc] init];

ステップ 2:一致するトリガーを扱わない

BrazeDelegate.(_:noMatchingTriggerForEvent)を該当するBrazeDelegateクラス内に実装します。Braze は、特定のイベントに一致するトリガーを検出できない場合、このメソッドを自動的に呼び出します。

Prerequisites

Before you can use this feature, you’ll need to integrate the Web Braze SDK. ただし、追加のセットアップは必要ありません。

メッセージの種類

すべてのアプリ内メッセージは、そのプロトタイプを [InAppMessage] から継承します。このプロトタイプは、すべてのアプリ内メッセージの基本動作と特徴を定義しています。プロトタイプのサブクラスは以下の通りである。 SlideUpMessage, ModalMessage, FullScreenMessageおよび HtmlMessage.

各アプリ内メッセージタイプは、コンテンツ、画像、アイコン、クリックアクション、分析、表示、配信にわたってカスタマイズできます。

SlideUp アプリ内メッセージは、伝統的にモバイルプラットフォームでは、画面の上部または下部から「スライドアップ」または「スライドダウン」するため、このような名前が付けられている。Braze Web SDK では、これらのメッセージは、Web の主流のパラダイムに合わせて Growl または Toast スタイルの通知として表示されます。画面の一部分だけを覆い、効果的で邪魔にならないメッセージング機能を提供します。

携帯電話の画面の下部からスライドして表示されるアプリ内メッセージに「人間は複雑だ」と表示されています。カスタム・エンゲージメントはそうあるべきでない。バックグラウンドには、同じアプリ内メッセージが Web ページの下端に表示されています。

Modal アプリ内メッセージは画面中央に表示され、半透明のパネルに囲まれます。より重要なメッセージングに有用で、最大2つのクリックアクションと分析対応ボタンを装備できます。

Full アプリ内メッセージは、ユーザーコミュニケーションの内容とインパクトを最大化するのに有効です。狭いブラウザウィンドウ (例えばモバイル Web) では、full アプリ内メッセージがブラウザウィンドウ全体を占めます。大きなブラウザウィンドウでは、full アプリ内メッセージは、modal アプリ内メッセージと同様に表示されます。full アプリ内メッセージの上半分には画像が含まれ、下半分には最大8行のテキストと最大2つのクリックアクション、アナリティクス対応ボタンが表示される。

携帯電話の画面全体に表示されるアプリ内メッセージには、「人間は複雑だ。カスタム・エンゲージメントはそうあるべきでない。バックグラウンドには、同じアプリ内メッセージが Web ページの中央に大きく表示されています。

HTML アプリ内メッセージは、完全にカスタマイズされたユーザーコンテンツを作成するのに便利です。ユーザー定義の HTML は、iFrame に表示され、画像やフォント、動画、インタラクティブ要素などのリッチコンテンツを含めることができます。これにより、メッセージの外観と機能を完全にコントロールできます。これらは、HTML 内から Braze Web SDK のメソッドを呼び出すためのJavaScript brazeBridge インターフェイスをサポートしています。詳しくは、ベストプラクティスを参照してください。

important:

Web SDK を介して HTML アプリ内メッセージを有効にするには、allowUserSuppliedJavascript 初期化オプションを Braze に指定する必要があります。例: braze.initialize('YOUR-API_KEY', {allowUserSuppliedJavascript: true})。これはセキュリティ上の理由からだ。HTML のアプリ内メッセージは JavaScript を実行できるため、サイト管理者が有効にする必要があります。

次の例は、ページ分割されたHTMLアプリ内メッセージを示している：

コンテンツのカルーセルとインタラクティブボタンを含む HTML アプリ内メッセージ。

前提条件

この機能を使用する前に、Android Braze SDKを統合する必要があります。

About TV and OTT support

The Android Braze SDK natively supports displaying in-app messages on OTT devices like Android TV or Fire Stick. However, there’s some key differences between native Android and OTT in-app messages. For OTT devices:

In-app messages that require touch mode, such as slideup, are disabled on OTT.
The currently selected or focused item, such as a button or close button, will be highlighted.
Body clicks on the in-app message itself, such as not on a button, are not supported.

Prerequisites

Before you can use this feature, you’ll need to integrate the Cordova Braze SDK.

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

前提条件

この機能を使う前に、Flutter Braze SDKを統合する必要がある。

メッセージの種類

android
swift

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

Prerequisites

Before you can use this feature, you’ll need to integrate the React Native Braze SDK.

メッセージの種類

android
swift

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

データモデル

アプリ内メッセージのモデルは、React Native SDK で利用できます。Braze には、同じデータモデルを共有する4つのアプリ内メッセージタイプ (スライドアップ、モーダル、フル、HTML フル) があります。

メッセージ

アプリ内メッセージモデルは、すべてのアプリ内メッセージのベースを提供します。

プロパティ説明

inAppMessageJsonString メッセージのJSON表現。

message メッセージテキスト。

header メッセージのヘッダーである。

uri ボタンをクリックするアクションに関連するURI。

imageUrl メッセージ画像のURL。

zippedAssetsUrl HTMLコンテンツを表示するために準備されたzip圧縮された資産。

useWebView ボタンをクリックしたアクションがウェブビューを使ってリダイレクトされるかどうかを示す。

duration メッセージの表示時間。

clickAction ボタンのクリックアクションのタイプ。タイプは、URI、およびNONE です。

dismissType メッセージのクローズタイプ。2つのタイプは次のとおりです。SWIPE およびAUTO_DISMISS。

messageType SDKがサポートするアプリ内メッセージタイプ。4つのタイプは次のとおりです。SLIDEUP、MODAL、FULL および HTML_FULL。

extras メッセージエクストラ辞書。デフォルト値：[:].

buttons アプリ内メッセージのボタン一覧。

toString() String表現としてのメッセージ。

アプリ内メッセージモデルの完全なリファレンスについては、[Android] および [iOS] のドキュメントを参照してください。

ボタン

アプリ内メッセージにボタンを追加して、アクションを実行したり、分析をログに記録したりできます。ボタンモデルは、すべてのアプリ内メッセージボタンのベースを提供します。

プロパティ説明

text ボタンのテキスト。

uri ボタンをクリックするアクションに関連するURI。

useWebView ボタンをクリックしたアクションがウェブビューを使ってリダイレクトされるかどうかを示す。

clickAction ユーザーがボタンをクリックしたときに処理されるクリックアクションのタイプ。タイプは、URI、およびNONE です。

id メッセージのボタンID。

toString() String表現としてのボタン。

ボタンモデルの完全なリファレンスについては、[Android] および [iOS] のドキュメントを参照してください。

Prerequisites

Before you can use this feature, you’ll need to integrate the Roku Braze SDK. さらに、アプリ内メッセージs は、サポートされている最低SDKバージョンを実行しているRoku デバイスにのみ送信されます。

Roku: 0.1.2+

メッセージの種類

android
swift

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

アプリ内メッセージを有効にする

ステップ 1: オブザーバーを追加する

アプリ内メッセージを処理するため、BrazeTask.BrazeInAppMessage でオブザーバーを追加できます。

m.BrazeTask.observeField("BrazeInAppMessage", "onInAppMessageReceived")

ステップ 2:接続トリガーメッセージs

次に、ハンドラ内で、キャンペーンでトリガーされた最上位のアプリ内メッセージにアクセスできます。

sub onInAppMessageReceived()
  in_app_message = m.BrazeTask.BrazeInAppMessage
  ...
end sub

メールフィールド設定

取扱い

以下は、アプリ内メッセージを処理するために必要なフィールドのリストです。

フィールド説明

buttons ボタンのリスト（空のリストである可能性があります）。

click_action "URI" または "NONE"。このフィールドを使用して、URI リンクに対してアプリ内メッセージを開くか、クリックしたときにメッセージを閉じるかを指定します。ボタンがない場合、アプリ内メッセージが表示されているときにユーザーが「OK」をクリックすると、これが発生するはずです。

dismiss_type "AUTO_DISMISS" または "SWIPE"。このフィールドを使用して、アプリ内メッセージが自動的に閉じられるか、スワイプで消去する必要があるかを指定します。

display_delay アプリ内メッセージを表示するまでの待機時間（秒）。

duration dismiss_typeが"AUTO_DISMISS"に設定されている場合、メッセージが表示される時間（ミリ秒）。

extras キーと値のペア。

header ヘッダーのテキスト。

id インプレッションやクリックを記録するために使用されるID。

image_url アプリ内メッセージ画像URL。

message メッセージ本文テキスト。

uri URI ユーザーは click_action に基づいて送信されます。このフィールドはclick_actionが"URI"のときに含める必要があります。

important:

ボタンを含むアプリ内メッセージの場合、ボタンテキストを追加する前にクリックアクションが追加されると、メッセージ click_action も最終ペイロードに含まれます。

スタイリング

ダッシュボードから使用するよう選択できるさまざまなスタイル指定フィールドもあります。

フィールド説明

bg_color バックグラウンド色。

close_button_color 閉じるボタンの色。

frame_color バックグラウンド画面オーバーレイの色。

header_text_color ヘッダーテキストの色。

message_text_color メッセージテキストの色。

text_align 「START」、「CENTER」、または「END」。選択したテキストの配置。

また、アプリ内メッセージを実装し、Roku アプリケーション内で標準パレットを使用してそのスタイルを指定することもできます。

ボタン

フィールド説明

click_action "URI" または "NONE"。このフィールドを使用して、URI リンクに対してアプリ内メッセージを開くか、クリックしたときにメッセージを閉じるかを指定します。

id ボタン自体のID値。

text ボタンに表示するテキスト。

uri URI ユーザーは click_action に基づいて送信されます。このフィールドはclick_actionが"URI"のときに含める必要があります。

important:

Keep in mind, you’ll need to implement your own custom UI since in-app messaging is supported via headless UI using the Swift SDK—which does not include any default UI or views for tvOS.

前提条件

この機能を使用する前に、Swift Braze SDKを統合する必要があります。

Enabling in-app messages

Step 1: Create a new iOS app

In Braze, select Settings > App Settings, then select Add App. Enter a name for your tvOS app, select iOS—not tvOS—then select Add App.

ALT_TEXT.

warning:

If you select the tvOS checkbox, you will not be able to customize in-app messages for tvOS.

Step 2: Get your app’s API key

In your app settings, select your new tvOS app then take note of your app’s API key. You’ll use this key to configure your app in Xcode.

ALT_TEXT

Step 3: Integrate BrazeKit

Use your app’s API key to integrate the Braze Swift SDK into your tvOS project in Xcode. You only need to integrate BrazeKit from the Braze Swift SDK.

Step 4: Create your custom UI

Because Braze doesn’t provide a default UI for in-app messages on tvOS, you’ll need to customize it yourself. For a full walkthrough, see our step-by-step tutorial: Customizing in-app messages for tvOS. For a sample project, see Braze Swift SDK samples.

前提条件

この機能を使用する前に、Unity Braze SDKを統合する必要があります。

メッセージの種類

android
swift

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

前提条件

この機能を使用する前に、Xamarin Braze SDKを統合する必要があります。

メッセージの種類

android
swift

important:

slideup アプリ内メッセージオブジェクトは InAppMessageBase を拡張します。

このメッセージタイプは、IInAppMessageHtml を実装します。これは、IInAppMessage のサブクラスです。

コンテンツとインタラクティブボタンのカルーセルを持つHTML アプリ内メッセージ。

important:

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

tip:

これらは、Braze で使用可能なアプリ内メッセージタイプと、end-ユーザー s の外観です。

電話機の画面の上部と下部にスライド式で表示されたアプリ内メッセージ。

電話機の画面の中央に表示されたモーダルアプリ内メッセージ。

電話機の画面の中央に表示されたモーダル画面のアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーンのアプリ内メッセージ。

携帯電話の画面全体に表示されるフルスクリーン画像のアプリ内メッセージ。

次の例は、ページ分割された HTML の完全アプリ内メッセージを示しています。

コンテンツのカルーセルとインタラクティブなボタンを備えたHTMLのアプリ内メッセージ。

現在、iOS と Android のプラットフォームでは、iFrame でのカスタム HTML アプリ内メッセージの表示はサポートしていません。

インテリジェントセレクションとコントロールグループについては、インテリジェントセレクションを参照してください。

GitHub でこのページを編集

New Stuff!

アプリ内メッセージ

前提条件

メッセージの種類

アプリ内メッセージを有効にする

ステップ 1: 登録する BrazeInAppMessageManager

ステップ 2:マネージャーのブロックリストを更新する（オプション）

前提条件

メッセージの種類

アプリ内メッセージを有効にする

ステップ 1: インプリメンテーションを作成する BrazeInAppMessagePresenter

ステップ 2:一致するトリガーを扱わない

Prerequisites

メッセージの種類

前提条件

About TV and OTT support

Prerequisites

メッセージの種類

前提条件

メッセージの種類

Prerequisites

メッセージの種類

データモデル

メッセージ

ボタン

Prerequisites

メッセージの種類

アプリ内メッセージを有効にする

ステップ 1: オブザーバーを追加する

ステップ 2:接続トリガーメッセージs

メールフィールド設定

取扱い

スタイリング

ボタン

前提条件

Enabling in-app messages

Step 1: Create a new iOS app

Step 2: Get your app’s API key

Step 3: Integrate BrazeKit

Step 4: Create your custom UI

前提条件

メッセージの種類

前提条件

メッセージの種類

ステップ 1: 登録する `BrazeInAppMessageManager`

ステップ 1: インプリメンテーションを作成する `BrazeInAppMessagePresenter`