アプリ内メッセージを表示する

Suggest Edits

アプリケーション内にメッセージ（ダイアログ等）を表示したい場合は、アプリ内メッセージ機能を利用することで実現可能です。

アプリ内メッセージは、Karte.iOS.InAppMessaging もしくは Karte.Android.InAppMessaging パッケージを導入することで利用可能です。

アプリ内メッセージは、SDKから送信したイベントをトリガーに配信され、その後SDKにより自動的にアプリケーション上に表示されます。

導入手順

1. パッケージをインストールする

Visual Studio のサイドバーから Packages を右クリックし Manage NuGet Packages... をクリックします。検索バーに Karte を入力して Karte.iOS.InAppMessaging もしくは Karte.Android.InAppMessaging パッケージをインストールしてください。

2. パッケージの初期化コードを追加する (iOSのみ)

次にアプリケーションにパッケージの初期化コードを追加します。

  1. usingディレクティブを追加
    UIApplicationDelegate を実装したクラスがあるファイル（通常はAppDelegate.cs）に using ディレクティブを追加します。
using Karte.iOS.InAppMessaging;
  1. パッケージの初期化コードを追加
    FinishedLaunching(UIApplication, NSDictionary) メソッド内に初期化コードを追加します。
[Export("application:didFinishLaunchingWithOptions:")]
public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
	KRTApp.SetupWithAppKey("アプリケーションキー");
	KRTInAppMessaging.Configure();
	return true;
}

実装手順

アプリ内メッセージを表示する上で、初期化処理を除くアプリ側の実装は不要です。
一方でアプリケーション側で細かい制御を行いたい場合（ディープリンクによる特定画面への遷移など）は実装が必要になる場合もあります。

📘

アプリ内メッセージの表示を制御する

アプリ側から表示を制御したい場合は、以下をご覧ください。

📘

アプリ内メッセージ上でのリンククリックをトリガーにアプリ内の特定画面に遷移させる

アプリ内メッセージ上でのリンククリックをトリガーにアプリ内の特定画面に遷移させたい場合は、カスタムURLスキームを処理するための実装を事前に行う必要があります。
詳細については、以下をご覧ください。

動作確認（共通）

  1. イベントを送信処理を実装
    接客サービスの配信トリガーとして機能するイベントを実装します。
    イベントの送信については、 イベントを送信する をご覧ください。

  2. 接客サービスを作成
    管理画面上で接客サービスを作成します。
    接客サービスの作成方法については、接客サービス作成の流れ をご覧ください。

  3. アプリケーションで確認
    アプリケーションを起動し、1. で実装したイベントの送信が行われる操作を行い、2. で設定した接客サービスが配信・表示されることを確認します。

Updated 8 months ago