🚧

このドキュメントは古いバージョンのAndroid SDK v1について記載しています

Android SDK v1は 2021/05/11でサポート終了となります。
SDK v1 からのアップグレードについては、まず SDK v1からv2のアップグレード方法 をご覧ください。

1.8.0 (2020/07/16)

変更

• KARTE SDK v2互換インターフェースを追加しました。
  詳細については アップグレードガイド をご覧ください。

1.7.7 (2020/07/09)

変更

• ビジュアルトラッキングのAndroid Gradle Plugin対応バージョンに4.0.0を追加

修正

• ビジュアルトラッキングのプラグインを有効時、Java9以降のモジュール機能に対応したライブラリを参照するとビルドができない不具合を修正

1.7.6 (2020/06/23)

新機能

• 接客の表示制限オプションにより表示が抑制された時に表示抑制イベント（_message_suppressed）を飛ばすようにしました。
  これにより接客の表示制限オプションにより接客が抑制されたことを検知できるようになります。

1.7.5 (2020/05/12)

変更

• 接客表示に利用するhtmlの取得エンドポイントを変更（CDN化）しました。
  この変更により、キャッシュにヒットした場合に初回接客表示時のパフォーマンスが向上します。

1.7.4 (2020/04/27)

変更

• Tracker クラスの renewVisitorId メソッドを呼び出した際にWebViewのkarte.ioドメインのCookieを削除するように変更しました。

修正

• トラッキングのバッファリング処理内での、スレッドセーフでない箇所を修正しました。

1.7.3 (2020/02/13)

変更

• 一時的に非表示となる接客があるときに、UiAutomatorが期待通りに動かない場合があるため、接客の表示方法を調整しました。
• 一部のAPIにNonNull/Nullable等のAnnotationを追記しました。

1.7.2 (2020/01/24)

新機能

• 接客のプレビューをアプリで表示する機能を追加しました。

1.7.1 (2019/11/08)

変更

• バックグラウンドでSDKが初期化された場合に余分なリクエストが発生しないよう調整しました。
• app_info.version_code の型を数値型から文字列型に変更しました。
• チャットパネルが開いてる時に限り、バックボタンの挙動を変更しました。
  変更前：チャットバネル開く→バックボタン→前の画面に戻る
  変更後：チャットバネル開く→バックボタン→チャットパネルを閉じる

修正

• ビジュアルトラッキングのプラグインを有効にしていると、Windows環境にてビルドができない不具合を修正
• 難読化ツールにR8でなくProGuardを使用しているときに発生するWarningを抑制

1.7.0 (2019/09/24)

変更

• アプリがダークテーマを適用している際に、接客表示は通常のテーマに固定します。（APIレベル29以上のみ対象）
• ビジュアルトラッキングのAndroid Gradle Plugin対応バージョンに3.5.0を追加

修正

• targetSdkVersionが28以上の時に、特定のActivityで接客が表示されない不具合を修正。この問題はv1.6.9でのみ発生しています。

1.6.9（2019/09/04） Deprecated

❗️

注意事項

targetSdkVersionが28以上の時に、特定のActivityで接客が表示されない不具合が存在します。
v1.7.0以降のSDKを利用してください。

新機能

• 接客のWebViewをキャッシュするオプション(β機能)を追加
  これにより接客の表示速度が若干改善します。
  • 詳細はSDKの初期化 > 初期化オプション一覧をご覧ください。

変更

• イベントのバッファリングロジックの変更
  これにより接客の表示速度が若干改善します。
• native_find_myself イベントの送信条件を変更
  管理画面から専用のQRコードを読み取り起動した場合に限り native_find_myself イベントが送信されます。
  QRコードの表示方法については こちら をご覧下さい。
• withAppInfoのオプションを引き数に取るトラッキングメソッドが非推奨になりました。このオプションの値に関わらず、app_infoがイベントに付与されます。

1.6.8 (2019/07/26)

修正

• DecorView以外のViewにsystemUiVisibilityをセットした場合、接客のタップ時にsystemUiVisibilityが反映されなくなる問題を修正
  • 当ケースにおいて、Huawei端末に限りフルスクリーンのActivityでの接客表示領域が狭くなる問題も修正されています

1.6.7（2019/07/17）

新機能

• アプリ内メッセージの明示的な表示抑制が可能になりました。
  • 詳細はアクションを配信する > アクションの表示を明示的に抑制するをご覧ください。

• ログアウト機能を使用した時に、新旧ユーザに対して native_app_renew_visitor_id イベントを発火

修正

• フルスクリーンのActivity上での接客表示の際に、接客タップ時にフルスクリーンが解除される不具合を修正

1.6.6（2019/07/08）

新機能

• JavaScriptによるWebView連携が可能になりました。
  • 詳細は WebViewのトラッキングを行う > Webページ内に計測タグを設置してトラッキングを行う をご覧ください。

変更

• イベント送信時のパラメータに端末の言語設定を自動で付与するよう変更
  これにより、管理画面上で app_info.system_info.language という名称で端末の言語設定を参照できるようになります。（APIレベル21以上のみ対象）
• WebView連携用のクエリパラメータの仕様を変更
  クエリパラメータに有効期限が設けられました（パラメータ生成から1分でパラメータは無効となります）
• ビジュアルトラッキングのAndroid Gradle Plugin対応バージョンを3.2.0以上から3.1.0以上に変更

修正

• キーボード表示中に接客が配信された場合、接客がキーボードに被って表示される問題を修正

• アプリ内メッセージ表示中にPopupWindowや独自Windowへのタップができないことがある問題に対応

  • 詳細は アクションを配信する > アプリ内でWindowを表示する場合 をご覧ください。

• InAppMessagingManager.dismiss()が、呼び出し元のスレッドに依存する問題を修正

1.6.5（2019/06/25)

修正

• 画像付きプッシュ通知にGIF形式の画像を添付して送信した場合に、一部の端末で画像が表示されない問題を修正
• AdMob SDKの広告表示Activity起動時にクラッシュする問題を修正

1.6.4（2019/06/17)

修正

• ProGuardが有効かつgetDefaultProguardFile('proguard-android.txt')が未指定のアプリで、アプリ内メッセージが表示できない問題を修正
• アプリ内メッセージのコンテンツが大きい場合にスクロールがかくつく問題を修正

1.6.2（2019/06/10）

• getIntent()がnullを返すActivityの表示中にアプリがバックグラウンドに遷移するとNullPointerExceptionが発生する問題を修正
• 表示中のアプリ内メッセージをタッチ中にアプリがバックグラウンドに遷移するとIllegalStateExceptionが発生する問題を修正

1.6.1（2019/06/07）

修正

• 画像付きプッシュ通知の画像に余白が発生する問題を修正
• フルスクリーンかつステータスバーが半透明な画面へのアプリ内メッセージ表示時、表示領域がステータスバーの裏まで広がらない問題を修正。この問題はv1.6.0でのみ発生しています。

変更

• ログアウト機能のインターフェースを見直し
  見直しに伴い、Trackerクラスに renewVisitorId() メソッドを追加し、また logout() メソッドが deprecated となりました。

2019/8/22 追記

• Push通知クリック時の内部処理の変更

2019/8/22 追記

• Push通知クリック時の内部処理の変更

2019/8/22 追記

• Push通知クリック時の内部処理の変更

1.6.0（2019/05/30）

新機能

• ビジュアルトラッキング（Beta）に対応
  • 詳細に関しては、 ビジュアルトラッキングを利用する（Beta） をご覧ください。

🚧

ビジュアルトラッキング（Beta）の利用に関して

ご利用には管理画面の機能解放が必要です。
事前に営業担当にお問い合わせいただきますようお願い致します。

• Tracker.getInstance()を追加
• オプトアウト機能を追加
  本機能の詳細については、よく聞かれる質問 > オプトアウトについて をご覧ください。

変更

アプリ内メッセージ（WebView）の表示方法を変更しました。
変更前：表示中のActivityに対してaddContentView()により追加
変更後：WindowManager.addView()により追加

これにより、アプリ内メッセージをPopupWindow等のUIよりも上位に表示することが可能になりました。
ほとんどの場合アップデートのための特別な対応は不要です。
WebViewがcontentViewとして追加されることに依存した処理がある場合は、必要に応じて実装の見直し等の対応をしてください。

この変更に伴い、初期化オプションのsetAutoControlSoftInputAdjustは非推奨になりました。SDKはこのオプションの値を無視します。

修正

• アプリ内メッセージのリンクにスキーマの無いURLが指定されている場合にNullPointerExceptionが発生する問題を修正
• DryRunオプション利用時、WebView紐付け用のクエリパラメータの生成時にNullPointerExceptionが発生する問題を修正
• プッシュ通知の配信許可情報の送信タイミングを修正
• アプリ内メッセージ内でコンテンツを一定量スクロールさせると操作できなくなる問題を修正

1.5.6 (2019/04/23)

修正

• アプリUIの長押し時に表示中接客内のテキストが選択される場合がある問題を修正
• trackメソッド等の引数として指定するJSONObject及びJSONArrayにnull値が含まれる場合に、例外(JSONException)が発生する問題を修正

変更

• アプリアップデート後のバックグラウンドでSDKが初期化された場合、初期化時に自動で送信するイベントをその場では送信させず、最初の onActivityCreated のタイミングで送信するよう変更しました。
  変更によって影響があるイベントは以下になります。
  • native_app_install
  • native_app_update
• SoftInputModeの自動調整ON/OFFが接客毎に指定可能に変更。詳細についてはアクションを配信する > キーボード表示時の挙動を御覧ください。

1.5.5 (2019/03/25)

新機能

• プッシュ通知のラージアイコンに対応
  • 詳細については プッシュ通知を受信する > アイコン・アイコンカラーの設定 を御覧ください。
• アプリの設定画面へのリンクに対応
  • アプリ内メッセージ、プッシュ通知のリンクにapp-settings:を指定することでアプリの設定画面に遷移する機能を追加

修正

• チャットで画像のアップロードができない問題を修正

変更

• InAppMessagingManager.dismiss()で、同一画面内での接客表示制御に関する内部状態をリセットするように変更。
  • dismiss()実行後は「同一画面内での同時配信設定NGの複数接客の表示抑止」「同一画面内での同一接客の複数回表示の抑止」の制御についてリセットされ、別のページとして扱われるようになります。
• イベント名にマルチバイト文字が含まれている場合に警告ログを出力
  イベント名に指定可能な名前はイベントの制限をご覧ください。
• プッシュ通知クリックで外部アプリを起動した場合もmessage_clickを計測するように変更

1.5.4 (2019/03/12)

変更

• ログアウト機能のインターフェースを見直し
  見直しに伴い、Trackerクラスに logout() メソッドを追加し、また logout(CompletionHandler completionHandler) メソッドが deprecated となりました。
  ログアウト機能を利用していない場合は、特にアップグレードする必要はございません。

1.5.3 (2019/03/06)

新機能

• ログアウト機能を追加
  本機能の詳細については、よく聞かれる質問 > ログアウトについて をご覧ください。
• アプリ内メッセージのディープリンクURLを開く処理を委譲する機能を追加
  機能の詳細については アクションを配信する > リンク をご覧ください。
• KARTEから送られた通知メッセージに含まれるデータを抽出する機能を追加
  機能の詳細については プッシュ通知を受信する > 通知メッセージに含まれるディープリンクを開く をご覧ください。

修正

• 接客表示中にナビゲーションドロワーが開きづらい問題を修正
• アプリ内メッセージで動画が再生できない問題を修正
• トラッキングメソッドに渡したBundleの値にnullが含まれる場合にNullPointerExceptionが発生する問題を修正
• 「GooglePlay開発者サービス」が無効化された端末でアプリ起動時にクラッシュする問題を修正

変更

• KarteFirebaseInstanceIdServiceをdeprecatedに変更
  • 新しいFCMTokenの送信方法についてはアップグレードガイドをご覧ください。

🚧

トラッキングの注意事項

SDK v1.5.3未満でBundleによるトラッキングを行なう場合、送信値にnullが含まれているとNullPointerExceptionが発生します。Bundleでの送信を行う場合はv1.5.3以上のSDKを使用してください。

1.5.2 (2019/03/05) Deprecated

「GooglePlay開発者サービス」が無効化された端末でアプリ起動時にクラッシュする問題があります。v1.5.3以降のSDKを利用してください。

1.5.1 (2019/02/19)

修正

アプリ側のProGuardの設定を不要にした。（v1.5.0で設定が必要になった点の修正）

1.5.0 (2019/02/13) Deprecated

新機能

• アプリ内メッセージに関するAPIを追加
  • 接客表示を管理するクラスInAppMessagingManagerを追加
  • InAppMessagingManagerを取得するメソッドTracker.getInAppMessagingManager()を追加
  • 表示中の接客をリセットするメソッドInAppMessagingManager.dismiss()を追加
  • 接客が表示中かどうかを取得するメソッドInAppMessagingManager.isPresenting()を追加

変更

• プッシュ通知の本文が長い場合に省略された部分を表示できるように変更

🚧

注意事項

このバージョンを利用する場合、アプリ側のProGuardに以下のルールを追記する必要があります。これはv1.5.1で修正されています。

-dontwarn io.karte.android.tracker.inappmessaging.**

1.4.8 (2019/01/25)

新機能

• アプリがフォアグランド・バックグラウンドに遷移した時に native_app_foreground と native_app_background イベントを発火
• 画面を跨いだ接客の表示を制限するオプションに対応
  画面遷移前に発生したイベントに対応する接客が、画面遷移後にレスポンスされた場合に、接客を表示するかどうかを接客サービスのオプションでコントロールできるようになりました。
  設定は、接客サービス詳細 > オプション の「ネイティブアプリにおける接客表示制限」より行えます。

修正

• 未実施接客が配信された際に _message_ready や message_open イベントが発火されない問題を修正
• ポップアップで、開けないディープリンクをクリックした際にクラッシュする問題を修正

変更

• app_info.system_info.android_id を送信しないように変更
• 広告ID(AAID) をデフォルトで送信しないように変更
• native_find_myself が意図せず発火しないよう発生条件を調整

1.4.7（2018/12/19）

修正

• スクリプトでalert()利用時に接客が操作できない問題を修正

1.4.6（2018/12/11）

新機能

• Mass Push経由で送信されたプッシュ通知の効果測定に対応

修正

• Viewイベント送信時に行うアクションのリセット処理が、呼び出し元のスレッドに依存する問題を修正

1.4.5（2018/12/04）

新機能

• getAppKey()メソッドをTrackerに追加

修正

• 通知クリック時の遷移先ActivityがonCreateで破棄される場合にmessage_clickが計測できない問題を修正

1.4.4（2018/11/14）

• 調査用のログを追加

1.4.3（2018/11/06）

変更

• android:allowBackup="true" の設定を削除
• アプリ内メッセージを非表示にする処理の改善

1.4.0（2018/10/15）

新機能

• イベントのフィールドをBundleで受け取るトラッキングメソッドを追加

変更

• アプリ内メッセージ表示用のウィンドウを常駐しないように変更

1.3.4（2018/10/04）

修正

• 稀に android.content.pm.PackageManager$NameNotFoundException によりクラッシュが発生する問題を修正

1.3.3（2018/10/01）

修正

• YouTubePlayer SDKを利用している場合、動画の再生が止まる問題を修正

1.3.2 (2018/09/25)

変更

• イベントトラッキングのバッファリングを調整

1.3.1 (2018/09/19)

新機能

• プッシュ通知クリック時にリンクが開けない場合のデフォルトインテントを指定するメソッド MessageHandler.handleMessage(Context context, RemoteMessage message, Intent defaultIntent) を追加

修正

• テキスト入力時にキーボードが接客に被る問題の修正
  • 接客表示中はSoftInputModeにSOFT_INPUT_ADJUST_RESIZEを設定するよう変更
  • この挙動を無効化するための autoControlSoftInputAdjust オプションを追加

1.3.0 (2018/09/12)

新機能

• 設定値配信に対応
  詳細に関しては、設定値を利用する（Beta） をご覧ください。
• Trackerクラスにタイトルを指定可能なviewメソッドを追加
  • view(String viewName, String title)
  • view(String viewName, String title, JSONObject values)
• 初期化オプションとして、DryRunオプションを追加

修正

• AAIDの送信処理を改善
• WebView紐付け用のクエリパラメータの生成処理を変更

1.2.8 (2018/08/17)

修正

• proguardを利用している際の、SDK内部のリフレクション処理に失敗する不具合を修正。

1.2.7 (2018/08/16)

変更

• 広告ID(AAID)の値をイベントのデフォルトのフィールド app_info. system_info.aaid に追加
  ※ 広告IDの取得を希望しない場合は、 SDKの初期化 を参考に設定してください

1.2.6 (2018/08/06)

修正

• 画面遷移時に画面端がちらつく場合がある問題を修正

新機能

• KARTEからのプッシュ通知を判定するメソッドMessageHandler.canHandleMessage(RemoteMessage message) を追加

1.2.5 (2018/07/26)

修正

• Android N (7.0)で、アプリ内メッセージのボタン（リンク先が未設定）をタップした際に稀にクラッシュする問題を修正

変更

• アプリ内メッセージのボタンをクリックした際に、メッセージを閉じるように挙動を変更

1.2.4 (2018/07/17)

新機能

• KARTEからのプッシュ通知フラグ MessageHandler.KARTE_PUSH_NOTIFICATION_FLAG を追加

修正

• プッシュ通知クリック時にmessage_clickが飛ばない問題を修正

1.2.3 (2018/06/25)

新機能

• Tracker.getVisitorId() を追加

修正

• native_app_crashed イベントの再送処理を追加
• バージョン26未満のsupport-v4に依存してる場合に通知受信に失敗する不具合を修正

1.2.2 (2018/06/12)

修正

• プッシュ受信時等のプロセス起動時にnative_app_openが発行される問題を修正
• チャット接客上のリンクをクリックした時に表示がずれる問題を修正

アップグレードガイド：https://developers.karte.io/v1.0/docs/upgrade-guide-android-sdk#section-1-2-2-

1.2.1 (2018/06/01)

修正

• 特定のURLがリンクから開けない問題を修正

1.2.0 (2018/05/25)

新機能

• WebView内計測タグとのユーザ行動を紐付ける機能を追加
• SDKから発行される全イベントにapp_info付きreqイベントを付加して発行
• Date 型の送信をサポート
• getInstace(Context context) メソッドの追加

1.1.0 (2018/05/08)

新機能

プッシュ通知機能のアップデート

1. 通知開封イベントの自動送信
2. 画像付きプッシュ通知のハンドリング
3. 通知開封時、指定されたディープリンク / URL への自動遷移
4. デフォルトアイコン・カラーの設定
5. 指定されたチャンネルIDへのハンドリング

変更

• KarteMessageHandler.copyInfoToIntent(data, intent) は非推奨になり、代わりに
  MessageHandler.copyInfoToIntent(data, intent) を使用してください。

1.0.2(2018/04/01)

修正

• メモリのリーク修正・利用量改善

1.0.1(2018/03/26)

修正

不具合内容

KARTE SDKの組み込み前にFirebase Cloud Messaging SDKを使ったアプリをリリースしておりユーザがそのバージョンを利用したことがある場合に、KARTE内部で利用しているプッシュ通知許可フラグをセットするイベントが送信されないことにより通知が送信できない。

修正内容

アプリ起動時にプッシュ通知許可情報を取得しフラグにセットしてイベントを送信するように修正。

1.0.0(2018/03/19)

初回リリース