開発者向け

  • SDK組込みガイド

    Android SDK

    iOS SDK

    Coupon SDK for Android

    Coupon SDK for iOS

     

    FANSHIP ポイント 組み込みガイド for Android

    FANSHIP ポイント 組み込みガイド for iOS

     

    ほか

     


    SDKのリリースノート

  • 各種API仕様書一覧

    API

     

    その他

  • FANSHIP イベントに含まれる各パラメータについて

    [FANSHIP イベントの種類について]で公開している各イベントに含まれるパラメータに関する内容をまとめております。
    イベント内に含まれるパラメータ（配信IDやURLなど）を活用し分析する際にご利用ください。

    ■ デフォルトのパラメータに関して

    各イベントデータに以下の情報がデフォルトで含まれます。
    デフォルトで入ることが仕様となっており、外すことはできませんのでご了承ください。

    value 概要
    pModel 端末のモデル名称
    pOsVer 端末の OS バージョン
    pPopinfoVer SDK のバージョン
    pUsesPush プッシュ通知を利用するSDK組み込みとなっているかどうか


    ■ アプリ内イベント

    No event.name event.value

    1

    		 _S.app.active

    -
    2 _S.app.background -
    3 _push.receive

    ・id：配信ID
    4 _S.push.open

    ・id：配信ID
    ・src: 
      ・ popup（ポップアップダイアログ・バナーから起動）
      ・ notification:通知センターから起動（iOSロック画面含む）
    5 _S.detail.appear ・id：配信ID
    6 _S.detail.disappear ・id：配信ID
    7 _S.detail.openUrl

    ・id：配信ID
    ・src: button（固定）
      ・button（「URLを開く」ボタンをタップ）
    ・url: 遷移先URL（urlencoded）

    8 _S.detail.openUrl ・id：配信ID
    ・src:     link（固定）
      ・ link（お知らせ内のリンクURLをタップ）
    ・url: 遷移先URL（urlencoded）
    9 _S.list.appear -
     10 _S.list.disappear -
     11 _install.status

    ・pushEnabled: お知らせ受信可否（boolean）
    ・    locationEnabled: GPS受信可否(boolean)
    ・wifiEnabled: Wi-Fi受信可否（boolean）
    ・bluetoothEnabled: Bluetooth受信可否(boolean)
     12

    _update.status
    ※プッシュ通知許諾状況

    		 ・pushEnabled: お知らせ受信可否（boolean）
     13 _update.status
    ※GPS許諾状況    		 ・locationEnabled: GPS受信可否(boolean)
     14

    _update.status

    ※Wi-Fi許諾状況

    		 ・wifiEnabled: Wi-Fi受信可否（boolean）
     15

    _update.status
    ※Bluetooth許諾状況

    		 ・bluetoothEnabled: Bluetooth受信可否(boolean)
     16

    _update.status
    ※位置情報許諾状態の変更

    ※iOSのみ取得可
    ・locationAuthorization:
      ・ authorizedAlways (「常に許可」を選択)      
      ・ authorizedWhenInUse (「アプリ利用中のみ」を選択）
      ・ denied （「拒否」を選択）  
      ・ restricted （位置情報は利用できない）
     17 _install.sdk ・appVer: アプリバージョン
    ・appVerName: アプリバージョンネーム
    ・model: ハードウェアモデル名
    ・osVer: OSバージョン
    ・popinfoVer: popinfoのバージョン
    ・carrier: キャリア名
    ※Xcode 14.3 でビルドされたアプリを iOS 16.4で利用した際、carrierの値は'--’となります。
     18 _update.env ・appVer: アプリバージョン
    ・appVerName: アプリバージョンネーム
    ・model: ハードウェアモデル名
    ・osVer: OSバージョン
    ・popinfoVer: popinfoのバージョン
    ・carrier: キャリア名
    ※Xcode 14.3 でビルドされたアプリを iOS 16.4で利用した際、carrierの値は'--’となります。
     19 _wifi.in ・bssid: 検出したBSSID
    ・essid: 検出したESSID
     20 _wifi.out ・bssid: 検出したBSSID
    ・essid: 検出したESSID
     21 _bluetooth.in ・type: iBeacon（固定）
    ・uuid: iBeaconのUUID
    ・major: iBeaconのmajor
    ・minor: iBeaconのminor
    ・rssi: 電波強度
     22 _bluetooth.out ・type: iBeacon（固定）
    ・uuid: iBeaconのUUID
    ・major: iBeaconのmajor
    ・minor: iBeaconのminor
    ・rssi: 電波強度
     23 「_」から始まらない文字列 任意のパラメータ
     24 _event.delete

    ・num: 削除したイベントの数
     25 _app.alive -
     26 _S.page.open ・scheme: URLのスキーマ(://は含めない)
    ・authority: URLのホスト名またはIPアドレスとポート番号
    ・path: ドメイン以降からクエリパラメータまでの文字列(ルートの場合は/を送る)
    ・query: クエリパラメータ(?は含まない)
    ・fragment: URLのフラグメント
    ・referrer: 遷移元URL
    ・title: ページタイトル
    ・canonicalUrl: rel属性の値が"canonical"なlink要素が存在する場合、そのlink要素のhref属性値
    ・ogUrl: property属性の値が"og:url"なmeta要素が存在する場合、そのmeta要素のcontent属性値
    ・eventTrackerVer: モジュールのバージョンを送信する
    ・sessionId: 新しいWebViewでページを開く度に付与されるIDが入ります。WebViewを開いている限り、ページの再読み込みや復元を越えて同じ値となります。
     27 「_」から始まらない文字列 任意のパラメータ

    28

    		 _inapp.appear ・message_id : アプリ内メッセージID
    ・delivery_id : 配信ID
    ・condition_id : アクション条件ID

    29

    		 _inapp.button_[button_id].click ・message_id : アプリ内メッセージID
    ・delivery_id : 配信ID
    ・condition_id : アクション条件ID
    ・配信作成時にパラメータを追加した際、任意のパラメータとして追加される。

    ※押されたボタンによって、 [button_id] が変動する。
    基本的には 0 ~ 2 の ID が割り振られる。（「閉じる」ボタンは0）
     

    ※ event.valueが「-」のものは、デフォルトのパラメータのみが含まれます。

     

    ■ サーバーサイドイベント

    No event.name event.value
    1 _SS.push.success

    ・messageID: 配信ID
    ・payload: ペイロード
    2 _SS.push.retry ・messageID: 配信ID
    ・payload: ペイロード
    ・code: ステータスコード
    ・reason: エラー理由
    3 _SS.push.fail ・messageID: 配信ID
    ・payload: ペイロード
    ・code: ステータスコード
    ・reason: エラー理由
    4 _SS.coupon.appear

    ・providerUuid: 店舗のuuid
    ・providerName: 店舗の名前
    ・uuid: クーポンのuuid
    ・name: クーポン名
    ・shortDescription: クーポンの概要説明
    ・description: クーポンの詳細説明
    ・usableStartDate:有効開始日時
    ・usableEndDate:有効終了日時
    ・visibleStartDate: 表示開始日時
    ・visibleEndDate: 表示終了日時
    ・totalMaxCount: クーポン利用上限枚数
    ・userMaxCount: 1人あたり使えるクーポン枚数
    5 _SS.coupon.use ・providerUuid: 店舗のuuid
    ・providerName: 店舗の名前
    ・uuid: クーポンのuuid
    ・name: クーポン名
    ・shortDescription: クーポンの概要説明
    ・description: クーポンの詳細説明
    ・usableStartDate:有効開始日時
    ・usableEndDate:有効終了日時
    ・visibleStartDate: 表示開始日時
    ・visibleEndDate: 表示終了日時
    ・totalMaxCount: クーポン利用上限枚数
    ・userMaxCount: 1人あたり使えるクーポン枚数
    6 _SS.coupon.favorite ・providerUuid: 店舗のuuid
    ・providerName: 店舗の名前
    ・uuid: クーポンのuuid
    ・name: クーポン名
    ・shortDescription: クーポンの概要説明
    ・description: クーポンの詳細説明
    ・usableStartDate:有効開始日時
    ・usableEndDate:有効終了日時
    ・visibleStartDate: 表示開始日時
    ・visibleEndDate: 表示終了日時
    ・totalMaxCount: クーポン利用上限枚数
    ・userMaxCount: 1人あたり使えるクーポン枚数
    7 _SS.coupon.unfavorite ・providerUuid: 店舗のuuid
    ・providerName: 店舗の名前
    ・uuid: クーポンのuuid
    ・name: クーポン名
    ・shortDescription: クーポンの概要説明
    ・description: クーポンの詳細説明
    ・usableStartDate:有効開始日時
    ・usableEndDate:有効終了日時
    ・visibleStartDate: 表示開始日時
    ・visibleEndDate: 表示終了日時
    ・totalMaxCount: クーポン利用上限枚数
    ・userMaxCount: 1人あたり使えるクーポン枚数
    8 _SS.coupon.distribute ・providerUuid: 店舗のuuid
    ・providerName: 店舗の名前
    ・uuid: クーポンのuuid
    ・name: クーポン名
    ・shortDescription: クーポンの概要説明
    ・description: クーポンの詳細説明
    ・usableStartDate:有効開始日時
    ・usableEndDate:有効終了日時
    ・visibleStartDate: 表示開始日時
    ・visibleEndDate: 表示終了日時
    ・totalMaxCount: クーポン利用上限枚数
    ・userMaxCount: 1人あたり使えるクーポン枚数