施策に沿ったイベント定義書を作成後、実際にSDKの実装にはいっていきます。

1.KARTE SDKを実装する

KARTE SDKの実装方法はエンジニア向けのdeveloper portalに詳しく記載しています。
実装時に必要なApplication Keyは検証環境用と本番環境用をそれぞれ発行しており、申込み後に弊社よりご連絡します。

ロードマップで定めたイベントを実装しましょう。

iOS:https://developers.karte.io/docs/ios-sdk
Android:https://developers.karte.io/docs/android-sdk

各プロジェクトに発行されるapi keyと実装に必要なApplication Keyは異なります。Application Keyを必ずSDK実装を行う担当者に共有しましょう

サポート期間

KARTE SDKは日々アップデートされ、バージョン毎にサポート期間が設定されています。
サポート期間は、当該バージョンの次バージョンのリリース日から6ヶ月後までとなり、サポート対象外のバージョンに関するご質問や不具合対応は行っておりませんので、定期的なアップデートをお願いします。

各バージョンのサポート対象期間とリリース状況は下記をご参照ください。

iOS:サポートポリシー リリースノート
Android:サポートポリシー リリースノート

2.webviewを計測する

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

対応種類

こちらをご参照ください
対応ブラウザ・環境

設定

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

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

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

1.計測タグを設置する

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

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

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

2.WebとAppのユーザーの紐付け処理を実装する

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

実装方法はこちらをご参照ください:iOS android

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

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

null

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

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

実装方法はこちらをご参照ください:iOS Android

3.API経由で計測する

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

サーバサイドAPI概要:https://developers.karte.io/reference#v1-api-overview

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

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

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

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

仕組み

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

設定

1. FCMの登録をおこなう

  1. プロジェクトの作成
  2. APNs認証キーをFirebaseに登録(FCMからiOSデバイスに通知するために必要)
  3. Google API Consoleにて Firebase Cloud Messaging APIを有効化
  4. 外部リンクにアクセスし、Firebaseを利用しているプロジェクトが選択されていることを確認し、APIを有効

2. KARTE SDKの実装をおこなう iOS /android

iOS:https://developers.karte.io/docs/ios-sdk
Android:https://developers.karte.io/docs/android-sdk

3. Karte側でFCM HTTP v1 APIを利用する設定

  1. グローバルナビゲーション>プラグイン設定 > KARTE for App から初期設定
  2. FCMのサーバーキーをKARTEに登録(KARTEからFCMに通信するために必要)
  3. プロジェクトID 設定 > 全般 > プロジェクト に記載されています。
  4. 秘密鍵 設定 > サービスアカウント > Firebase Admin SDK の 新しい秘密鍵の生成から取得
    null