Push Notification Module

Customization of the Notification Area

RelatedDigital.setIsPushNotificationsEnabled() has 5 mandatory and 8 optional parameters.

Mandatory parameters:

context: Context
isPushNotificationEnabled: Boolean
googleAppAlias: String
huaweiAppAlias: String
token: String

Optional Parameters:

notificationSmallIcon: Int
notificationSmallIconDarkMode: Int
isNotificationLargeIcon: Boolean
notificationLargeIcon: Int
notificationLargeIconDarkMode
notificationPushIntent: String
notificationChannelName: String
notificationColor: String

Optional Parameters	Description
`notificationSmallIcon`	For entering the icon that is going to be shown in the status bar and the left top corner of the notification area. You should enter the ID of a resource in your project. Default Value : Application icon
`notificationSmallIconDarkMode`	For entering the `notificationSmallIcon` value when the device is in dart theme mode. Default Value : Application icon
`isNotificationLargeIcon`	For determining if there is going to be a large icon in the right of the notification area. Default Value : false (no large icon)
`notificationLargeIcon`	For entering the large icon that is going to be shown in the right of the notification area. You should enter the ID of a resource in your project. Default Value : Application icon (if `isNotificationLargeIcon` is true)
`notificationLargeIconDarkMode`	For entering the `notificationLargeIcon` value when the device is in dart theme mode. Default Value : Application icon (if `isNotificationLargeIcon` is true)
`notificationPushIntent`	For entering the activity that is going to be triggered when the notification is clicked. You should enter the full path of the activity. Default Value : launcher activity
`notificationChannelName`	For entering the name of the notification channel. Default Value : Application name
`notificationColor`	For entering the accent color value that is going to be used in the notification area.

An example use that includes all parameters is below:

Kotlin

RelatedDigital.setIsPushNotificationEnabled(
  context = context,
  isPushNotificationEnabled = true,
  googleAppAlias = "googleAppAliasValue",
  huaweiAppAlias = "huaweiAppAliasValue",
  token = token,
  notificationSmallIcon = R.drawable.text_icon,
  notificationSmallIconDarkMode = R.drawable.text_icon_dark_mode,
  isNotificationLargeIcon = true,
  notificationLargeIcon = R.mipmap.ic_launcher,
  notificationLargeIconDarkMode = R.mipmap.ic_launcher,
  notificationPushIntent = "com.relateddigital.androidexampleapp.PushNotificationActivity",
  notificationChannelName = "relateddigital-android-test",
  notificationColor = "#d1dbbd"
)

Java

RelatedDigital.setIsPushNotificationEnabled(
  context,
  true,
  "googleAppAliasValue",
  "huaweiAppAliasValue",
  token,
  R.drawable.text_icon,
  R.drawable.text_icon_dark_mode,
  true,
  R.mipmap.ic_launcher,
  R.mipmap.ic_launcher,
  "com.relateddigital.androidexampleapp.PushNotificationActivity",
  "relateddigital-android-test",
  "#d1dbbd"
);

Token-User Match

The information about the user can be sent in signUp/Login stage or after to our servers. If there is a user in the server whose information is the same, the related token will be matched to this user.

After sending the mandatory and optional parameters, you should call sync() method.

Kotlin

--Mandatory parameters--
RelatedDigital.setEmail(context, "test@euromsg.com")
RelatedDigital.setRelatedDigitalUserId(context, "testRelatedDigitalUserId")

--Optional parameters--
RelatedDigital.setEmailPermit(context, EmailPermit.ACTIVE)
RelatedDigital.setGsmPermit(context, GsmPermit.ACTIVE)
RelatedDigital.setTwitterId(context, "testTwitterId")
RelatedDigital.setFacebookId(context, "testFacebookId")
RelatedDigital.setPhoneNumber(context, "testPhoneNumber")
RelatedDigital.setUserProperty(context, "instagram", "testInstagramId")

RelatedDigital.sync(context)

Java

--Mandatory parameters--
RelatedDigital.setEmail(context, "test@euromsg.com");
RelatedDigital.setRelatedDigitalUserId(context, "testRelatedDigitalUserId");

--Optional parameters--
RelatedDigital.setEmailPermit(context, EmailPermit.ACTIVE);
RelatedDigital.setGsmPermit(context, GsmPermit.ACTIVE);
RelatedDigital.setTwitterId(context, "testTwitterId");
RelatedDigital.setFacebookId(context, "testFacebookId");
RelatedDigital.setPhoneNumber(context, "testPhoneNumber");
RelatedDigital.setUserProperty(context, "instagram", "testInstagramId");

RelatedDigital.sync(context);

When Push Notification Module is enabled via RelatedDigital.setIsPushNotification(), the token information is written to RMC servers. This token is saved as “anonymous”. In order to match this token with a user, an identifier information for the user (KEY_ID or EMAIL) should be sent to RMC.
RelatedDigital.setIsPushNotification() metodu aracılığıyla Push Notification Modülü etkinleştirildiğinde, cihaza ait token bilgisi RMC veri tabanına yazılır. Bir token; kullanıcı uygulamada oturum açana kadar “anonim” yani hiç bir kullanıcı ile eşleştirilmeden kaydedilir. Bu token ın bir kullanıcıyla eşleştirilebilmesi için uygulamada oturum açılmış olması ve SDK tarafından bu token ın sahibini tanımlayıcı bir bilginin (KEY_ID yada EMAIL) RMC'ye gönderilmesi gerekir. Bu bilgiler push mesajı payload unda "extra" : {} bloğunda yer alır.

In order the data that you sent to be loaded to RMC panel correctly, you should use the same reference value (KEY_ID* veya E-Mail) that you use in your RMC account when sending data via mobile channel.

*KEY_ID: It is the ID that you use to make a user unique in your system like CRM id, userId, customerId, accountId.

"extra" : {
  "email" : "test@euromsg.com",
  "keyID" : "testRelatedDigitalUserId"
}

IYS E-Mail Registration (For Turkey)

Kotlin

val callback: EuromessageCallback = object : EuromessageCallback {
  override fun success() {
    Log.i("IYS Kaydı", "Successful")
  }

  override fun fail(errorMessage: String?) {
    Log.e("IYS Kaydı", "Fail : $errorMessage")
  }
}

RelatedDigital.registerEmail(
  context = context,
  email = "test@euromsg.com",
  emailPermit = EmailPermit.ACTIVE,
  isCommercial = false,
  callback = callback
)

Java

EuromessageCallback callback = new EuromessageCallback() {
  @Override
  public void success() {
    Log.i("IYS Kaydı", "Successful");
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("IYS Kaydı", "Fail : " + errorMessage);
  }
};

RelatedDigital.registerEmail(
  context,
  "test@euromsg.com",
  EmailPermit.ACTIVE,
  false,
  callback
);

If your customer is a corporate, you should send isCommercial parameter as true.

If you do not see a user match in RMC, please get in contact with RMC support team and ask to activate the FLAG of the related appKey.

Push Notification Click Report and Directing

When the user clicks on the notification the activity that you entered via RelatedDigital.setPushIntent() is going to be launched. You should send the click report and direct the user to the related page here in onNewIntent().

Kotlin

override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    if (intent != null) {
        val bundle = intent.extras
        if (bundle != null) {
            val message = intent.extras!!.getSerializable("message") as Message?
            if (message != null) {
                //Send the click report
                RelatedDigital.sendPushNotificationOpenReport(this, message)
                //Direct the user to the related page - message.url
                ..
            } else {
                // It shows that a carousel notification is came and the user clicked on an item
                val itemClickedUrl = bundle.getString("CarouselItemClickedUrl")
                if (itemClickedUrl != null && itemClickedUrl != "") {
                    //Direct the user to the related page - itemClickedUrl
                    ..
                }
            }
        }
    }
}

Java

@Override
protected void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    if(intent != null) {
        Bundle bundle = intent.getExtras();
        if (bundle != null) {
            Message message = (Message) intent.getExtras().getSerializable("message");
            if(message != null) {
                //Send the click report
                RelatedDigital.sendPushNotificationOpenReport(this, message);
                //Direct the user to the related page - message.url
                ..
            } else {
                // It shows that a carousel notification is came and the user clicked on an item
                String itemClickedUrl = bundle.getString("CarouselItemClickedUrl");
                if(itemClickedUrl != null && !itemClickedUrl.equals("")) {
                    //Direct the user to the related page - itemClickedUrl
                    ..
                }
            }
        }
    }
}

You should check the pro-guard issues in your project if you get notification in debug mode but not in release mode.

proguard-rules.pro 'ya aşağıdaki kodları ekleyebilirsiniz;

-keep class com.relateddigital.**{*;}

Custom Notification Sound

You should add the sound files that is going to be used into your project first.

res/raw/my_custom_sound.mp3

After that, go to RMC panel Settings / Campaign Settings / Push Applications / Your Android Application / Custom Sound File

You should enter the name of the sound file without extension to this field.

Campaign Revenue on the Panel

In order to see the revenue as a result of a notification campaign on RMC:

You should enter the utm parameters onto the field of Custom Parameters when creating a push notification campaign.

Example: utm_medium=apppush;utm_source=related;utm_campaign=campaign_name

You can use the campaign ID as utm_campaign since it has to be different each time. For this, you can use <##CAMP_ID##> variable.

Push Message History

You can have the push messages sent in the last 30 days as shown below.

The messages are ordered according to date. The latest message sent is going to be at the beginning of the list.

Kotlin

val pushMessageInterface: PushMessageInterface = object : PushMessageInterface {
  override fun success(pushMessages: List<Message>) {
    // You can write your code here by using pushMessages
  }

  override fun fail(errorMessage: String) {
    Log.e("Past Notifications", errorMessage)
  }
}

RelatedDigital.getPushMessages(activity, pushMessageInterface)

Java

PushMessageInterface pushMessageInterface = new PushMessageInterface() {
  @Override
  public void success(List<Message> pushMessages) {
    // You can write your code here by using pushMessages
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("Past Notifications", errorMessage)
  }
};

RelatedDigital.getPushMessages(activity, pushMessageInterface);

Bildirim Mesajı İçeriği

Veri Tipi	Değişken	Açıklama
String	mediaUrl	Photo, video url
String	altUrl	Alternate URL
String	campaignId	Campaign ID
String	pushId	Notification ID
String	url	Campaign URL
String	message	Notification Message
String	title	Notification Title
String	sound	Notification Sound
PushType	pushType	Notification Type
Map<String, String>	params	Custom Parameters

Extra Notes

EXTERNAL_STORAGE Permissions

You should add the line below into AndroidManifest.xml file under <application tag if you use WRITE_EXTERNAL_STORAGE and READ_EXTERNAL_STORAGE permissions in your application.

android:requestLegacyExternalStorage="true"

PUSH_SUBSCRIPTION_PERMISSION_ENABLED

If you want to transfer the logged-in users in your push application to Euromessage user panel directly, you can ask RMS Support Team to enable PUSH_SUBSCRIPTION_PERMISSION_ENABLED flag.

Example Application

RelatedDigital Example Application