アップグレードガイド

Suggest Edits

🚧

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

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

1.8.0 へのアップグレード

現行の v1 インターフェースの利用は非推奨となりました。
適宜 KARTE SDK v2 互換インターフェースへの移行をお願いします。

インターフェースの対応関係については、SDK v1からv2のアップグレード方法 をご覧ください。

1.7.7 へのアップグレード

1.7.7 へのアップグレードには特別な操作は必要ありません。

1.7.6 へのアップグレード

1.7.6 へのアップグレードには特別な操作は必要ありません。

1.7.5 へのアップグレード

1.7.5 へのアップグレードには特別な操作は必要ありません。

1.7.4 へのアップグレード

1.7.4 へのアップグレードには特別な操作は必要ありません。

1.7.3 へのアップグレード

1.7.3 へのアップグレードには特別な操作は必要ありません。

1.7.2 へのアップグレード

1.7.2 へのアップグレードには特別な操作は必要ありません。

1.7.1 へのアップグレード

v1.7.0で必要になったProGuardの設定が不要になりました。ProGuardのルールを追加していた場合は除外してください。

1.7.0 へのアップグレード

当バージョンのSDKで、コード短縮ツールにR8ではなくProGuardを使用する場合のみ、以下のルールをProGuardに追加してください。

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

1.6.9 へのアップグレード

  • URLスキームをハンドルするための設定を行う必要があります。
    詳細は こちら をご覧下さい。

1.6.8 へのアップグレード

1.6.8 へのアップグレードには特別な操作は必要ありません。

1.6.7 へのアップグレード

1.6.7 へのアップグレードには特別な操作は必要ありません。

1.6.6 へのアップグレード

  • WebView連携用のクエリパラメータに有効期限が設けられました。
    • そのため連携用クエリパラメータ付きのURLを使い回している場合は、1.6.6へのアップグレード以降正常に連携が行われなくなる恐れがあります。
    • loadUrl() を呼び出す直前で都度連携用パラメータを付与するように変更してください。
  • 接客表示中に、アプリ側で表示されているPopupWindowやWindowに対して正常にタップを処理させるための機構が追加されています。必要に応じて実装を追加してください。

1.6.5 へのアップグレード

1.6.5 へのアップグレードには特別な操作は必要ありません。

1.6.4 へのアップグレード

1.6.4 へのアップグレードには特別な操作は必要ありません。

1.6.2 へのアップグレード

1.6.2 へのアップグレードには特別な操作は必要ありません。

1.6.1 へのアップグレード

1.6.1 へのアップグレードには特別な操作は必要ありません。

1.6.0 へのアップグレード

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

ほとんどの場合アップデートのための特別な対応は不要です。
WebViewがcontentViewとして追加されることに依存した処理がある場合は、必要に応じて実装の見直し等の対応をしてください。

1.5.6 へのアップグレード

1.5.6 へのアップグレードには特別な操作は必要ありません。

1.5.5 へのアップグレード

1.5.5 へのアップグレードには特別な操作は必要ありません。

1.5.4 へのアップグレード

1.5.4 へのアップグレードには特別な操作は必要ありません。

1.5.3 へのアップグレード

1.5.3 へのアップグレードには特別な操作は必要ありません。

1.5.2 へのアップグレード

  • KarteFirebaseInstanceIdServiceがdeprecatedになりました。
  • トークン更新のタイミングでTracker.trackFcmToken(String token)に新しいfcm_tokenを送信するよう変更してください。
    • トークンを送信するべきタイミングはFirebaseMessagingService.onNewToken()かFirebaseInstanceIdService.onTokenRefresh()です。

1.5.1 へのアップグレード

v1.5.0で必要になったProGuardの設定が不要になりました。ProGuardのルールを追加していた場合は除外してください。

1.5.0 へのアップグレード

当バージョンのSDKを利用する場合のみ、以下のルールをProGuardに追加してください。

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

1.4.8 へのアップグレード

広告ID(AAID) をデフォルトで送信しないように変更しました。
AAIDが必要な場合は、初期化オプションを変更する必要があります。

1.4.7 へのアップグレード

1.4.7 へのアップグレードには特別な操作は必要ありません。

1.4.6 へのアップグレード

1.4.6 へのアップグレードには特別な操作は必要ありません。

1.4.5 へのアップグレード

1.4.5 へのアップグレードには特別な操作は必要ありません。

1.4.4 へのアップグレード

1.4.4 へのアップグレードには特別な操作は必要ありません。

1.4.3 へのアップグレード

1.4.3 へのアップグレードには特別な操作は必要ありません。

1.4.0 へのアップグレード

イベントのフィールドを Bundle で渡せるトラッキングメソッドが追加されています。引数に null を渡している処理がある場合は、空の JSONObject か空の Bundle を渡すように変更してください。

1.3.4 へのアップグレード

1.3.4 へのアップグレードには特別な操作は必要ありません。

1.3.3 へのアップグレード

1.3.3 へのアップグレードには特別な操作は必要ありません。

1.3.2 へのアップグレード

1.3.2 へのアップグレードには特別な操作は必要ありません。

1.3.1 へのアップグレード

1.3.1 へのアップグレードには特別な操作は必要ありません。

1.3.0 へのアップグレード

1.3.0 へのアップグレードには特別な操作は必要ありません。

1.2.8 へのアップグレード

1.2.8 へのアップグレードには特別な操作は必要ありません。

1.2.7 へのアップグレード

  • 広告IDの取得には、 Google Play Servece SDK または Firebase SDK が導入されている必要があります。必要に応じて導入をお願いいたします。

1.2.6 へのアップグレード

1.2.6 へのアップグレードには特別な操作は必要ありません。

1.2.5 へのアップグレード

1.2.5 へのアップグレードには特別な操作は必要ありません。

1.2.4 へのアップグレード

1.2.4 へのアップグレードには特別な操作は必要ありません。

1.2.3 へのアップグレード

1.2.3 へのアップグレードには特別な操作は必要ありません。

1.2.2 へのアップグレード

起動時に必ず表示される Activity の onCreate() で Tracker.init() を実行する方法は非推奨となりました。 Application.onCreate() 内で Tracker.init() を実行して下さい（Activity.onCreate() での初期化をしていない場合は変更は不要です）。

1.2.1 へのアップグレード

1.2.1 へのアップグレードには特別な操作は必要ありません。

1.2.0 へのアップグレード

1.2.0 へのアップグレードには特別な操作は必要ありません。

1.1.0 へのアップグレード

プッシュ通知関連の実装負荷の軽減

  • 以下の４つの処理が自動で行われるようになりました
    • 通知の開封イベントの送信
    • 通知メッセージに含まれる URL や ディープリンクの処理
    • 画像付きプッシュ通知のハンドリング
    • 指定されたチャンネルIDの処理

KarteMessageHandler.copyInfoToIntent(data, intent) を呼び出すコードは取り除いてください。
代わりに MessageHandler.handleMessage(this, remoteMessage) を呼び出してください。
手動で通知開封処理を実装したい場合は MessageHandler.copyInfoToIntent(data, intent) を呼び出してください。

public class MyFirebaseMessagingService extends FirebaseMessagingService {

  @Override
  public void onMessageReceived(RemoteMessage remoteMessage) {
　　　　// +++ 追加 +++
    boolean handled = MessageHandler.handleMessage(this, remoteMessage);
    if (!handled) {
      Intent intent = new Intent(this, BasicActivity.class);
      intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
      // 変更 KarteMessageHandler -> MessageHandler
      MessageHandler.copyInfoToIntent(data, intent);
      PendingIntent pendingIntent = PendingIntent.getActivity(this, 0, intent,
            PendingIntent.FLAG_ONE_SHOT);
    }
  }
}

1.0.2 へのアップグレード

1.0.1 へのアップグレードには特別な操作は必要ありません。

1.0.1 へのアップグレード

1.0.1 へのアップグレードには特別な操作は必要ありません。

1.0.0 へのアップグレード

インストールとセットアップ手順の更新

SDKの導入にMaven repositoryの利用が可能にしました。
詳細な手順については SDKのセットアップ をご覧ください。

Updated 5 months ago