Live Operation:ポップアップメッセージ
Live Operationのポップアップメッセージ機能は、ユーザーに公表するお知らせや情報などを、
ポップアップ型のメッセージ画面を利用して表示するサービスです。
ポップアップメッセージを利用して、実施しているイベントや新規機能のリリースなどの案内を行うことができます。
ご注意
- Live OperationのAdd-onを連携する前に、IGAW基本連携を完了してください。「IGAW基本連携:Unity Android」
- Live Operationの連携のために、IgawLiveOps~*_thirdparty.jar ファイルをUnityプロジェクトに追加してください。「SDKインストール:Unity」
ポップアップ初期化API
ポップアップメッセージサービスを利用するために、以下のステップに沿い初期化を完了します。
以下の初期化APIは、アプリ起動時に呼び出されることをおすすめします。
ユーザー識別値の入力
ユーザー識別値は、 Live Operationでユーザーを判別するために利用する情報です。
ご注意
- 1名のユーザーにつき1つの児湯な識別値を持つ必要がございます。可変値を利用しないでください。
- 個人情報(メールアドレス、名前、電話番号、識別できるユーザーIDなど)を含めてはいけません。
- 日本語、特殊文字、空白などが含まれている場合、必ずURL encording処理を行ってから利用してください。
- requestPopupResource APIが呼び出される前に設定してください。
上記の注意事項をご確認の上、ユーザー識別値を入力します。
IgaworksUnityPluginAOS.Common.setUserId("user10001");
ポップアップデータのロード
requestPopupResource APIを呼び出して、Live Operation管理画面で設定したポップアップデータをロードします。
データロードをする前に、ユーザー識別値の設定を完了してください。
ご注意
- ユーザー識別値が入力されていない場合、ポップアップデータのロードができません。
- データロードが出来ない場合、管理画面上で新しいメッセージを追加したとしてもSDKでは確認できなくなります。
上記の注意事項のご確認の上、データをロードします。
IgaworksUntiyPluginAOS.LiveOps.requestPopupResource();
ポップアップ表示API
showPopUp APIを呼び出し、ポップアップを表示したい地点でポップアップ型のメッセージを表示します。
ポップアップ上で表示される内容は、管理画面上で設定した数値である必要があります。
以下の例は、showPopupNotiBtnボタンをクリックした際、ポップアップを表示することを想定して作成しました。
void OnGUI() {
//ポップアップを表示します。
if(GUI.Button (new Rect(100,100,200,200), "showPopupNoti")) {
IgaworksUnityPluginAOS.LiveOps.showPopUp("ポップアップスペースキー");
}
}
+ ポップアップスペースキーは、「Live Operation > ポップアップメッセージ > メッセージ登録 > ポップアップスペースの追加」より発行してください。
ポップアップのディープリンク
ポップアップのディープリンク機能を利用して、ポップアップを通じた様々なアクションの起動を処理することができます。
void Start() {
//ディープリンクデリゲートの設定
IgaworksUnityPluginAOS.OnReceiveDeeplinkData = mOnReceiveDeeplinkData;
}
//ディープリンクデリゲートの実装
void mOnReceiveDeeplinkData(string deeplink) {
//渡されたディープリンクデータを利用してアクションを起動するように実装します。
Debug.Log("deep link data :::: " + deeplink);
}
+ ディープリンクは、「Live Operation > 設定 > プッシュ通知・ポップアップメッセージ設定 > ディープリンク」より登録することができます。
+ ディープリンクは、Jsonタイプを対応しています。
ポップアップメッセージのユーザーターゲティング
ユーザーグループを設定して、メッセージの表示対象を直接選ぶことができます。
ユーザーグループを設定するためのデータは直接設定することができます。
ターゲティングデータの設定
ターゲティングしたユーザーのみメッセージを表示するため、カスタムユーザーデータを設定することができます。
設定したカスタムユーザーデータは、「Live Operation > 設定 > ユーザーブラウザの設定」より確認することができます。
以下の例は、課金回数をカスタムデータとして取得する場合です。
//IgaworksUnityPluginAOS.LiveOps.setTargetingData(string customUserDataKey, string customUserData);
IgaworksUnityPluginAOS.LiveOps.setTargetingData("purchaseCount", purchaseCount);
+ customUserData : ターゲティングのためのユーザーデータを入力します。bool, int, long, float, stringを対応します。
+ customUserDataKey : ユーザーカスタムデータキーを設定します。
ターゲティングデータの同期化
resume APIを呼び出して設定したターゲティングデータを、Live Operationサーバーと同期化します。
同期化したい地点やアプリのステータスが変更される地点に設定します。
//アプリのステータスをチェック
void OnApplicationPause(bool pauseStatus){
if (pauseStatus) {
Debug.Log ("go to Background");
} else {
Debug.Log ("go to Foreground");
//ターゲティングデータの同期化
IgaworksUnityPluginAOS.LiveOps.resume();
}
}
ポップアップメッセージ:追加オプション
ポップアップイベントリスナー
ポップアップで発生するクリックイベントに対するリスナーを提供します。
- OnLiveOpsCancelPopupBtnClick : ポップアップを閉じるイベント
- OnLiveOpsPopupClick : ポップアップをクリックしたイベント
setLiveOpsPopupEventListener APIを利用してイベントリスナーを登録・実装します。
void Start () {
IgaworksUnityPluginAOS.LiveOps.setLiveOpsPopupEventListener ();
IgaworksUnityPluginAOS.OnLiveOpsCancelPopupBtnClick = mOnLiveOpsPopupCancel;
IgaworksUnityPluginAOS.OnLiveOpsPopupClick = mOnLiveOpsPopupClick;
}
void mOnLiveOpsPopupCancel(){
Debug.Log("PopupCancel :::: call");
}
void mOnLiveOpsPopupClick(){
Debug.Log("PopupClick :::: call");
}
ポップアップの強制終了
ユーザーのクリックイベント無しで、APIを利用して動的にポップアップメッセージを終了処理することができます。
表示中のポップアップを終了
destroyPopup APIを呼び出して、現在表示されている最上位のポップアップを終了処理します。
IgaworksUnityPluginAOS.LiveOps.destroyPopup ();
全体のポップアップを終了
destroyAllPopups APIを呼び出して、現在表示されている最上位のポップアップを含め、待機中のポップアップを全て終了処理します。
IgaworksUnityPluginAOS.LiveOps.destroyAllPopups ();