Notiphi Android SDK
Notiphi SDK (www.notiphi.com) allows you to monetise your Android apps (2.3.3 and above) by receiving contextual notifications. This guide will help you integrate it in a few minutes. Following steps outline the integration process.
- Clone the github repository or download the zipped file.
- Add SDK jar files to libs folder.
- Set the SDK “Token and Secret” in Your project's string.xml file.
- Configure SDK settings in the Your project's AndroidManifest.xml file.
- Initialize the SDK in the MainActivity class.
- Passing Information to SDK.
- Handling Client payload
Notiphi permission requirements
####Setup
Clone this repository
git clone https://github.com/Notiphi/android-sdk.git
or download the zipped package.
wget https://github.com/Notiphi/android-sdk/archive/master.zip
Unzip the files (if downloaded as a zip). Add the files NotiphiSDK.jar in jars directory to your project path. If you are using Eclipse then you could use the following steps if you are unfamiliar with the process of adding jar files.
Copy NotiphiSDK.jar, android-async-http-1.4.3.jar and gcm.jar the jar file from jars directory and paste it into libs directory of your project.
####Set the SDK “Token and Secret” in Your project's string.xml file.
Go to your project's root folder and open res folder. Then open values folder. Here you should find strings.xml file. Add the following line to it. The app_token and app_secret is provided by us on registration of your app with us. As of now there is no online process and you need to contact us at dev-support@notiphi.com to get these.
<string name="notiphi_app_token">TOKEN_GIVEN_BY_NOTIPHI_SEPARATELY</string>
<string name="notiphi_app_secret">APP_SECRET_GIVEN_BY_NOTIPHI_SEPARATELY</string>
If you are already sending your own push notifications then slight more configuration is required. Please add the following line to string.xml file of your project
<string name="vendor_gcm_sender_id" translatable="false">YOUR_GCM_SENDER_ID </string>
Apart from this please change the way you are making the call to register for GCM device tokens in your java file.
a) GCM using gcm.jar
GCMRegistrar.register(context, YOUR_GCM_SENDER_ID + "," + Constants.GCM_SENDER_ID);
b) GCM using Google Play Service.
gcm.register(YOUR_GCM_SENDER_ID+","+Constants.GCM_SENDER_ID);
####Configure SDK settings in the Your project's AndroidManifest.xml file.
After adding the JARs into your project, modify your AndroidManifest.xml file using these steps:
- Android Version: Set the minimum android SDK version to 10 or higher. Notiphi library will not work if minimum android SDK version is less than 10.
<uses-sdk android:minSdkVersion="10" />
- Permissions: Following permission are required in manifest file for library to work properly. So please declare the following permission in AndroidManifest.xml and replace the occurrence of YOUR_PACKAGE_NAME by your application's package name.
<permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE"
android:protectionLevel="signature" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.VIBRATE"/>
<uses-permission android:name="com.google.android.gms.permission.ACTIVITY_RECOGNITION"/>
- Notiphi Activity : Add following tag which enables to open Webview within your Application.
<activity android:name="com.notikum.notifypassive.utils.NotiphiWebView" />
- Notiphi Service and Receivers: Please add the following xml fragment into AndroidManifest.xml under tag and replace YOUR_PACKAGE_NAME with your application’s package name
<receiver android:name="com.notikum.notifypassive.receivers.LocationAlertReceiver"
android:enabled="true"
android:exported="true">
</receiver>
<receiver android:name="com.notikum.notifypassive.receivers.BootCompleteReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
</intent-filter>
</receiver>
<receiver android:name="com.notikum.notifypassive.receivers.NotiphiGCMMessageReceiver"
android:permission="com.google.android.c2dm.permission.SEND">
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE"/>
<action android:name="com.google.android.c2dm.intent.REGISTRATION"/>
<category android:name="YOUR_PACKAGE_NAME"/>
</intent-filter>
</receiver>
<receiver android:name="com.notikum.notifypassive.receivers.NotiphiGCMBroadCastReceiver"
android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<category android:name="com.example.notiphijartest" />
</intent-filter>
</receiver>
<receiver android:name="com.notikum.notifypassive.receivers.NetworkStateChangeReceiver">
<intent-filter >
<action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
</intent-filter>
</receiver>
<receiver android:name="com.notikum.notifypassive.receivers.InstallReferrerReceiver"
android:exported="true" >
<intent-filter>
<action android:name="com.android.vending.INSTALL_REFERRER" />
</intent-filter>
</receiver>
<service android:name="com.notikum.notifypassive.services.GCMIntentService"></service>
<service android:name="com.notikum.notifypassive.services.NotiphiService"></service>
<service android:name="com.notikum.notifypassive.services.GCMInformService"></service>
<service android:name="com.notikum.notifypassive.NewApiActivityRecognization"></service>
<service android:name="com.notikum.notifypassive.NotiphiClusterSyncIntentService"></service>
<service android:name="com.notikum.notifypassive.services.DiscardedNotificationService"></service>
<service android:name="com.notikum.notifypassive.services.NotificationInformService" > </service>
<service android:name="com.notikum.notifypassive.services.SendBulkDataIntentService"></service>
-
Reference Google Play Services Library: In eclipse goto File -> New -> Other and from the list select "Android Project from Existing Code" then select androidsdk -> extras -> google -> google_play_services -> libproject directory and click Ok .
Now select your project, right click then select properties -> android, click add and select the above library then click ok.
-
meta data for Google play service : Add below meta data tag into your AndroidManifest.xml file inside tag.
<meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
####Initialize the SDK In the MainActivity class.
After the configuration changes, in your main Activity of your application add this import statement
import com.notikum.notifypassive.NotiphiSession;
Inside the onCreate method of your Main Activity, add the following lines of code.
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
Context context = this;
try {
NotiphiSession.init(context, 1);
} catch (Exception e) {
}
}
@Override
protected void onPause() {
super.onPause();
NotiphiSession.appFocusChange();
}
We provide the way to capture user event from your app so that we can identify potential and interested users for your business
To capture event create a json object and add information in key and value format
Help code snippet below.
JSONObject jsonObject = new JSONObject();
jsonObject.put(key, value);
jsonObject.put(key, value);
Once json object is packed with data , call the below method and pass json obejct and context of the application
new NotiphiEventReceiver(jsonObject, context);
You are done with event capture implementation, now events from your app will be captured.
####Handling Client payload
To launch the activity with an intent containing the message client payload. Set up a notification recipient activity class (we'll provide this activity through our Dashboard) that launch when the notificatoin recieve a tap.
String mClientPayload = getIntent().getStringExtra("client_data");
make sure you have this activty in your AndroidManifest.xml file.
####Notiphi permission requirements
Our SDK requires the following permissions in order to function correctly. We have outlined the reasons why we need each of these permissions.
#####Must have permissions
"YOUR_PACKAGE_NAME.permission.C2D_MESSAGE”
“YOUR_PACKAGE_NAME.permission.C2D_MESSAGE"
android:protectionLevel="signature"
|
#####Good to have permissions (Optional)
<tr>
<td>"android.permission.VIBRATE"
</td>
<td>Required to vibrate the device
when a message is received.
</td>
</tr>
<tr>
<td>"com.google.android.gms.permission.ACTIVITY_RECOGNITION"
</td>
<td>Required to detect your current physical
activity such as walking or driving.
</td>
</tr>
This library owes its existence to the hard work of @Notiphi Team.
Having trouble with integration? Please contact us at dev-support@notiphi.com and we’ll help you sort it out in a jiffy.
Add the permissions explanation.