共通

「iBeacon検知 / 離脱」「WiFi検知 / 離脱」イベントを出力させるためには、
検知対象となるiBeaconやWi-Fiの情報（UUIDやESSIDなど）をFANSHIPにホワイトリスト登録する必要があります。

登録が必要な際はお手数ではございますが、FANSHIPサポートまでお問い合わせください。
お問い合わせの際、以下の情報をご連絡いただきますようお願いいたします。

• アカウント名（またはログインID）
• UUID（iBeacon）
• ESSIDまたはBSSID（Wi-Fi）

「iBeacon検知」「Wi-Fi検知」以外のイベントについては以下の記事をご参照ください。

• FANSHIP イベントの種類について

FANSHIP Management APIのAPIリクエストサンプルをいくつかまとめました。
APIリクエストの参考としてご活用ください。

※本ガイドに記載のリクエストはあくまでサンプルとなります。
実際にご利用の際は、あらかじめ開発環境などでご確認の上、ご利用ください。

※本サンプルは、「curl」コマンドを利用したものとなっています。

※サンプルに含まれている変数は以下を意味しています。

• ${POPINFO_HOST} = Management APIのホスト名
• ${POPINFO_AUTH} = 認証トークン
• ${LOGIN_ID} = ログインID
• ${PASSWORD} = パスワード
• ${POPINFO_ID} = popinfo ID
• ${ANDROID_POPINFO_ID} = Android端末のpopinfo ID
• ${IPHONE_POPINFO_ID} = iPhone端末のpopinfo ID
• ${MESSAGE_ID} = 配信ID
• ${DEVICE_TYPE} = "android" or "iphone"

ログインAPI

仕様書：https://docs.fanship.jp/mapi/login.html
説明：認証tokenを作成し、取得するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/login/ \
-d '{
   "user_id": "${LOGIN_ID}",
   "password": "${PASSWORD}",
   "count_limit": 0,
   "time_limit": 0
}'

配信登録API（即時配信、全体配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を全ユーザーに即時で配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
    ],
    "popup": "ポップアップ",
    "title": "件名",
    "content": "本文"
}'

配信登録API （即時配信、ID指定配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を特定ユーザーに即時で配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
     ],
    "popup": " ポップアップ",
    "title": "件名",
    "content": "本文",
    "target_id": {
        "android": [
           "${ANDROID_POPINFO_ID}"
        ],
        "iphone": [
           "${IPHONE_POPINFO_ID}"
       ]
    }
}'

配信登録API（予約配信、全体配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を全ユーザーに時間を指定して配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
   "type": "scheduled",
   "content_type": "text/plain",
   "platform": [
       "iphone",
       "android"
   ],
   "popup": "テスト配信",
   "title": "テスト件名",
   "content": "テスト本文",
   "send_time": "2023-03-01 16:00:00"
}'

テスト送信 API

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知のテスト配信を特定ユーザー（テスト端末登録者）に送信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/test/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
    ],
    "popup": "ポップアップ",
    "title": "件名",
    "content": "本文",
    "target_id": {
        "android": [
            "${POPINFO_ID}"
        ],
        "iphone": [
            "${POPINFO_ID}"
        ]
    }
}'

配信一覧取得API

仕様書：https://docs.fanship.jp/mapi/list.html
説明：配信一覧を取得するAPIリクエストです。

curl -X GET \
https://${POPINFO_HOST}/mapi/3.1/info/ \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}"

配信情報取得API

仕様書：https://docs.fanship.jp/mapi/detail.html
説明：配信IDを指定し、配信内容の詳細情報を取得するAPIリクエストです。

curl -X GET \
https://${POPINFO_HOST}/mapi/3.1/info/${MESSAGE_ID} \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}"

登録者情報一覧取得 API

仕様書：https://docs.fanship.jp/mapi/user.html
説明：登録ユーザー（popinfo_id）の情報を取得するAPIリクエストです。
特定popinfo_idの「お知らせ受信の可否」「位置情報送信の有効」を取得しています。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/user_stats/${DEVICE_TYPE}/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "fields": [
        "push_enabled",
        "location_enabled"
    ],
    "filter": [
        {
            "popinfo_id": {
                "$in": [
                    "${POPINFO_ID}"
                ]
            }
        }
    ]
}'

popinfo IDはアプリ初回起動時に発行されます。

各OSごとに、以下のメソッドが呼ばれたタイミングで発行されます。
Android：popinfo.start
iOS：loadSettings

上記メソッドは組み込みが必須となります。
詳細は組み込みガイドの事前準備をご確認ください。

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

FANSHIPレポートを閲覧するには閲覧権限が必要となるため、閲覧権限が付与されていない場合は、以下の画像のようなエラーが発生します。

閲覧権限の追加をご希望の場合は、画面上の「Request Access」からメールアドレスを入力し、追加リクエストを送信してください。
※閲覧権限は何件でも追加可能です。

通常3営業日以内にリクエストの承認を行っていますが、3営業日を経過しても承認されない場合は、「サポートガイドライン」を参照の上、FANSHIPサポートまでお問い合わせください。

なお、権限を追加できるメールアドレスは、Google アカウント（Gmailアドレス）となりますので、ご注意ください。
※FANSHIPレポートに閲覧権限が与えられると、Google アカウント（Gmailアドレス）宛てにメールが届きます。

機能や動作に差異はなく、本番用、開発用ともに商用となっております。
そのため、負荷試験等を行う場合、一度担当かサポートまでご相談をお願いいたします。

＜本番環境の違い＞

• ログイン後の管理画面左上に［本番環境］とラベルがつきます
• プッシュ通知の本番配信登録時、［登録する］ボタン押下時に「このアカウントは本番用です。配信には十分ご注意ください。」 というメッセージがでます。

各種IDの確認方法について以下内容をご確認ください。

• popinfo IDの確認方法
• 配信IDの確認方法
• アプリ内メッセージ配信IDの確認方法
• フォーマットIDの確認方法
• セグメントIDの確認方法
• クーポンUUIDの確認方法

popinfo IDの確認方法

以下URLをご確認ください。
https://support.fanship.jp/hc/ja/articles/360011541514

配信IDの確認方法

管理画面＞プッシュ通知＞配信一覧 から、配信詳細画面へ遷移します。
URLに記載されている`XXXXXXXXXX`の部分が配信IDとなります。

https://dashboard.fanship.jp/ja/message/detail/XXXXXXXXXX/1/

アプリ内メッセージ配信IDの確認方法

管理画面＞アプリ内メッセージ＞配信一覧 から、配信詳細画面へ遷移します。
URLに記載されている'XXXXXX'の部分がアプリ内メッセージの配信IDとなります。https://dashboard.fanship.jp/ja/inapp/message/detail/XXXXXX/1/

フォーマットIDの確認方法

管理画面＞プッシュ通知＞フォーマット覧から、フォーマット詳細画面へ遷移します。
URLに記載されている`XXXXXXXXXX`の部分がフォーマットIDとなります。

https://dashboard.fanship.jp/ja/draft/detail/XXXXXXXXXX/1/

セグメントIDの確認方法

管理画面＞セグメント管理＞セグメント一覧 から、セグメント詳細画面へ遷移します。
URLに記載されている`XXXX`の部分がセグメントIDとなります。

https://dashboard.fanship.jp/ja/segmentation/segments/detail/XXXX

クーポンUUIDの確認方法

管理画面＞クーポン＞クーポン一覧から、クーポン編集画面へ遷移します。
URLに記載されている`XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`の部分がクーポンUUIDとなります。

https://dashboard.fanship.jp/ja/coupon/coupon/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/

popinfo IDの確認方法は以下となります。
※本確認方法は標準組み込みの場合の確認方法となります。

iOS

iOSホーム画面から「設定」→対象のアプリをタップ→図のようにpopinfo IDが表示されます。

Android

対象のアプリを起動→メニューアイコンもしくは下部メニューより「プッシュ通知」をタップ→

お知らせ一覧画面の右上「歯車」をタップ→図のようにpopinfo IDが表示されます。

標準のお知らせ設定画面を使用せずにカスタマイズして実装されている場合は、「ユーザーIDの確認」までの経路が異なる場合があります。

また、「ユーザーIDの確認」欄を表示していない場合は、以下のメソッドでpopinfo IDを取得し、必要に応じてアプリ側で表示を行う実装をしてください。

getPopinfoId

詳細はjavadocのPopinfoクラスをご参照ください。

端末からアプリがアンインストールされた場合 popinfo ID は削除(無効化)され、管理画面の「アプリ初回起動数」から減算されます。

アンインストールの判定は、popinfo IDに対して配信を行った際にAPNs, FCMから特定のエラー(※)が返された場合に有効となります。

また、アンインストールの判定は、APNs／FCMにより遅れることがあります。

※エラーメッセージ
　APNs：Unregistered
　FCM ：NotRegistered

参考（公式サイト）

APNsの通知送信について
FCM メッセージについて

■ユーザー情報　：ユーザー情報（Android）／ユーザー情報（iOS）

管理画面

レポート＞ユーザー情報

ダウンロードCSVヘッダ

※黄色のセルは、設定されているユーザー属性が表示されます。

ダウンロードファイル名（例）

android.yyyy-mm-dd_hh_mm.1.csv

iphone.yyyy-mm-dd_hh_mm.1.csv

※ダウンロードしたタイミングの日時がファイル名に入ります。

※100,000件ずつダウンロードされ、ファイルタイトルの最後の数字は、ページ数を示します。

100,001~200,000の範囲のcsvファイルのタイトルは、最後の数字が「２」になります。

■プッシュ通知（ユーザークロス指標）

管理画面

レポート＞プッシュ通知＞ユーザークロス指標

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

fanship_analytics_push_and_user_yyyymmdd-yyyymmdd.csv

※ダウンロード時に指定した期間がファイル名に入ります。

■プッシュ通知（プッシュ項目別）

管理画面

レポート＞プッシュ通知＞プッシュ項目別

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

fanship_analytics_push_by_item_yyyymmdd-yyyymmdd.csv

※ダウンロード時に指定した期間がファイル名に入ります。

■プッシュ通知（配信結果）

管理画面

レポート＞プッシュ通知＞配信結果

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

fanship_analytics.push_list.csv

■セグメントユーザー数

管理画面

レポート＞セグメント＞セグメントユーザー数

ダウンロードCSVヘッダ

※黄色のセルは、設定されているセグメントが表示されます。

ダウンロードファイル名（例）

fanship_analytics_segment_yyyymmdd-yyyymmdd.csv

※ダウンロード時に指定した期間がファイル名に入ります。

■配信一覧

管理画面

プッシュ通知＞配信一覧

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

popinfo.messagelog.yyyy-mm-dd_hh_mm.1.csv

※ダウンロードしたタイミングの日時がファイル名に入ります。

※100件ずつダウンロードされ、ファイルタイトルの最後の数字は、ページ数を示します。

101~200の範囲のcsvファイルのタイトルは、最後の数字が「２」になります。

■クーポン一覧

管理画面

クーポン＞CSVダウンロード＞クーポン一覧

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

coupons.models.Coupon.csv

■クーポン利用履歴

管理画面

クーポン＞CSVダウンロード＞クーポン一覧

ダウンロードCSVヘッダ

ダウンロードファイル名（例）

coupons.models.CouponUseHistory.yyyymm.csv

※ダウンロードした「年月」がファイル名に入ります。

■IDLink v0

管理画面
IDLink＞ID検索（IDLink v0）

ダウンロードファイル名（例）

・検索結果ダウンロード時：copula_yyyymmddhhmmss.csv
※ダウンロードした「日時」がファイル名に入ります。

ダウンロードCSVヘッダ

・全件データダウンロード時：copula.csv
ダウンロードCSVヘッダ

UUID version 4(UUID バージョン4)となり、ハイフンを含む36文字で構成されております。

FANSHIP では、性別などの属性をユーザーに設定することができます。
属性はFANSHIP が提供する汎用属性と、独自の属性がございます。ここでは、汎用属性の紹介をいたします。

※属性配信については、こちら を参照ください。

FANSHIP が提供する汎用属性は以下となります。

• 性別
• 都道府県
• 職業
• 年代
• 生年
• 生月
• 生日
• 年齢

性別

都道府県

職業

年代

生年

生月

生日

年齢

※「生年」「生月」「生日」を設定しており、ユーザーが選択してる場合、
誕生日を迎えると年齢が自動で更新されます。
※別途設定変更が必要ですので、ご利用の際はお問合せください。

属性値をどのように紐づけるか、選択いただけます。

・メリット

　本番・開発で同じカテゴリIDを利用するため、システム連携する際に向き先を気にしなくていい

・デメリット

　属性を追加、変更する場合、リアルタイムで即時どちらのアカウントにも追加される

・メリット

　本番・開発ごとにそれぞれ属性キーと値を払いだすため、運用時に、開発用で確認・テストが可能

・デメリット

　IDがアカウントごとに異なるので管理が必要

表示されるエラー：
MAPIError: E60105 (指定されたpopinfo_id のユーザーはプッシュ通知を受信しない設定になっています。

プッシュ通知を「受信しない」と設定されている際に、返却されることが多いです。
その他の原因は以下の通り。

原因
・プッシュ通知許諾がオフになっている
・状況によりサーバ側に反映されるのにタイムラグが発生したとき（許諾変更後すぐなど）
・正常な組込みができていない（token がset されていない）

参考：
管理画面のテスト受信端末で、「テスト受信端末ではありません。」と表示される
管理画面一覧の数値の反映が遅いようなのですが

可能です。
アクセス制限をご要望の場合は、営業担当かサポートへご依頼ください。

通常2営業日程度で設定可能です。
設定されているIPアドレスの確認は、お手数ですが、サポートまでお問い合わせください。
※ IP制限を行った場合、管理画面だけではなく、MAPI にも制限がかかります 

• バージョンアップはいつ行われますか？
• バージョンアップは予告されますか？
• FANSHIP 管理画面のUIは変更されますか？
• FANSHIP SDK の利用可能バージョンを教えてください。

Q. バージョンアップはいつ行われますか？

FANSHIPサービスは、サブスクリプションモデルとして提供されております。
以下目的のため、弊社が定めるタイミングで、随時サービスの更新を実施いたします。

• Apple, Google の提供する最新デバイスの機能に追従するため
• インターネット環境の状況変化に追従するため
• 新しい機能を追加するため
• 機能の最適化を行うため
• 不具合を修正するため
• その他必要な変更、修正を適用するため

Q. バージョンアップは予告されますか？

バージョンアップ等により、ご利用方法が変わる可能性がございます。
そのため、影響の大きな仕様の変更を行う場合は、原則、事前の通知を行います。

通知は、ご契約時に頂いたメールアドレスにお送りいたします。

Q. FANSHIP 管理画面のUIは変更されますか？

機能の追加等により、UIが追加・変更される可能性がございます。
その場合、原則、事前の通知を実施いたします。
ただし、追加・変更の程度を鑑み、利用者にとって十分に負担が少ないと弊社が判断する限りにおいては、特段の通知を行いません。

サポート対象のブラウザ、閲覧環境を変更する場合は、原則、事前の通知を実施いたします。

Q. FANSHIP SDK の利用可能バージョンを教えてください。

FANSHIP SDK は、バイナリ形式のライブラリファイルとして配布されております。
Apple, Google の提供する最新デバイスへの対応ポリシーは こちら をご覧ください。

カスタマイズは可能ですが、別途開発料金が必要です。

要件によって可否と、開発費用が変動しますので、まずはお問い合わせください。

ご解約希望の場合は、以下情報をご申告の上担当営業までご連絡ください。

• アプリ名
• 解約希望日

担当営業が不明な場合は、お問い合わせフォーム より、お問い合わせください。