9 FANSHIP SDKのアップデートについて

Note

FANSHIP SDKは名称が変わっておりますが SDKの内容としては以前の popinfo SDKと同様のものとなっております。
旧バージョンの popinfo SDKを使用している場合でも従来どおりのアップデートは可能です。

Warning

独自に機能をカスタマイズしている場合につきましても、SDK内のファイルをアプリプロジェクトへコピーし編集している場合に限り、以前の状態を維持したアップデートが可能となっております。
FANSHIP SDK内ファイルを直接編集している場合は、カスタマイズしたレイアウト、画面クラス、各種設定を維持できませんのでご注意ください。

9.1 旧バージョンからのアップデートにおける主な共通確認事項

• ver 7.2.0 以降、SDK 初回起動時のオプトインダイアログを任意で表示することが可能になりました。
  任意で表示をする場合、SDK 開始時のメソッド Popinfo.start(context, boolean) の引数に true を設定してください。
  Popinfo.start(context) でコールした場合や、 Popinfo.start(context, boolean) の引数に false を設定した場合、ver 7.2.0 以前と同じ動作となりオプトインダイアログが自動で表示されます。

  
  
  オプトインダイアログを任意で表示する場合の変更点
  1. meta-data の設定の動作が一部変更されます。

  POPINFO_SKIP_INIT_AGREEMENT : false とした場合でも初回起動時にインフォメーションダイアログが表示されません。
  POPINFO_SKIP_PUSH_AGREEMENT : true とした場合でも初回起動時に PUSH 通知は許諾済みにはなりません。
  POPINFO_SHOW_SEGMENT_SETTINGS : true とした場合でも、初回起動時にユーザー属性設定ダイアログは表示されません。
  

  
  
  2. 「インフォメーションダイアログ」「PUSH 許諾ダイアログ」「位置情報許諾ダイアログ」を任意で呼び出すことが可能となります。

  Popinfo.startInformationOptin(Activity activity)
  Popinfo.startPushOptin(activity)
  Popinfo.startLocationOptin(Activity activity)
  

  ※このメソッドでダイアログを表示できるのは一度のみとなります。ユーザーが許諾を選択した後に再度このメソッドを呼び出してもダイアログは表示されません
  ※位置情報許諾ダイアログは位置情報の権限の状態によってはダイアログが表示されないことがあります（システムの挙動となります。既に権限を許諾済みだった場合や、既に「次回から表示しない」設定となっていた場合は表示されません）
  ※以前のバージョンでの初回起動を含む、自動でのオプトインダイアログ表示を終えたユーザーに対してはこのメソッドを呼び出してもダイアログは表示されません

  
  
  3. 2 のダイアログ終了時のコールバックが追加されました。

  PopinfoCallback.onInformationOptInEnded(context)
  PopinfoCallback.onPushOptInEnded(context)
  PopinfoCallback.onLocationOptInEnded(context)
  

  ※コールバッククラスの使用方法に関しては PopinfoCallbackクラスの使用方法 をご確認ください
  
  

• ver 7.2.0 以降、ユーザー属性を一括で変更するメソッドが追加されました。
  以前の 1つずつ設定する方法（PopinfoUtils.setSegments(Context, String, String[]) )は非推奨となりますため、利用しております場合はユーザー属性の変更 を参考に変更してください。
  
  

• ver7.1.0 以降、フォアグラウンドのみで位置情報（GPS/Wi-Fi/iBeacon）の利用を行えるようになりました。
  フォアグラウンドのみで利用する場合は AndroidManifest.xml の android.permission.ACCESS_BACKGROUND_LOCATION 権限を削除してください。
  この権限を削除している場合、SDK は OS バージョンに関係なくバックグラウンドで位置情報の取得を行わなくなります。
  
  

• Google の位置情報に関するポリシー変更への対応については「6.4 バックグラウンドでの位置情報へのアクセスについて」をご確認ください。
  
  

• ver7.0.0以降、targetSdkVersion 30 以上で組みこんだアプリについて、Android 11 以上の端末を対象に位置情報の許諾の後に「バックグラウンド位置情報の許諾」というダイアログを表示するようにしております。
  このダイアログはレイアウトとして popinfo-sdk/res/layout/popinfo_background_location_dialog.xml を使用しております。
  ver7.0.1ではデフォルトで画像によるダイアログを表示しておりますが、文章のみの表示も可能なので必要な場合はこのファイルを編集してください。
  また、このダイアログは設定の POPINFO_SKIP_INIT_BACKGROUND_LOCATION によりスキップが可能となっております。
  
  

• ver6.0.1以降、設定画面でAndroid 10以上の場合に表示される「ヘッドアップ通知を維持する」の項目をデフォルトで非表示となるように変更しました。
  こちらは機種・OS固有の問題により正常に動作しない場合があるため、使用する場合はご注意ください。
  
  

• ver6.0.0以降、設定画面の popinfo-sdk/res/xml/popinfo_prefs.xml を廃止しました。
  カスタマイズをしている場合、 popinfo-sdk/res/layout/popinfo_settings.xml をコピーして変更してください。
  
  

• ver6.0.0以降、Popupクラスの初期化処理から requestWindowFeature を削除しました。
  Popupクラスのカスタマイズをしている場合、合わせて requestWindowFeature の記述を削除してください。
  
  

• ver6.0.0以降、Android 10以上の端末でヘッドアップ通知をデフォルトで表示させるため、組み込み時の通知チャンネルの重要度を 4 に設定しています。
  Android 10以上の初期値設定用として、popinfo-sdk/res/values/popinfo_values.xml に popinfo_notification_channel_importance_q_or_higher を追加しておりますので、Android 9以下の場合と使い分けてください。
  ※ Notificationのカスタマイズを行っている場合は、この影響を受けません
  
  

• ver5.0.2以降、Android Plugin for Gradleバージョンのサポート環境引き上げに伴い
  popinfo-sdk/res/layout/popinfo_list.xml（お知らせ一覧レイアウト） の一部コンポーネントの ID を変更しました。
  お知らせ一覧レイアウトをカスタマイズしていてビルド時にLintエラーが出た場合は、下記の新バージョンのIDに変更してください。

[旧バージョン]
android:id="@+id/android:list"
android:id="@+id/android:empty"

[新バージョン]
android:id="@android:id/list"
android:id="@android:id/empty"

• Android Plugin for Gradleバージョン毎にビルドの設定が変更されているため、
  popinfo-sdk/src/build.gradle にはサポート範囲内の各バージョンに最適な設定がコメントアウトされておりますのでご確認ください。 　
  
  

• 初期化メソッド2種（Popinfo.registerLifecycleCallbacks(Application application)、Popinfo.registerPopinfoReceiver(Application application)）が廃止されました。代わりに Popinfo.init(Application application) をご使用ください。
  
  

• ver4.x.x以降、FCMトークン はアプリモジュール側で取得して FANSHIP SDKへ設定する形式となります。再度「6.実装方法」をご確認ください。
  ※ PopinfoApplicationクラスの設定方法も変更になっておりますのでご注意ください。
  
  

• BLU300の機能は廃止されています。
  
  

• FANSHIP SDKはAndroid Studioライブラリプロジェクトに変更されています。
  
  

• サポートライブラリ「android-support-v4(rev.26.1.0以上)」の追加が必須となっています。
  
  

• Android 8.0以上の端末では、FANSHIP 設定画面項目の「通知エリア設定」が追加されています。
  ※端末設定のアプリ通知チャンネル設定画面へ遷移します。
  
  

• 特定の旧バージョンからアップデートされた場合、FANSHIP 設定画面項目の「通知エリアに通知」の項目が廃止されています。通知受信時に通知エリアには必ず通知されるようになります。
  
  

• 特定の旧バージョンで表示されていた、FANSHIP 設定画面項目の「ポップアップを表示」「サウンドを再生」「バイブレーション」の項目はデフォルトで非表示になっています。
  
  

• 特定の旧バージョンで表示されていた、FANSHIP 設定画面項目の「保存するお知らせの数」「位置情報の取得間隔」設定を廃止しました。削除された設定項目は組み込み時に限り、値を設定することができます。
  
  

• 特定の旧バージョンで表示されていた、初回起動時のインフォメーションダイアログの表示・非表示のデフォルト動作が変更されました。
  
  

• コールバッククラスの各種メソッドの名称変更(ver2.x～ver3.5.0未満からのアップデート時)・新規追加されました。必要に応じて追加、変更を行ってください。
  ※ コールバックメソッドの種類／詳細につきましては、同梱のPopinfoCallback.java または 同梱の popinfo_javadoc の PopinfoBaseCallback クラスの項目をご確認ください。

9.2 SDK ver4.0.0からのアップデートについて

• 現在導入している FANSHIP SDKのライブラリモジュール内を直接変更していない場合に限り、差し替えるだけでアップデートは完了となります。
  ※ 配信タイプ「Push通知のみ」配信を行う場合は、「8.よくあるカスタマイズ方法 - 配信タイプ「Push通知のみ」配信を使用時の処理を行う方法」をご確認ください。

9.3 SDK ver4.0.0未満からのアップデートについて

ver3.x.x以前からver4.x.x以上へのアッデート後は、FCMを使用したPUSH配信になります。
変更点が多いため再度手順に従い導入し直すことを推奨しておりますが、アップデートが必要な場合はサポート担当までお問合せ下さい。