ご利用開始までのながれ

検証環境での検証後に、本番環境での実装着手をお願いします。検証環境・本番環境それぞれで、KARTEのプロジェクト/Application Keyが異なりますのでご注意ください。

実装項目について

1. SDKを導入する

以下、ご利用の開発フレームワークに応じた「SDKを導入する」ドキュメントに沿って、利用する機能に応じた必要なモジュールをインストールしてください。

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

2. 各種実装を行う

ステップ2で定めた実装項目に応じて、必要な対応を行なってください。

必須項目

任意項目（必要に応じて対応）

3. イベントを送信する

ユーザーの行動情報（イベント）をKARTEに送信・トラッキングするための実装を行います。

• ステップ4で定めたイベントの仕様（イベント名・フィールド名・値の型・発火タイミング）に沿ってご対応ください。
• ご契約上の計測イベント数上限があるため、必要なイベント・適切な送信タイミングの設計をお願いします
• KARTE SDKが標準で自動送信するイベントについては、重複して送信しないようご注意ください。

実装時は、以下の点をご留意ください。

1. 全ての画面でviewイベントを実装することを推奨します

• KARTE SDKでは、Viewイベントの発火（viewメソッドの呼び出し）が行われた時点で画面の境界を認識し、アプリ内メッセージの表示制御が行われます。
  • Viewイベントの実装漏れがあると、意図した挙動で施策の表示/非表示ができない場合があります。
  • 参考: ネイティブアプリにおける接客表示制御とは
  • 参考: viewイベント送信のベストプラクティス
• 画面の境界を認識させるためには、WeView画面遷移時も、native側でのviewイベントの実装が必要です。
• 参考：viewイベントのスキーマ
  • フィールド
    • view_name：{{画面を識別できる名前（英字表記）}} [文字列]（例：home）
    • title：{{画面を識別できる名前（日本語表記）}} [文字列]（例：ホーム）
  • 発火タイミング：画面遷移時（WebView画面遷移時含む）
    • Viewイベントの送信はアプリ側での “画面遷移の発生” 後に実装してください

2. ユーザーを識別するユニークなIDがある場合は、identifyイベントの user_idとして送信してください

• 必ず user_id というフィールド名で、文字列形式で送信してください。
• 参考：identifyイベントのスキーマ
  • フィールド　
    • user_id：{ユーザー識別ID} [文字列]
    • ※user_id以外のフィールドは貴社のイベント仕様に応じて可変
  • 発火タイミング：アプリ起動（セッション）、会員登録、ログイン時

3. アプリ内WebView上のイベントを送る場合、別途KARTEタグの設置・WebView連携の実装が必要です

• 参考) WebView内の行動をトラッキングする：iOS, Android

KARTEでは、以下のイベント送信方法に対応しています。

4. 検証環境での確認・本番リリース

検証環境でのイベント取得・接客の配信確認を行なってください。

参考1: KARTE for AppのSDKインストール時に確認すべき内容

参考2: 検証環境での配信確認をする

本番リリース (＝本番環境でのKARTE計測開始) は、ご契約開始月以降のタイミングにてお願いします。

よくある質問・トラブルシューティング

• FAQ
• イベント計測までのトラブルシューティング
• KARTE for App接客が配信されない場合のチェックリスト
• WebView内の接客やWebView連携で問題が発生した時のチェックリスト
• KARTE for App不具合の調査に必要な情報