SDK

管理画面にログインし、「SDK 及び 資料ダウンロード(最新版)」からダウンロードいただけます。

• iOS (ネットワーク測位モードで組み込んだ場合)： 低
• iOS (定期GPSモードで組み込んだ場合) ：高
• Android
• 大幅位置移動検出時とは
• 滞在、移動開始検出時とは

iOS (ネットワーク測位モードで組み込んだ場合)： 低

• 大幅位置移動検出時
• 滞在、移動開始検出時

iOS (定期GPSモードで組み込んだ場合) ：高

• 大幅位置移動検出時
• 滞在、移動開始検出時
• 5分に1回

Android

• 5分に1回　※組込時、SDKで任意に指定可能

ほか、アプリをターミネートしてから再度起動した場合もGPS・セルベースの測位を得る事ができます。

大幅位置移動検出時とは

通信時に基地局からの情報を元に、位置情報取得しております。
例として、Aという基地局の通信から、Bという基地局の通信に変わった場合に取得されます。

滞在、移動開始検出時とは

「緯度経度、到着時間、出発時間」をiOSが知らせてくれる仕組みから位置情報を検知しております。
滞在の具体的な基準値やロジック等はOS側で、開示されているものではございませんのでご了承ください。

位置情報をFANSHIPサーバーへ送るタイミングはこちらを参照ください。

こちら でご確認ください。

iOS 13 以降、インストール時に表示される「位置情報許諾ダイアログ」について、位置情報の許諾ステータスの内容と遷移が変更されたため、弊社検証用アプリ を用いて確認した内容を掲載します。

(1)「常に許可」の削除

これまでは、位置情報の利用許可にあたって、ユーザーに対して「常に許可」「許可しない」「このAppの使用中のみ許可」の3つの選択肢が提示されましたが、iOS 13 からは、「常に許可」が削除され、かわりに「1度だけ許可」が追加されました。

(2) 段階的権限昇格

これまでは、Appが位置情報を利用する際に Appのインストール直後からユーザーに「常に許可」を選択肢として提示できるようになっていましたが、iOS 13 からは、「暫定的に『常に許可』」という内部状態を経由することで、はじめて（暫定ではない）「常に許可」の状態（位置情報利用認可）を獲得できるようになります。

位置情報使用許可における「1度だけ許可」について

Appを起動してから終了するまでの期間が「1度だけ」が指す範囲となります

許諾ダイアログに応答したあとに同じ画面でアプリ内メッセージ表示をする制御は難しいため、
「許諾ダイアログが出ているときは、アプリ内メッセージを表示しない」対応をお勧めします。

// 通知が許可されているかどうかを確認
UNUserNotificationCenter.current().getNotificationSettings { (settings) in
    switch settings.authorizationStatus {
    case .authorized:
        // 通知が許可されている場合
        break
    case .denied:
        // 通知が拒否されている場合
        break
    case .notDetermined:
        // 通知許諾状態が未定の場合
        break
    }
}

記載箇所などは 組込みガイド の「8 アプリ内メッセージの実装」を参考にしてください。

「SDK 及び 資料ダウンロード(最新版)」にアクセスできず、以下のような画面が表示された場合、
お手数ですが こちらのURL にアクセスいただき、ダウンロードをお願いいたします。

上記URLへアクセスできない場合、お客様の環境でインターネットへのアクセス制限を掛けられている可能性がございます。

恐れ入りますが、社内ネットワークのアクセス制限のご確認をお願いいたします。

また、アクセスできない場合、お問合せいただければ最新のSDKファイルをお送りすることも可能です。フォーム・またはメールにてご依頼ください。

SDKのお知らせ一覧の表示件数はSDKの設定値で変更できます。
初期値は iOS が100件、Android が1000件となっているので、適宜変更してください。

設定した数値に達した時点で、古いお知らせから表示されなくなり、非表示となります。
（削除はされず、端末内に保存されます。）

変更は以下ファイルをご確認ください。


Android

/popinfo-sdk/res/values/popinfo_values.xml ファイル内

public static final int MESSAGES_NUM_DEFAULT_VAL = 1000;

iOS

/lib/PopinfoConfiguration.m ファイル内

int const popinfoMessagesMax = 100;

カスタムイベントの文字制限について

カスタムイベントには、以下の制限があることにご注意ください。

• キー名は、英数字（[a-zA-Z0-9]）、アンダースコア(_)、ピリオド(.)、ハイフン(-)のみ使用できます。
• キー名の先頭にアンダースコア(_)は使用できません。
• キー名が nil や空文字の時は記録できません。
• 文字数制限は、キー名が 32 文字、キーに対する値はトータルで 512 文字 です。

参考｜SDKカスタマイズ方法（iOS）
参考｜SDKカスタマイズ方法（Android）

WebView版イベントトラッキングの文字制限について

WebView版イベントトラッキングには、以下の制限があることにご注意ください。

• 文字数制限は、キー名が 0文字以上10000文字未満、キーに対する値はトータルで 10000文字未満 です。

なお、イベント名（shop.addCart）については下記の制限があります。

• 英数字（[a-zA-Z0-9]）、アンダースコア(_)、ピリオド(.)、ハイフン(-)のみ使用できます。
• 先頭にアンダースコア(_)は使用できません。

参考｜WebView版イベントトラッキング機能 組み込みガイド v3

「URLを開く」ボタンは、【ネイティブのボタン】で実装されており、カスタムURLスキームがセットされた場合は外部アプリが開けるような実装が標準でなされています。

お知らせ詳細（コンテンツ）のリンクに関しては【WebView内で表示されるWebページのボタン】で実装されており、そこではカスタムURLスキームの場合は外部アプリが開けるような実装がされておりません。

そのため、カスタムURL（DeepLink） を参照したい場合は表示用の処理を入れていただく必要があります。

「カスタムURLの処理が実行されない」場合は、カスタムURLスキームが処理できていない可能性が考えられますので、実装を再度ご確認お願いいたします。

<iOS>
decidePolicyForNavigationAction の実装を再度ご確認ください。

参考：https://developer.apple.com/documentation/webkit/wknavigationdelegate/1455641-webview

PopinfoDetailViewController.m ファイルの中において独自に decidePolicyForNavigationAction を定義しているため、
「独自のカスタムURLスキーム処理を行いたい場合に、これをオーバーライドし忘れていないか」もご確認ください。

「ほかのWebViewだとカスタムURLを開けるのに、詳細画面だと開けない」というようなケースの場合、 「PopinfoDetailViewController.m ファイルの decidePolicyForNavigationAction 処理を見落としている」ケースが該当する可能性が考えられます。

<Android>

popinfoMessageView.javaファイル内の、カスタムURLの独自実装部分をご確認ください。

参考：カスタムURLの設定

Q. フォアグラウンド時のみ位置情報取得可能と実装した場合、Wi-Fi,beaconもバックグラウンド時には検知されませんか？

A. Wi-Fi,beaconも位置情報と同様の定義となるためバックグラウンド時には検知されません。
そのため、 フォアグラウンド時のみ位置情報取得可能と実装した場合は、
アプリがフォアグラウンド時のみ、Wi-Fi,beacon,GPS配信受信可能となります。

<補足>

AndroidManifest.xml に以下を記載するか否かにより、バックグラウンド時に位置情報を取得するかどうかを選択できます。

<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

※記載した場合、バックグラウンド時に位置情報取得可能となります。

GooglePlay への申請時に別途バックグラウンド位置情報のための申請が必要となりますのでご注意下さい。

Q. お知らせ件数全件、お知らせ未読全件などを取得するようなメソッドはありますか？

A. 

【お知らせ件数全件】

<iOS>

// vc は PopinfoListBaseViewController のインスタンス
lvc.retrieveAllPopinfoMessages().count

※ PopinfoConfiguration.m  にある popinfoMessagesMax の影響を受けるため、たとえば int const popinfoMessagesMax = 100; と設定されている場合、端末に対して１００件以上のメッセージを送ったとしても、取得される件数は１００になります

※ 上記実装はPopinfoListBaseViewController を継承したクラスで行うのが推奨されます。

<Android>

クラス PopinfoUtilsAsyncのgetPopinfoAllMessages

【お知らせ未読全件】

<iOS>

クラスPopinfoReceiverのgetUnreadMessagesCounts

<Android>

クラス PopinfoUtilsAsyncのgetUnreadMessagesCount

※補足として、お知らせ全件、未読件数を上記で取得できますので、差し引けば既読件数も取得可能です。

iOSについて

上記画像のような、プッシュ通知受信時に表示されるアラートが表示されるのは

以下のような実装を行っていると推測されます。

こちらのコードを削除することにより、アラート（ダイアログ）は表示されなくなります。

let alert = UIAlertController(title: "お知らせ", message: popup, preferredStyle: UIAlertController.Style.alert)
alert.addAction(UIAlertAction(title: "閉じる", style: UIAlertAction.Style.default, handler: {(alert) in
// 閉じるボタンが押された時は何もしない
}))
alert.addAction(UIAlertAction(title: "表示", style: UIAlertAction.Style.default, handler: {(alert) in
// 表示ボタンが押された時はお知らせ詳細画面に遷移する
}))
self.window?.rootViewController?.present(alert, animated: true, completion: nil)

※UIAlertController を使用している箇所を検索し、お探しください。

Androidについて

上記画像のような、プッシュ通知受信時に表示されるアラートの制御部分は以下になります。

popinfo_values.xml

<!-- ポップアップを表示 -->
<string name="popinfo_popup_enabled_default">false</string>

上記popinfo_popup_enabled_default は初期値として指定をしておりますが、
別途メソッドとして PopinfoSettingUtils.setPopupEnabled を使用することでも、ポップアップダイアログ表示の ON/OFF を変更することが可能です。

CoreData バージョンが不整合の場合は、クラッシュの原因となります。
iOS SDKバージョンによっては CoreData モデルがバージョンアップしている場合がありますので、
SDK組込みガイド（従来版）「4 SDK付属品一覧」 における CoreData モデルバージョン を確認の上、
モデルバージョンが正しく設定されていることをご確認ください。

■CoreData バージョンを変更するには？
Xcode上で、PopinfoReceiver.xcdatamodeld をクリックすると、
画面右側「Core Data Model > Model Version」の「Current」にバージョンが表示されます。
Current のプルダウンメニューから、最新バージョンを選択してください。
CoreDataモデルバージョンは常に最新バージョンを指定してください。
バージョンが適切に設定されていない場合、App の異常終了を発生させることがあります。

具体的には以下のイベントの発火契機をまとめています。

開封数・・・ _S.push.open
お知らせ閲覧数・・・ _S.detail.appear
サイト閲覧数・・・ _S.detail.openUrl
お知らせ一覧閲覧終了・・・_S.list.disappear
お知らせ詳細閲覧終了・・・_S.detail.disappear

下記が各イベントが発火する契機となりますので、正しくメソッドが呼ばれているかご確認ください。

iOS

開封数（_S.push.open）

• メソッド PopinfoReceiver.shared.receiveNotification(_:) が呼ばれたタイミング
  • 通常時、通知バナーをタップしたタイミングで上記メソッドが呼ばれます

閲覧数（_S.detail.appear）

• お知らせ詳細画面のライフサイクルメソッド viewWillAppearがコールされたタイミング
  • 継承先で同メソッドを実装している場合は call-super を忘れていないことが発火条件です

サイト閲覧数（_S.detail.openUrl）

• -[PopinfoDetailBaseViewController didSelectOpenUrl]が呼ばれたタイミング
• PopinfoDetailViewController を継承したクラスで webView:decidePolicyForNavigationAction:decisionHandler:メソッドを追加しているかつ、[super webView:decidePolicyForNavigationAction:decisionHandler:]を呼んでいる場合

お知らせ一覧閲覧終了（_S.list.disappear）

• お知らせ一覧画面が最前面でなくなった時に記録されます
• お知らせ一覧画面のライフサイクルメソッド viewWillDisappear がコールされたタイミング

お知らせ詳細閲覧終了（_S.detail.disappear）

• お知らせ詳細画面が最前面でなくなった時に記録されます
• お知らせ詳細画面のライフサイクルメソッド viewWillDisappearがコールされたタイミング
  • 継承先で同メソッドを実装している場合は call-super を忘れていないことが発火条件です

Android

開封数（_S.push.open）

• PopinfoBasePopupクラスを継承しているクラスからPopinfoUiUtils.showMessageView(Context context, long messageId)メソッドをコールしたタイミング
• PopinfoBasePopupクラスを継承している場合、PUSH受信時のポップアップ画面の任意のタイミングで PopinfoBasePopup.trackEventPushOpen()を呼びだすことでイベント付与されます

閲覧数（_S.detail.appear）

• PopinfoBaseMessageView クラスを継承しているクラスを表示した際に付与されます
  • 端末ホーム画面→お知らせ詳細画面へ復帰、などの遷移でも付与されます
• お知らせメッセージを独自に取得しFragmentの切り替えを行っている場合では閲覧率は記録されません

サイト閲覧数（_S.detail.openUrl）

• WebView 内での遷移
  • PopinfoMessageWebViewClient を実装し、この中で shouldOverrideUrlLoading の super.shouldOverrideUrlLoading(view, url);を呼んでいる場合
• URL を開くボタンでの遷移
  • PopinfoUiUtils.openUrl で URL を開いた場合 
• イベント付与するのみのメソッド（ボタンで開いた際と同じパラメータとなる）
  • PopinfoBaseMessageView.trackEventOpenUrl をコールした場合
    • PopinfoUiUtils.openUrl を使用できない場合はこちらを利用

お知らせ一覧閲覧終了（_S.list.disappear）

• PopinfoBaseList クラスを継承している場合
  
  • 画面が非表示となる直前(onPause時)に付与されます

お知らせ詳細閲覧終了（_S.detail.disappear）

• PopinfoBaseMessageView クラスを継承している場合
  • 画面が非表示となる直前(onPause時)に付与されます

最新版 SDK のご利用を推奨いたします。

使いたい新機能が発生したタイミング・不具合解消版、もしくは開発環境のverアップ時などに、
対応版のSDKへのアップデートをご検討ください。

OSごとのサポート状況｜https://support.fanship.jp/hc/ja/articles/360034208634

リリースノート（新機能情報）
iPhone｜https://support.fanship.jp/hc/ja/articles/360009909634
Android｜https://support.fanship.jp/hc/ja/articles/360010087293

Android 端末では、Doze モード、アプリスタンバイバケットなどの電源管理機能の影響により、
バックグラウンド時のアプリ動作に制限が掛かることで、プッシュ通知が遅れて届く場合があります。

プッシュ通知の優先度「高」を選択することにより、電源管理の制限にかかることなく通知を送ることが可能ですが、各機能や、アプリの状態によって制限事項が異なります。以下をご参考ください。

※優先度「高」のプッシュ通知を適用させる場合、FANSHIP Android SDK ver 7.3.1以上を組み込む必要があります。

※FANSHIP Android SDK ver 7.3.1以下を組み込んでいる場合、プッシュ通知は正常に届きますが、優先度「高」の状態は適用されません。

■Dozeモード

■アプリスタンバイバケット

アプリスタンバイバケットは4種類あり、それぞれ以下のように定義されています。
各バケットの詳細については、公式ドキュメントをご確認ください（こちら）

• アクティブ（active）
  • 現在使用されている、またはごく最近使用されたアプリ
• ワーキング セット（working set）
  • 定期的に使用されているアプリ
• 高頻度（frequent）
  • 毎日ではないが、よく使用されるアプリ
• 低頻度（rare）
  • あまり使用されないアプリ

各バケット種別により、制限事項が異なります。

※端末上のアプリが「頻繁」や「低頻度」のバケット種別になっている場合、
「優先度：高」でプッシュ通知を送信した場合でも、受け取れる通知の数に制限が設けられています。

※制限を受けない・・・電源管理機能などの影響を受けずにプッシュ通知を送ることが可能です。
※制限を受ける・・・電源管理機能などの影響を受け、プッシュ通知が実際に端末に到達するのに遅延が発生する恐れがあります。

Android 公式サイト引用：

• https://developer.android.com/topic/performance/power/power-details?hl=ja
• https://developer.android.com/topic/performance/appstandby?hl=ja

以上です。
内容について不明点あれば、お気軽に お問合せ ください。

iOSの場合

入稿時、FANSHIP Management API をご利用の場合、ペイロード指定をすることでアプリ側にバッジを表示させないことが可能です。現状 SDK 実装による非表示対応は行えません。

popup_itemsによるプッシュ通知ペイロード指定にて、badgeを「0」と指定することで非表示にできます。

ただし、こちらはプッシュ通知を受信した際にバッジのカウントをリセットするものとなり、プッシュ通知を入稿する際に毎回「0」に設定する必要があります。

また、FANSHIP Management APIのみの対応可能となっており、
FANSHIP管理画面からの入稿では対応しておりませんのでご承知おきください。

各種API仕様書一覧

https://support.fanship.jp/hc/ja/articles/360026718253

Androidの場合

Androidでは設定 -> アプリと通知 -> アプリ情報 -> アプリの通知 -> 通知ドットの許可 にてエンドユーザー側で制御が行えます。

アプリ側で制御したい場合は以下の通り実装をしてください。
※ 実装を行った場合でも、エンドユーザー側にて設定変更が可能

①通知のカスタマイズ設定を行い、アプリ独自の通知チャンネルを作成します。

※ popinfo_valuses.xml の popinfo_notification_customize_enabled を true にすることでカスタマイズが ON になります。

② 通知チャンネルを作成するタイミングで setShowBadge(false) を指定してください。
※ setShowBadge についてはチャンネル作成時にしか設定できないためご注意ください。

③ PopinfoCallback の onNotificaitonAppeared で作成した通知チャンネルを指定してください。
※組み込みガイドの各種機能 > コールバックをご参考ください。

組み込みガイド

https://support.fanship.jp/hc/ja/articles/360026570534

以上です。
不明点があればお気軽にお問い合わせください。

属性アンケート画面は、インストール直後以外でも任意のタイミングで表示ができます。
以下、各SDKの組込みガイドをご確認いただければと思います。

組み込みガイド > 各種機能 > ユーザー属性
https://support.fanship.jp/hc/ja/articles/360026570534

表示させたいタイミングで以下のメソッドを呼び出してください。

◆Android

boolean ret = PopinfoUiUtils.showSegmentSettings(this);
 // this はContext

◆iOS

let segmentVC = PopinfoSegmentSettingsViewController(nibName:"PopinfoSegmentSettingsViewController",
  bundle:Bundle.main)
  segmentVC.delegate = self    

どうぞよろしくお願いいたします。