リリースノート

Suggest Edits

🚧

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

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

Tracker SDK

1.8.3 (2020/09/11)

修正

  • 一部の接客において背後のコンテンツのスクロールなどの操作ができない範囲があった問題を修正しました。

1.8.2 (2020/08/20)

修正

  • 設定値配信において不正な設定値がレスポンスされた場合にクラッシュする問題を修正しました。

1.8.1 (2020/07/17)

修正

  • イベント名にnilが渡された際にクラッシュする問題を修正しました。

1.8.0 (2020/07/15)

修正

  • イベント送信中にアプリがバックグラウンドに入った場合に送信が完了するまでバックグラウンドで処理を継続するようにしました。

変更

1.7.7 (2020/06/04)

修正

  • renewVisitorId を呼び出した場合に稀にクラッシュする問題を修正しました。

1.7.6 (2020/05/12)

変更

  • KarteTracker クラスのrenewVisitorId メソッドを呼び出した際にWKWebViewのCookieを削除するように変更しました。
  • 接客表示に利用するhtmlの取得エンドポイントを変更（CDN化）しました。
    この変更により、キャッシュにヒットした場合に初回接客表示時のパフォーマンスが向上します。
  • リクエストの内部処理を一部変更しました。（Content-Typeの変更）

1.7.5 (2020/03/13)

修正

  • イベント送信中にオプトアウト処理が行われるとクラッシュする可能性があった実装を修正しました。

1.7.4 (2020/03/13)

修正

  • 特定の条件下で並列にリクエストが行われる問題を修正しました。
  • Firebase SDK 6.x 系を利用かつ、UserNotification.framework を利用しない場合に通知のクリックイベントが飛ばない問題を修正しました。
  • KARTE SDKと特定のサードパーティSDKを同時にインストールした場合に、リンク時にシンボル重複エラーが発生する問題を修正しました。

1.7.3 (2020/01/24)

新機能

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

1.7.2 (2019/10/23)

新機能

修正

  • 下記の状態にある時にSDKがワーカースレッドで初期化された際、Main Thread Checker 関連のログがコンソールに出力される問題を修正
    • オプトアウトされた状態
    • DryRunオプションが有効
    • 不正な Application Key で初期化

変更

  • アプリ内メッセージの表示に関する内部処理を改善
  • Xcode 11.1.0 でビルドするように変更しました。

1.7.1 (2019/09/30)

修正

  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際、不正な Application Key を指定した場合にクラッシュする問題を修正
    • stringByAppendingUserSyncQueryParameter:withURLString:
    • URLByAppendingUserSyncQueryParameter:withURL:
    • userSyncQueryParameter:
    • setUserSyncScriptWithWebView:appKey:
  • ログアウト処理直後に前のユーザのチャット画面が表示される問題を修正。

変更

  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際に、不正な Application Key を指定した場合に元のURLが返るよう変更
    • stringByAppendingUserSyncQueryParameter:withURLString:
    • URLByAppendingUserSyncQueryParameter:withURL:
    • setUserSyncScriptWithWebView:appKey:
  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際に、不正な Application Key を指定した場合に元のnilが返るよう変更
    • userSyncQueryParameter:

1.7.0 (2019/09/13)

修正

  • 独自に UISceneDelegate を実装した場合に、アプリ内メッセージが表示されない問題を修正

📘

iOS13に対応しました

Xcode 10 でビルドをする場合は、本バージョンにアップグレードする必要はありません。
Xcode 11 でビルドかつ独自に UISceneDelegate を実装する場合は、本バージョンへのアップグレードが必須です。

なお本バージョンから Xcode 11 GM Seed でビルドするように変更しました。

🚧

制限事項

  • Swift UI で構築されたアプリケーション上でのビジュアルトラッキングはサポートしておりません。
  • iPad OS のマルチウィンドウ機能はサポートしておりません（マルチウィンドウ下でも動作はしますがアプリ内メッセージは常に一方のウィンドウで表示されます）

1.6.6 (2019/09/30)

修正

  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際、不正な Application Key を指定した場合にクラッシュする問題を修正
    • stringByAppendingUserSyncQueryParameter:withURLString:
    • URLByAppendingUserSyncQueryParameter:withURL:
    • userSyncQueryParameter:
    • setUserSyncScriptWithWebView:appKey:
  • ログアウト処理直後に前のユーザのチャット画面が表示される問題を修正。

変更

  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際に、不正な Application Key を指定した場合に元のURLが返るよう変更
    • stringByAppendingUserSyncQueryParameter:withURLString:
    • URLByAppendingUserSyncQueryParameter:withURL:
    • setUserSyncScriptWithWebView:appKey:
  • KarteTrackerJsUtil クラスの下記のメソッドを呼び出す際に、不正な Application Key を指定した場合に元のnilが返るよう変更
    • userSyncQueryParameter:

1.6.5 (2019/09/02)

修正

変更

  • native_find_myself イベントの送信条件を変更
    管理画面から専用のQRコードを読み取り起動した場合に限り native_find_myself イベントが送信されます。
    QRコードの表示方法については こちら をご覧下さい。
  • 各イベントのvalueに付与されていた app_info を削除し、リクエストのbodyに含まれる app_info を参照するよう変更しました。

1.6.4 (2019/07/24)

修正

  • iframe を含む接客を表示しようとした際、外部ブラウザが起動してしまう問題を修正
    本問題は v1.5.9 以上を利用している場合に限り問題が発生します。

変更

  • v1.4.3 から非推奨となっているイベント送信時刻 _event_local_date フィールドを削除しました

1.6.3 (2019/07/19)

新機能

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

変更

  • クラッシュ検知の精度が向上しました。
    NSUncaughtExceptionHandler では検知できないクラッシュについても計測されるようになりました。
  • Xcode 10.2.1 でビルドするように変更しました。

1.6.2 (2019/07/10)

新機能

変更

  • イベント送信時のパラメータに端末の言語設定を自動で付与するよう変更
    これにより、管理画面上で language という名称で端末の言語設定を参照できるようになります。
  • WebView連携用のクエリパラメータの仕様を変更
    クエリパラメータに有効期限が設けられました（パラメータ生成から1分でパラメータは無効となります）

1.6.1 (2019/06/24)

修正

  • KarteTrackerJsUtil クラスの URLByAppendingUserSyncQueryParameter メソッドの戻り値として返されるURLから scheme および host などの情報が欠落する問題を修正
    [NSURL URLWithString:relativeTo:] により生成されたURLを、上記メソッドに渡した場合に限り本問題が発生します。

変更

  • イベントのバッファリングロジックの変更
    これにより接客の表示速度が若干改善します。

1.6.0 (2019/06/07)

新機能

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

  • KarteTrackerConfigBuilderクラスにビジュアルトラッキングを有効化するオプションを追加
    • enabledVisualTracking
  • KarteTrackerConfigクラスにビジュアルトラッキングが有効かどうかを取得するプロパティを追加
    • enabledVisualTracking
  • ペアリング時のURLスキームハンドル用のKarteUrlSchemeHandlerクラスを追加

🚧

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

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

1.5.9 (2019/06/04)

修正

  • バックグラウンドから復帰後のview()の挙動を修正
    • アプリがバックグラウンドから復帰した後、最初のview()の呼び出し時に接客の表示状態がリセットされない問題を修正しました。
  • 接客でwindow.location.hrefによるページ遷移が行われた時にURLスキームが起動しない問題を修正しました。

変更

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

2019/8/22 追記

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

1.5.8 (2019/05/22)

新機能

修正

  • viewイベントがワーカースレッド上で発生した場合にクラッシュする可能性があった為、一部のコードをメインスレッドで実行するよう修正しました。

変更

  • KarteInAppMessagingWindowを表示する際にキーウィンドウとして表示しないように変更
    これによりアプリ側でキーボードを表示している際に接客が配信された場合でもキーボードが閉じないようになりました。
  • バックグラウンドでSDKが初期化された場合に余分なリクエストが発生しないよう調整しました。

1.5.7 (2019/05/07)

修正

  • KarteInAppMessagingWindowが破棄されずにView階層上に残ってしまった時に操作不能になる問題を修正
    アプリ側でKarteInAppMessagingWindowを保持する実装を行なっている場合にのみ影響する問題です。
  • handleRemoteNotification が連続で呼び出された時にUIが数秒固まることがある問題を修正。

1.5.6 (2019/04/18)

変更

  • バックグラウンドでSDKが初期化された場合、初期化時に自動で送信するイベントをその場では送信させず、 UIApplicationDidBecomeActiveNotification の通知を受信したタイミングで送信するよう変更しました。
    変更によって影響があるイベントは以下になります。
    • native_app_install
    • native_app_update
    • native_app_open
    • plugin_native_app_identify

1.5.5 (2019/03/27)

修正

  • 接客を表示した状態でバックグラウンドから復帰したときに稀に操作が出来なくなる問題を修正
    他のアプリでメモリを大量に消費することにより、SDKが管理するWebViewのコンテンツプロセスが強制終了される場合があり、これによりWebViewで表示しているコンテンツがクリアされ、画面の操作が一切行えない状態となる場合がありました。
    WebViewのコンテンツプロセスが強制終了された場合においても、操作が継続できるように修正しました。

変更

  • IDFAの取得方法を変更
    初期化オプションの isEnabledTrackingIdfa が非推奨となり、新たに IDFADelegate が追加されました。
    これによりSDKが AdSupport.framework に直接依存しない形に変更されています。
    今後IDFAの送信を行う場合は、アプリに KarteIDFADelegate を実装する必要があります。
    詳細に関しては、SDKの初期化 - 初期化オプション をご覧ください。

1.5.4 (2019/03/25)

修正

  • チャット画面で画像をアップロードする際、接客が閉じてしまい画像のアップロードできない問題を修正

変更

  • イベント名にマルチバイト文字が含まれている場合に警告ログを出力
    イベント名に指定可能な名前はイベントの制限をご覧ください。
  • v1.3.0 で deprecated となった一部のメソッドを削除

1.5.3 (2019/03/12)

変更

  • ログアウト機能のインターフェースを見直し
    見直しに伴い、KarteTrackerクラスに logout メソッドを追加し、また logoutWithCompletionBlock: メソッドが deprecated となりました。
    既にv1.5.2を利用中かつログアウト機能を利用していない場合は、特にアップグレードする必要はございません。

1.5.2 (2019/03/05)

新機能

修正

  • _UIRemoteViewを含むViewとアプリ内メッセージが同時に表示された時に操作ができなくなる問題を修正
    本問題は v1.5.0 および v1.5.1 を利用している場合に限り問題が発生します。

1.5.1 (2019/02/28)

新機能

修正

  • アプリ内メッセージ表示中にスクロール操作やピンチイン・アウト操作がし辛くなる問題を修正
  • 端末再起動後かつ端末がロックされている状態で、SDKの初期化を行うとクラッシュする問題を修正

変更

  • アプリ内メッセージや通知メッセージに設定したディープリンクURLに RFC2396 に準拠していない文字が含まれている場合であっても、開けるように仕様を変更
    これまでは未エンコードのマルチバイト文字が含まれている場合は処理しない仕様でしたが、今後はエンコードをして処理をするようになります。
    既にエンコードされている文字が含まれている場合、その箇所は無視します。
  • アプリ内メッセージ中のボタン等を長押しした際に、メニュー (ActionSheet) を表示しないように変更
  • アプリ内メッセージ中のボタン等を長押しした際に、メニュー (ActionSheet) を表示しないように変更
  • 内部処理の改善

1.5.0 (2019/02/13)

新機能

  • 表示中のアプリ内メッセージの有無を確認する機能及び、閉じる機能を追加
    機能の詳細については KarteInAppMessagingManager をご覧ください。

修正

  • ソフトウェアキーボードを表示中に、スクリプト配信の接客が行われるとキーボードが閉じてしまう問題を修正
  • アプリ内メッセージを表示している状態でステータスバーをタップした時に、UIScrollView等の scrollToTop が機能しない問題を修正

変更

  • SDKの初期化を行わない状態で、トラッカーインスタンスを取得する際の挙動を変更
    これまでは初期化を行わない状態で、sharedTracker や sharedTrackerWithAppKey: を呼び出すと例外を発生する仕様でしたが、本バージョンからは例外が発生しないように変更しました。
    なお呼び出し元に返すオブジェクトは、空のトラッカーインスタンスとなります。
    空のトラッカーインスタンスに対して track メッセージ等を送ることは可能ですが、実際には何も起きずイベントが送信されることもありません。
  • ウィジェット内のボタンやリンクに対して 3D Touch した際に、プレビュー画面を表示しない仕様に変更
  • アプリ内メッセージにおけるタップ箇所の透過判定処理のパフォーマンスを改善
  • 内部処理の改善

1.4.7 (2019/01/25)

新機能

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

修正

  • 未実施接客が配信された際に _message_ready や message_open イベントが発火されない問題を修正

変更

  • ウィジェット内のボタンをタップした際の挙動を変更
    これまでは canOpenURL の結果が true となる場合に限りウィジェットを閉じる仕様でしたが、このバージョンからは canOpenURL の結果は問わず常にウィジェットを閉じる仕様になりました。
  • 広告ID(IDFA)をデフォルトで送信しないように変更

1.4.6 (2019/01/08)

修正

  • マルチバイト文字を含むURLスキームが開けない問題を修正

1.4.5 (2018/12/11)

新機能

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

修正

  • チャットメッセージのリンクをクリックすると、チャットが閉じてしまう問題を修正
  • アプリ内メッセージタップ時の透過判定処理を改善

1.4.4 (2018/11/19)

新機能

  • アプリ内メッセージの表示開始及び終了の通知に対応

1.4.3 (2018/11/06)

変更

  • アプリ内メッセージを非表示にする処理の改善
  • bitcodeに対応
  • イベント送信時刻 _local_event_date をイベントのフィールドに追加

1.4.1 (2018/10/23)

修正

  • 横画面でのアプリ内メッセージが崩れる場合がある問題を修正
  • アプリ内メッセージに関するエラー制御を修正

1.4.0 (2018/10/12)

修正

  • アプリケーションの実装によりステータスバーが意図せず回転する問題を修正
  • ステータスバーに意図したスタイルが反映されない問題を修正

変更

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

1.3.3 (2018/10/01)

修正

  • アプリケーションの実装によりステータスバーが意図せず回転する問題を修正
  • ステータスバーに意図したスタイルが反映されない問題を修正

1.3.2 (2018/09/25)

変更

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

修正

  • 設定値配信のAPIを修正

1.3.1 (2018/09/18)

修正

  • アプリ起動直後にアプリ内メッセージ表示用のWindowを表示しないように変更
  • iPhoneXでChatアクションの表示が崩れる問題を修正

1.3.0 (2018/09/12)

新機能

  • 設定値配信（Beta）に対応
    詳細に関しては、 設定値を利用する（Beta） をご覧ください。
  • KarteTrackerクラスにKarteTrackerConfigクラスを引数にとるメソッドを追加
    • setupWithAppKey:withConfig:
    • initWithAppKey:withConfig:
  • KarteTrackerクラスにタイトルを指定可能なviewメソッドを追加
    • view:title:
    • view:title:values:
  • 初期化オプション管理用の KarteTrackerConfig クラスを追加
  • 初期化オプション構築用の KarteTrackerConfigBuilder クラスを追加
  • ログ出力制御用の KarteLogger クラスを追加
  • 初期化オプションとして、DryRunオプションを追加

変更

  • 一部のメソッド・プロパティをSwiftライクな名称に変更
  • 一部のメソッド・関数を非推奨に変更

修正

  • デバイスを回転した際の不具合を修正
  • WebView紐付け用のクエリパラメータの生成処理を変更
  • 特定の条件下においてアプリ内メッセージが再表示できなくなる問題を修正

1.2.4 (2018/09/18)

変更

  • アプリ起動直後にアプリ内メッセージ表示用のWindowを表示しないように変更

1.2.3 (2018/08/16)

変更

  • 広告ID(IDFA)の値をイベントのデフォルトのフィールド app_info.system_info.idfa に追加

📘

広告IDを取得しない場合

SDKの初期化オプションを設定することで広告IDを取得しないようにすることができます。
詳細は、SDKの初期化 の「初期化オプション一覧」をご覧ください。

修正

  • カスタムキーボードを表示するとポップアップが消え、以降ポップアップが表示されなくなる不具合を修正

1.2.2 (2018/08/07)

新機能

  • KARTEからのプッシュ通知を判定するメソッド canHandleRemoteNotification: を KarteRemoteNotificationHandler クラスに追加

変更

  • 内部処理の改善

1.2.1 (2018/07/25)

新機能

  • KarteTrackerクラスに visitorId を取得するためのプロパティを追加

修正

  • native_app_crashed イベントの再送処理を追加
  • enableTrackingCrashError オプションが動作しない不具合を修正
  • 動画テンプレート利用時に動画再生ができない不具合を修正
  • デバイス回転時にアクションの表示が崩れる不具合を修正

変更

  • SDKを Embedded Framework として公開するよう変更

1.2.0 (2018/05/25)

新機能

  • WebView内計測タグとのユーザ行動を紐付ける機能を追加
  • NSDate 型の送信をサポート

修正

  • クラッシュ時イベント名をnative_app_crashedに修正
  • 画面回転時にポップアップ表示をリセットするよう修正
  • iPhone Xでキーボード表示時にポップアップが非表示になる不具合を修正

変更

  • FCMの登録トークン自動送信機能のデフォルトをOFFに変更
  • app_infoにbundle idを追加

1.1.0 (2018/05/08)

新機能

  • プッシュ通知を開封した際、自動で開封イベントを送信する機能を追加
  • URL及びディープリンクをSDK側で処理する機能を追加

修正

  • 通知許可設定の変更が、KARTE側に反映されないことによりプッシュ通知が送信されない問題を修正

1.0.1 (2018/03/26)

修正

  • 特定の条件下においてプッシュ通知が送信されない問題を修正

📘

KARTE SDK組み込み以前より、Firebase Cloud Messaging SDKを組み込んだアプリを利用しているユーザが、KARTE SDKに対応したアプリを利用するケース。

変更

  • バージョン情報(CFBundleVersion)の値をイベントのデフォルトのフィールド app_info.version_code に追加

1.0.0 (2018/03/19)

初回リリース

　

App extensions SDK

1.0.3 (2019/07/19)

変更

  • Xcode 10.2.1 でビルドするように変更しました。

1.0.2 (2018/11/06)

変更

  • bitcodeに対応

1.0.1 (2018/08/07)

新機能

  • KARTEからのプッシュ通知を判定するメソッド canHandleRemoteNotification: を KarteNotificationServiceExtension クラスに追加

1.0.0 (2018/05/08)

初回リリース

Updated 5 months ago