コンテンツにスキップ

設定項目一覧

FANSHIP SDK に関する設定の一覧となります。

設定を行う場合は、AndroidManifest.xml の application タグ配下 に meta-data を追加してください。


meta-data 一覧

POPINFO_APP_ID

  • 株式会社アイリッジより発番した FANSHIP のアプリ ID を設定します。
  • 省略できない必須設定になります。

POPINFO_MAIN_ACTIVITY_CLASS

  • お知らせ一覧画面からの戻り先 Activity のクラス名を設定します。
  • auto に設定すると、直前に開いていたアプリの画面に戻ります。
  • 直前にアプリを開いていなかった場合は、ランチャーから起動する Activity を起動します。

POPINFO_CALLBACK_CLASS

  • SDK からコールバックを受け取るクラスのクラス名をパッケージ名を含めて設定します。
  • コールバックを受け取るクラスのサンプルは SDK に同梱の PopinfoCallback.java をご覧ください。
  • 省略時はコールバックを受け取りません。

POPINFO_LOCATION_SOURCES

  • 利用する位置情報の取得方法をカンマ区切りで指定します。
    • GPS
      • 位置連動型送信を使用する場合に指定します。
    • Wi-Fi
      • Wi-Fi 連動型送信を使用する場合に指定します。
    • iBeacon
      • iBeacon 配信を使用する場合に指定します。
  • 指定した種類に応じて一部の permissionの設定は不要になります。
  • 位置情報を利用しない場合、空の文字列を指定してください。
    • 位置情報に関するダイアログ、設定項目等は自動的に非表示になります。
  • 省略時は GPS のみ有効になります。

POPINFO_USES_PUSH_ONLY

  • 配信タイプ「Push通知のみ」を使用するかどうかを設定します。
  • false では、「Push通知のみ」配信を行っても通知は表示されないため、ご使用になる場合は true に設定してください。
  • 「Push通知&一覧表示」「一覧表示のみ」配信は設定値に関わらず動作します。
  • 省略時は false となります。

POPINFO_SKIP_INIT_AGREEMENT

  • FANSHIP 初回起動時に表示されるインフォメーションダイアログ(位置情報を使用している場合のみ)の表示(false)/非表示(true)を設定します。
  • (ver.7.2.0 以降)初回起動時のオプトインダイアログを任意で表示する場合はこの設定は無効となります。
  • 省略時は true となります。

POPINFO_SKIP_PUSH_AGREEMENT

  • FANSHIP 初回起動時に表示されるプッシュ通知許諾ダイアログの表示(false)/非表示(true)を設定します。
  • 非表示にした場合、許諾済みとして動作します。
  • (ver.7.2.0 以降)初回起動時のオプトインダイアログを任意で表示する場合はこの設定は無効となります。
  • 省略時は false となります。

POPINFO_USES_ANALYTICS

  • サーバーに送信された位置情報を統計的な分析に使用するかどうかを設定します。
  • Wi-Fi、Bluetooth による来店検知機能を利用する場合は true を設定します。
  • 省略時は false となります。

POPINFO_SHOW_SEGMENT_SETTINGS

  • ユーザー属性設定画面を自動的に表示するかどうかを設定します。
  • true に設定すると、 FANSHIP のユーザー登録完了時および FANSHIP の設定画面にユーザー属性設定画面への遷移を表示します。
  • (ver.7.2.0 以降)初回起動時のオプトインダイアログを任意で表示する場合はユーザー登録完了時のダイアログ表示は行われません。
  • 省略時は false となります。

POPINFO_USES_POPUP_ANDROID_Q_OR_HIGHER

  • Android 10以上の端末でポップアップを表示するかどうかを設定します。
  • true に設定すると、アプリがフォアグラウンドの際にポップアップを表示します。
  • OS の仕様により Android 10 以上の端末ではバックグラウンド時のポップアップ表示はできませんのでご注意ください。
  • 省略時は false となります。

POPINFO_DEBUG

  • 各種デバッグ情報を LogCat に出力するかどうかを設定します。
  • true に設定すると、popinfo ID の取得~プッシュ通知受信準備完了(通知受信可能状態)までの処理の結果が画面上に Toast で表示されます。
  • popinfo ID や FCMトークン が正常に取得できているかどうか確認する際にご使用ください。
  • リリース時は必ず false に変更してください。
  • 省略時は false となります。

POPINFO_EVENTACTION_DEBUG

  • イベントトラッキングのデバッグ情報を出力するか設定します。
  • true に設定すると、イベントトラッキングが付与された際にキー名を Toast で画面上に表示します。
  • アプリ内メッセージを利用する際、「カスタムイベント」が正常なタイミングで付与されているかなどを確認する際にご使用ください。
  • バックグラウンド状態やアプリ内メッセージが表示されている状態だと Toast は表示されません。
  • リリース時は必ず false に変更してください。
  • 省略時は false となります。

POPINFO_SKIP_INIT_BACKGROUND_LOCATION

  • FANSHIP 初回起動時に表示されるバックグラウンド位置情報許諾ダイアログの表示(false)/非表示(true)を設定します。
  • この設定は Android 11 以上の端末で、アプリが targetSdkVersion 30 以上にしている場合にのみ使用されます。
  • 省略時は false となります。

POPINFO_USES_PRIVACY_CONTROL

  • privacyControlを使用するかどうかを設定します。
  • 省略時は false となります。

POPINFO_USES_V2_SEGMENT_SETTINGS

  • ユーザー属性画面を開く際にネイティブの属性画面を開くかどうかを設定します。
  • true に設定した場合ネイティブのユーザー属性画面が、false に設定した場合はWebViewの属性画面が表示されます。
  • 省略時は false となります。

設定サンプル

meta-data 一覧 を参考に設定の追加・変更をしてください。

<!-- FANSHIP meta-data設定 -->
<meta-data
    android:name="POPINFO_APP_ID"
    android:value="<FANSHIPのアプリケーションIDを設定してください>" />

<meta-data
    android:name="POPINFO_MAIN_ACTIVITY_CLASS"
    android:value="auto" />

<meta-data
    android:name="POPINFO_SHOW_SEGMENT_SETTINGS"
    android:value="false" />

<meta-data
    android:name="POPINFO_DEBUG"
    android:value="false" />

<!-- 使用する位置情報の取得方法を設定してください。※ PUSH配信のみ使用する場合 「""」 空の文字列を設定してください。-->
<meta-data
    android:name="POPINFO_LOCATION_SOURCES"
    android:value="GPS,Wi-Fi,iBeacon" />

<!-- Wi-Fi、Bluetooth による来店検知機能を利用する場合 true に設定してください。 -->
<meta-data
    android:name="POPINFO_USES_ANALYTICS"
    android:value="false" />

<!-- 配信タイプ「Push通知のみ」の配信を行う場合は true に設定してください。-->
<meta-data
    android:name="POPINFO_USES_PUSH_ONLY"
    android:value="false" />