ディープリンク連携（サーバープッシュ通知）

Live Operationのサーバープッシュ通知では、ディープリンク機能を対応しております。

ディープリンク機能は、ユーザーがプッシュ通知を受信して開封した際、ディープリンクデーターより定義されたアクションを実行するようになる機能です。

ディープリンクデータは、ライブオペレーションの管理画面より生成・管理します。タイプは以下の3つのタイプで登録することが出来ます。

ディープリンク機能は、Androidの onNewIntent 関数をOverdriveしてディープリンクタイプに沿い実装してください。

public class MainActivity extends Activity{ 
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		// TODO Auto-generated method stub
		super.onCreate(savedInstanceState);
 
		IgawCommon.startApplication(this);
		IgawCommon.setUserId("userid_123123123");
		IgawLiveOps.initialize(MainActivity.this);
 
		//onNewIntent リスナーで intentを渡します。
		onNewIntent(getIntent());
	}
 
	@Override
	protected void onNewIntent(Intent intent) {
		super.onNewIntent(intent);
		/* ディープリンクタイプに沿い、以下を参考して実装します。 */
 
		/* 1. アプリスキームタイプ(myApp://deepLinkAction)ディープリンクの実装
		 * 
		 * ディープリンクで渡されたアプリスキームアクションを起動します。
		 * IgawLiveOps.onNewIntent(MainActivity.this, intent);
		 */
 
		/* 2. Json文字列タイプ({“url”:”deepLinkAction”}) ディープリンクの実装
		 * 
		 * ディープリンクで渡された Json 文字列を抽出し、Json オブジェクトに変換します。
		 * String jsonStr = intent.getStringExtra("com.igaworks.liveops.deeplink");
		 * JSONObject jsonObj;
		 * try {
		 *     jsonObj = new JSONObject(jsonStr);
		 *     //Json オブジェクトをPassingしてアクションを起動するように実装します。
		 * } catch (Exception e) {
		 *     // TODO: handle exception
		 * }
		 */
	}
}

<!-- IgawLiveOpsPushMessageLauncherActivity を追加します。 -->
<activity 
	android:name="com.igaworks.liveops.pushservice.IgawLiveOpsPushMessageLauncherActivity" 
	android:permission="MY_PACKAGE_NAME.permission.C2D_MESSAGE"
	android:noHistory="true"/> 


<!-- ディープリンクを適用する Activityに適用します。 -->
<activity android:name="com.example.DeeplinkActivity">
	<intent-filter>
	<data android:scheme="myApp" android:host="activity.com" />
		  <action android:name="android.intent.action.VIEW" />
      		  <category android:name="android.intent.category.DEFAULT" />
      		  <category android:name="android.intent.category.BROWSABLE" />
	</intent-filter>            
</activity>

---

クライアントプッシュ通知

Live Operationは、クライアントでAPIを利用して直接生成して利用できるクライアントプッシュ通知機能を提供します。

一般のクライアントプッシュ通知は、アプリ内で事前に指定した条件にユーザーが一致する時、プッシュを作成して表示します。

また、デベロッパーサーバーとアプリ間の通信が可能であれば、サーバーイベントをキャッチしてプッシュを作成するような方法でもご利用することができます。

　　一般クライアントプッシュ通知

　　クライアントプッシュ通知には、一般プッシュ通知とビックテキストプッシュ通知がございます。

　　一般のクライアントプッシュ通知は、基本的にテキストで構成されたプッシュです。

　　setNormalClientPushEvent APIを利用して、プッシュ通知の作成及び表示ができます。

ビックテキストクライアントプッシュ通知

ビックテキストクライアントプッシュ通知は、最大160字(日本語、英語共通)までのテキストを対応するプッシュ通知です。

また、Amdroidのアプリで表現できるhtml 形式を対応しています。(太字、下線、フォント色など)

setBigTextClientPushEvent APIを利用して、プッシュ通知の作成及び表示をすることができます。

+ プッシュ通知の表示方法

プッシュ通知のタイプ、AndroidのOSバージョン、プッシュ通知のメッセージバーの状態により、

プッシュ通知が表示される方法が異なる場合がございます。詳細については、以下のガイドをご確認ください。

「Live Operationプッシュ通知ガイド」

• user_group : 管理画面で確認できるユーザーグループ名

• data : ユーザーグループで登録するObjectタイプのユーザーデータ。bool, int, long, float, Stringを対応します。

追加したユーザーグループは、Live Operation管理画面で確認することができます。またクライアントプッシュ通知では利用することができません。

ターゲティングデータの同期化

resume api を呼び出し、設定されたターゲティングデータをライブオペレーションサーバーと同期化します。アクティビティの OnApplicationPause() に以下のように追加します。

手動同期化

データ同期化を手動でアップデートするためには、flushTargetingData apiを呼び出して設定したターゲティングデータをLive Operationサーバーと同期化します。

デリゲートの利用 (depreciated v.1.3.2)

送信するプッシュ通知に対して、受信可否イベントのデリゲートを提供します。

enableServiceWithDelegate APIを呼び出して利用します。パラメータと利用例は以下となります。

プッシュ通知のアイコンイメージの修正

ターゲットプッシュ通知で利用するプッシュ通知アイコンのイメージは、Launcher Iconで登録したアプリアイコンのイメージを利用します。

Googleのフィーチャーのためにイメージ修正が必要な場合、setNotificationIconStyle apiを呼び出してイメージを変更することができます。

+ IgaworksUnityPluginAOS.LiveOps.initialize api の次に呼び出します。

+ イメージファイル名は、イメージファイル拡張子を除いたファイル名のみ入力します。

+ 全解像度のDrawableフォルダに適切なイメージを追加してください。

通知設定

Android 5.0以上ではヘッドアップ(heads-up)通知とロック画面通知を設定することができます。

ヘッドアップ通知は端末がアクティブな場合に通知を表示する機能です。ロック画面通知は通知をロック画面に表示する機能です。

詳細についてはAndroid Developersの通知に関するガイド(こちら)をご覧ください。

setNotificationOption apiを呼び出してヘッドアップ・ロック画面通知を設定します。 

ヘッドアップ通知の設定 (priority)

• PRIORITY_MAX (int:2), ヘッドアップ通知を使用
• PRIORITY_HIGH (int:1),ヘッドアップ通知を使用
• PRIORITY_DEFAULT (int:0), ヘッドアップ通知を使用しない
• PRIORITY_LOW (int:-1), ヘッドアップ通知を使用しない
• PRIORITY_MIN (int:-2), ヘッドアップ通知を使用しない

ロック画面通知の設定 (visibility)

• VISIBILITY_SECRET (int:-1), ロック画面通知を使用しない
• VISIBILITY_PRIVATE (int:0), 通知内容を表示せずロック画面通知を使用
• VISIBILITY_PUBLIC (int:1), 全体内容を表示してロック画面通知を使用

// void setNotificationOption(int priority, int visibility)
IgaworksUnityPluginAOS.LiveOps.setNotificationOption(IgaworksUnityPluginAOS.AndroidNotificationPriority.PRIORITY_HIGH, IgaworksUnityPluginAOS.AndroidNotificationVisibility.VISIBILITY_PUBLIC);

+ ロック画面通知はユーザーのデバイス設定が「敏感な内容は隠す」で設定されている場合に起動します。

+ ロック画面通知はロック画面に関するアプリを利用する場合正常に起動しない場合がございます。

通知のまとめ (InboxStyle)

複数の通知を一つのまとめた通知で合わせます。Inbox Styleは、サーバープッシュ通知のみ対応します。

(*クライアントプッシュ通知の場合、通知IDの把握ができないためInbox Styleを対応しません。)

setStackingNotificationOption apiを呼び出して設定します。 

通知まとめの設定 (useStacking)

• true : 通知まとめ機能を利用します。
• false : 通知まとめ機能を使用しません。

通知まとめの表示設定 (useTitleForStacking)

• true : 通知まとめを開く際にタイトルを表示します。
• false : 通知まとめを開く際に内容を表示します。

まとめた通知のタイトル、内容の設定 (ContentTitle, ContentText)

• empty :  最新の通知のタイトルと内容を表示します。
• your_custom_message : apiで呼び出したタイトルと内容を表示します。

まとめた通知を開く際に表示するタイトルの設定 (bigContentTitle)

• empty : ContentTitleを表示します。
• your_custom_message : apiで呼び出したタイトルを表示します。

まとめた通知を開く際の内容の設定 (bigContentSummaryText)

• empty : コンテンツのサマリーを使用しません。
• your_custom_message : apiで呼び出した内容を表示します。

//void setStackingNotificationOption(bool useStacking, bool useTitleForStacking, string ContentTitle, string ContentText, string bigContentTitle, string bigContentSummaryText)
IgaworksUnityPluginAOS.LiveOps.setStackingNotificationOption(true, false, "More events are waiting for you", "See detail", "All events", "For Summary Text");