KARTEに送るイベントの定義が確定したら、SDKの導入・イベント実装を行います。

KARTE SDKの導入・イベントを実装する

必要なSDKモジュールのインストール、ロードマップで定めたイベントの実装を行います。

以下Developer Portalに記載の、該当するフレームワークの「SDKを導入する」「イベントを送信する」ドキュメントを元に進めてください。

https://developers.karte.io/docs/about-karte-for-app

※ bridge SDK利用の場合、実装時にApplication Keyの記述が必要です。
※ Application Keyは、検証環境・本番環境のプロジェクト毎に発行されます。

実装時に必要なアプリケーションキー（Application Key）は、KARTE管理画面で確認できるAPIキーとは異なります、ご注意ください。

アプリケーションキーの確認方法

SDK設定ファイル内の、以下 xxxx に記載の文字列が Application Keyです。
- iOS
  <key>karte_app_key</key> <string>{{xxxxxx}}</string>
- Android
  <string name="karte_app_key">{{xxxxxxx}}</string>
参考：SDKの設定ファイルをダウンロードする

サポート期間

KARTE SDKは日々アップデートされ、バージョン毎にサポート期間が設定されています。各バージョンのサポート対象期間とリリース状況は下記をご参照ください。

webviewを計測する

webviewはwebページをアプリ内で表示する機能となります。
一般的にすべてのページをNativeで作っているケースは少なく、webviewを活用したアプリが大半となりますので、アプリ内にwebviewが存在するか事前にご確認ください。

設定

javascriptを有効にする必要があります
接客の内容によっては、localStorageを有効にする必要があります

実装方法①：計測タグを設置する場合

webviewにてカスタムイベントを送信する場合には計測タグの設置が必要となります。
通常はこちらの設定を推奨します。

1.計測タグを設置する

webviewで閲覧されるウェブページ内にKARTE計測タグを設置します。設置方法はこちらをご確認ください。

KARTE for Appのみご契約の場合にはアプリ内ブラウザのみで利用可能な計測タグが発行されます。すでにwebにて計測タグを設置されている場合には追加の作業は不要となり、webで送信しているフィールドはすべてアプリでのトラッキング時にも送られます。

なお、カスタムイベントを発生させる場合にはweb側でカスタムタグを設置ください。設置方法はこちらになります。

計測タグを設置しただけでは、ネイティブアプリSDKでトラッキングした情報と、計測タグでトラッキングした情報は、それぞれ別のユーザーの行動として扱われるため、アプリ側での実装が必要となります。
– tracker.js/edge.jsが発行する全イベントの_sourceフィールドにnative_app_webviewが付く
– tracker.js/edge.jsが自動発行するviewイベントにapp_infoのフィールドが付く

実装方法は以下をご参照ください。

3. Appとしての計測ができているか確認する

ユーザーストーリ上でイベントに[APP]と表示されて入れば紐付けが完了しています。

null

実装方法②：計測タグを設置しない場合

webviewのページ遷移時に、アプリ内でトラッキングする場合には、webページからはURLとtitleのみ取得可能になります。

実装方法は以下をご参照ください。

API経由で計測する

SDK経由ではなくサーバーサイドAPI を使ってイベントを送信することができます。
プラグインが必要となるため、ご使用を希望される場合には営業担当・サポート担当までご連絡ください。

プッシュ通知の設定をする

プッシュ通知はFCM（Firebase Cloud Messaging）経由で配信するため、FCMのSDKの実装が必要となります（トラッキングとポップアップのみであれば、FCM SDKは必要ありません）。
スタンダードなテキストベースのプッシュ通知のほか、画像などを活用したリッチ通知にも対応しています。

iOSにおいて、画像などを添付するリッチプッシュ通知を行うには、通常のプッシュ通知のための実装に追加で、別途実装が必要になります。

Androidでは画像のみ添付可能ですが、通常のプッシュ通知実装のみで表示可能です。

FCMのtokenや、アプリPUSH通知の許諾状況がKARTEに送信されるタイミングはいつですか？

下記3パターンのタイミングでKARTEに送信されます。
- (1) アプリ起動時（SDK初期化時）
- (2) FCMの登録トークンが更新された時
- (3) アプリフォアグラウンド復帰時（トークン更新があった場合のみ）

仕組み

FCMのAPIは、FCM HTTP v1 APIをご使用ください。
null

設定

アプリプッシュ通知の設定方法、プッシュ通知を送信するを参照してください。

リンク先の実装（Custom URL Scheme）を確認する

KARTE for App でのアプリ内メッセージのリンククリック時遷移先、およびアプリPUSH通知のタップ時の遷移先を指定する際には、事前に Custom URL Schemeの実装が必要となります。リンククリック時のSDKのデフォルトの挙動については、以下ご参考ください。Universal Link（iOS）等のDeepLinkは、デフォルトでは非対応となるのでご注意ください。

【アプリ内メッセージ】
アプリ内メッセージのリンクを制御する（iOS）
アプリ内メッセージのリンクを制御する（Android）

【アプリPUSH通知】
アプリＰＵＳＨ通知_通知開封時の実装をする(iOS)
アプリＰＵＳＨ通知_通知表示処理の実装をする(Android)

【実装例】
Universal Links に対応する(iOS)

SDKの導入・イベントを実装する