Fello

プッシュ通知機能SDK組み込み手順書(Android)

SDKの概要

本SDKを使用することで、Androidアプリケーションに
以下のプッシュ通知機能を組み込むことができます。
また、広告の配信機能も同一のSDKに含まれているため利用可能です。
詳細は広告ネットワーク機能の利用手順を参照ください。

  • プッシュ通知の予約配信(※リモート、ローカル)

  • プッシュ通知の効果測定

  • プッシュ通知経由の起動時にゲーム側でカスタム動作(インセンティブの付与など)

  • ※多くのユーザーに一斉配信する(例:イベント開始の告知をする)にはリモートプッシュ通知を、個別ユーザーのアクションに連動して個別配信する(例:体力が全回復したことを通知する)にはローカルプッシュ通知を利用します。

最新のSDK

SDKのダウンロードから、Android向けのSDKをダウンロードしてください。

動作環境

本SDKの組み込みに対応しているAndroid OSバージョンは以下の通りです。

Android 2.3 以上

サンプルアプリの動作確認・SDK組み込み

ダウンロードしたSDK(FelloSDK_Android_{バージョン}.zip)を解凍すると以下のファイルが含まれています。

  • AdSDK_Android_{バージョン}.zip
  • PushSDK_Android_{バージョン}.zip
  • AndroidStudio_FelloSDK_Android_{バージョン}.zip

Android Studioで開発する場合

AndroidStudio_FelloSDK_Android_{バージョン}.zipを使用します。
こちらの手順に従って組み込みをしてください。

Eclipse ADTで開発する場合

PushSDK_Android_{バージョン}.zipを使用します。
こちらの手順に従って組み込みをしてください。

アプリのリリース

本SDKを組み込んだアプリをリリースする前に、必ず以下の手順を行って下さい。

  • 上記テストにて動作の確認を行う
  • 設定ファイル(fello_config.xml)のIsTestをfalseにする

    <?xml version="1.0" encoding="UTF-8"?>
    <config>
      <ApplicationId>(アプリケーションID)</ApplicationId>
      <IsTest>false</IsTest>
      <NotificationLaunchActivityPackage>(既存アプリのパッケージID)</NotificationLaunchActivityPackage>
      <NotificationLaunchActivityName>(プッシュ通知から起動されるアクティビティの名前)</NotificationLaunchActivityName>
      <NotificationTitle>(プッシュ通知に表示されるアプリ名)</NotificationTitle>
      <NotificationIcon>(プッシュ通知に表示されるアプリアイコンリソース名)</NotificationIcon>
      <EnableNotificationDialog>ダイアログを表示するときはtrue、しないときはfalseを記入してください</EnableNotificationDialog>
      <EnableMessageCenter>お知らせ管理機能を有効にするときはtrue、しないときはfalseを記入してください</EnableMessageCenter>
      <EnableDefaultNotificationSettings>プッシュ通知をデフォルトで有効にするときはtrue、しないときはfalseを記入してください</EnableDefaultNotificationSettings>
      <EnableMultipleNotification>通知領域に通知を複数表示する場合はtrue、しないときはfalseを記入してください</EnableMultipleNotification>
      <EnableStackedNotifications>複数の通知をスタック表示する場合はtrue、そうでない場合はfalseを記入して下さい</EnableStackedNotifications>
      <MessageForStackedNotifications>スタック表示時のサマリメッセージ(例:新規の通知を%d件受信しています。)</MessageForStackedNotifications>
    </config>
    
  • ProGuardの設定を行う

    Eclipseの場合、project.propertiesに以下の設定を行ってください。

    proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt

    プロジェクト直下に、proguard-project.txtを以下の内容で設置してください。

    
    -dontwarn com.unicon_ltd.konect.sdk.**
    -dontwarn com.google.android.gms.**
    -dontwarn com.squareup.**
    -dontwarn okio.**
    -keep class com.activeandroid.*** { *; }
    -keep public class com.unicon_ltd.konect.sdk.** { *; }
    -keep public class org.codehaus.**
    -keep public class java.nio.**
    

APIリファレンス

プッシュ通知機能に関して、APIのより詳細な説明を見ることが出来ます。
APIリファレンスの項目をご参照ください。

バージョン3.1.5からの変更点

  • 通知を複数受信時に通知をスタック表示するかどうかを設定できる機能を追加しました。
    fello_config.xmlのEnableStackedNotifications、MessageForStackedNotificationsを変更することで設定することが出来ます。
    詳しくはSDK組み込み手順書をご参照ください。

バージョン3.1.2からの変更点

  • Android6.0に対応しました。Android6.0から通知ポップアップ、リッチページを表示する際に
    ユーザーに権限の使用許可を得るためのAPIが追加されました。
    詳しくはAPIリファレンスの項目をご参照ください。
  • fello_config.xmlの設定で、リッチページ内のリンクをタップした際に外部ブラウザで開くかどうかを設定できるようになりました。
    fello_config.xmlのOpenLinkInBrowserを変更することで設定することが出来ます。
    これによりopenLinkInBrowser APIが非推奨となりました。
    詳しくはSDK組み込み手順書をご参照ください。

バージョン3.1.0からの変更点

  • タグ情報登録APIで、日付のタグを指定できるようになりました。
    詳しくはAPIリファレンスの項目をご参照ください。

バージョン3.0.8からの変更点

  • プッシュ通知を受信した際に呼び出されるコールバックを追加しました。
    詳しくはAPIリファレンスの項目をご参照ください。
  • 端末の通知領域に通知を複数表示するかどうかを設定できる機能を追加しました。
    fello_config.xmlのEnableMultipleNotificationを変更することで設定することが出来ます。
    詳しくはSDK組み込み手順書をご参照ください。

バージョン3.0.7からの変更点

  • SDK初期化API(initialize API)の引数に、
    プッシュ通知をデフォルトで有効にするかどうかを指定できるようになりました。
    この新しいinitialize APIを使用しプッシュ通知の設定を行った場合、fello_config.xmlで指定している
    EnableDefaultNotificationSettingsの設定は無視されますのでご注意ください。
    詳しくはAPIリファレンスの項目をご参照ください。
  • SDKの初期化処理、プッシュ通知サーバーへの端末登録処理が完了し
    各種API実行の準備ができた時点で呼び出されるコールバックを追加しました。
    変更内容についてはAPIリファレンスの項目をご参照ください。

バージョン3.0.6からの変更点

  • アプリ終了時に呼び出すことで、SDK内で保持しているリソースを開放するAPIを追加致しました。
    詳しくはAPIリファレンスの項目をご参照ください。
  • お知らせ管理機能のAPIを一部非推奨に変更しました。
    変更内容についてはAPIリファレンスの項目をご参照ください。
  • プッシュ通知を初期状態で受信するかどうかを設定できる機能を追加しました。
    fello_config.xmlのEnableDefaultNotificationSettingsを変更することで設定することが出来ます。
    詳しくはSDK組み込み手順書をご参照ください。

バージョン3.0.0からの変更点

  • お知らせ管理機能を追加しました。バージョン3.0.0以前からバージョンアップする際はfello_config.xmlへお知らせ管理機能を使用するかどうかの設定追加が必要です。

バージョン2.4.0からの変更点

  • 広告ネットワーク機能がGoogle Play Service対応端末向けのチェックをするため、Google Play Serviceのライブラリを追加しました。 バージョン2.4.0以前からバージョンアップする際はgoogle-play-services_libプロジェクトをFelloPushSdkプロジェクトとともにImportして下さい。

バージョン2.2.0からの変更点

  • ローカルプッシュ機能を追加しました。バージョン2.2.0以前からバージョンアップする際はAndroidManifest.xmlにKonectLocalNotificationsReceiverの登録を追加して下さい。

バージョン2.0.0からの変更点

  • GCMIntentServiceの実装は不要になりました。バージョン2.0.0以前からバージョンアップする際はGCMBaseIntentServiceクラスを削除して下さい。