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

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

アプリ内メッセージは、KarteInAppMessaging モジュールを導入することで利用可能です。

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

導入手順

1. Podfile の編集

プロジェクトディレクトリにある Podfile を任意のエディタで開き、KarteInAppMessaging の Pod を追加します。

pod 'KarteInAppMessaging'

2. Pod のインストール

プロジェクトディレクトで下記コマンドを実行し、Pod をインストールします。

pod install

実装手順

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

📘

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

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

📘

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

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

動作確認

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

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

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

トラブルシューティング

Other Linker Flagsに -ObjC が未設定だと正しく KarteInAppMessaging モジュールがロードできません。
通常 pod install 時に自動で設定されますが、手動で追加した設定で上書きしていないかご確認ください。

その他アプリ内メッセージが表示されない場合は、KARTE for App接客が配信されない場合のチェックリスト を参考にしてください。

Updated 6 months ago


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


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.