アプリ内メッセージ

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

前提条件

この機能を使用する前に、Android Braze SDKを統合する必要があります。 You’ll also need to enable in-app messages.

Message types

android

Braze には、いくつかのデフォルトのアプリ内メッセージタイプが用意されています。各メッセージ、イメージ、フォントアウェソームアイコン、クリックアクション、アナリティクス、カラースキームなどでカスタマイズできます。

これらの基本的な動作と特性は、IInAppMessage インターフェイスによって定義されます。InAppMessageBase というサブクラスで定義されます。IInAppMessage には、サブインターフェイス、IInAppMessageImmersive も含まれており、アプリにclose、click-action、analytics [buttons

important:

ボタンを含むin-app メッセージは、ボタンテキストを追加する前にクリックアクションが追加された場合、最終ペイロードにclickAction メッセージが含まれます。

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

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

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

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

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

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

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

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

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

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

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

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

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

important:

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

tip:

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

Enabling in-app messages

Step 1: Register `BrazeInAppMessageManager`

In-app message display is managed by the BrazeInAppMessageManager class. Every activity in your app must be registered with the BrazeInAppMessageManager to allow it to add in-app message views to the view hierarchy. There are two ways to accomplish this:

automatically
manually

The activity lifecycle callback integration handles in-app message registration automatically; no extra integration is required. This is the recommended method for handling in-app message registration.

warning:

If you’re using activity lifecycle callback for automatic registration, do not complete this step.

In your Application.onCreate(), call ensureSubscribedToInAppMessageEvents():

java
kotlin

BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context);

BrazeInAppMessageManager.getInstance().ensureSubscribedToInAppMessageEvents(context)

In every activity where in-app messages can be shown, call registerInAppMessageManager() in that activity’s 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)
}

In every activity where registerInAppMessageManager() was called, call unregisterInAppMessageManager() in that activity’s 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)
}

Step 2: Update the manager’s blocklist (optional)

In your integration, you may require that certain activities in your app should not show in-app messages. The activity lifecycle callback integration provides an easy way to accomplish this.

The following sample code adds two activities to the in-app message registration blocklist, SplashActivity and SettingsActivity:

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を統合する必要があります。アプリ内メッセージも有効にする必要がある。

メッセージの種類

swift

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

Slideup アプリ内メッセージにはこの名前が付けられます。なぜなら、これらのメッセージには”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にアプリ内メッセージを表示させるには、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 を拡張します。

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

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

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

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

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

guide/prerequisites/flutter.md developer_ %}

メッセージの種類

android
swift

important:

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

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

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

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

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

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

guide/prerequisites/react_native.md developer_ %}

メッセージの種類

android
swift

important:

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

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

次の例は、ページ分割された 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 ボタンのクリックアクションのタイプ。3つのタイプは次のとおりです。NEWS_FEED、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 ユーザーがボタンをクリックしたときに処理されるクリックアクションのタイプ。3つのタイプは次のとおりです。NEWS_FEED、URI、そして NONE。

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

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

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

Prerequisites

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

Roku: 0.1.2+

メッセージの種類

android
swift

important:

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

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

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

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

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

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

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

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

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

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

ステップ2:トリガーされたメッセージへのアクセス

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

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を統合する必要があります。

Message types

android
swift

important:

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

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

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

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

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

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

guide/prerequisites/xamarin.md developer_ %}

メッセージの種類

android
swift

important:

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

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

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

important:

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

tip:

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

これらは、Braze で利用可能なアプリ内メッセージタイプと、エンドユーザーにとってどのように見えるかです。

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

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

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

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

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

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

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

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

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

GitHub でこのページを編集

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

GitHub でこのページを編集

New Stuff!

アプリ内メッセージ

前提条件

Message types

Enabling in-app messages

Step 1: Register BrazeInAppMessageManager

Step 2: Update the manager’s blocklist (optional)

前提条件

メッセージの種類

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

ステップ1:の実装を作成する。 BrazeInAppMessagePresenter

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

Prerequisites

メッセージの種類

前提条件

About TV and OTT support

Prerequisites

Message types

メッセージの種類

メッセージの種類

データモデル

メッセージ

ボタン

Prerequisites

メッセージの種類

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

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

ステップ2:トリガーされたメッセージへのアクセス

メッセージフィールド

取扱い

スタイリング

ボタン

前提条件

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

前提条件

Message types

メッセージの種類

Step 1: Register `BrazeInAppMessageManager`

ステップ1:の実装を作成する。 `BrazeInAppMessagePresenter`