Euromessage Android SDK Kurulumu

Bu sayfada:

1 Adım 1 - Gerekenler
2 Adım 2 - Bağımlılıkları Eklemek
3 Adım 3 - Android Manifest'e Kodları Eklemek
4 Adım 4 - Gerekli Kodları Eklemek
- 4.1 Bildirim İzni İsteme
5 Adım 5 - Token Kullanıcı Üye Eşleşmesi
6 Adım 6 - IYS E-Posta Kaydı
7 Adım 7 - Okundu Raporu ve Yönlendirme
8 Öneri

Adım 1 - Gerekenler

Android mobil uygulama & Android Studio

Firebase Cloud Messaging ve Huawei Push Kit - google_services.json & agconnect_services.json

RMC Hesabı - AppAlias

Minimum 21 API Level Test Cihazı

Adım 2 - Bağımlılıkları Eklemek

2.1 app/build.gradle (Module: app) açıp aşağıdaki kod blogunu ekleyiniz.

dependencies {
		implementation 'com.github.relateddigital:euromessage-android:$euromessage_version'
	}

apply plugin: 'com.huawei.agconnect'
apply plugin: 'com.google.gms.google-services'

2.2 project / build.gradle'i açıp aşağıdaki kod blogunu ekleyiniz.

buildscript {
    repositories {
        google()
        jcenter()
        maven {url 'http://developer.huawei.com/repo/'}
    }

dependencies {
        classpath "com.android.tools.build:gradle:$gradle_version"
        classpath 'com.google.gms:google-services:$google_version'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.huawei.agconnect:agcp:$huawei_version'
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven {url 'http://developer.huawei.com/repo/'}
        maven { url 'https://jitpack.io' }
    }
}

Adım 3 - Android Manifest'e Kodları Eklemek

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Bu tanımlamalar sayesinde gelen FCM ve HMS'den gelen push bildirimleri Euromessage tarafından karşılanacaktır. Uygulamanızın Application Class - eğer yoksa - tanımlamanız gerekebilir. Burada yapmanız gereken yeni bir class oluşturup Application Class’tan extend etmek ve AndroidManifest dosyasında bunu tanımlamak olacaktır;

Eğer WRITE_EXTERNAL_STORAGE ve READ_EXTERNAL_STORAGE izinlerini uygulamanızda kullanıyorsanız aşağıdaki satırı AndroidManifest.xml dosyanıza <application tag ı içerisine eklemeniz gerekmektedir.

Adım 4 - Gerekli Kodları Eklemek

Bildirim İzni İsteme

Uygulama ilk açıldığında kullanıcıdan izin istemek için aşağıdaki kodu kullanabilirsiniz.

Aşağıda örnek bir implementasyon görülmektedir; Bunun için FIREBASE_APP_ALIAS ve HUAWEI_APP_ALIAS'ı RMC panel üzerinden tanımlamanız gerekmektedir.

4.1 Firebase Messaging Servis'te Token Toplama

EuroFirebaseMessagingService onNewToken() methodu içerisinde ilk kez açılan bir uygulama için token'i alır ve subscribe eder.

Daha önceden sahip olduğunuz token'ları EuroMobileManager'a setlemek için aşağıdaki kodları eklemeniz gerekmektedir

4.2 Huawei Messaging Servis'te Token Toplama

Huawei'de telefonun EMUI sürümüne göre token toplama yöntemi de değişmektedir.

EMUI 10'dan düşük sürümler EuroHuaweiMessagingService içindeki onNewToken()’da tokenları subscribe ederken,

EMUI 10 üzerinde telefonlar aşağıdaki gibi tokenları generate eder. Generate edilmiş bu token'i euroMobileManager'a subscribe etmeniz gerekmektedir.

veya

4.3 İki servisin aktif olduğu cihazlarda tokeni iki kere yollamamak için

Kodların son hali ;

4.4 Push Bildirim İzni Alın (Android 13 veya daha yüksek)

SDK versiyonlarınızı doğrulayın. Compile ve target SDK versiyonu en az 33 olmalıdır.

Aşağıdaki Euromessage metodunu kullanarak, push notification izni isteme prompt’unu tetikleyin.

Adım 5 - Token Kullanıcı Üye Eşleşmesi

Kullanıcıya ait çeşitli parametreler biliniyorsa kayıt aşamasında ya da sonrasında aşağıdaki gibi activity'de eklenebilir. Aşağıdaki kod bloğu sayesinde aynı bilgilere ait kullanıcı Euromessage RMC panelinde varsa, alınan token kullanıcı ile eşleştirilecektir.

Bu method sayesinde subscribe işlemi için sunucuya gönderilen json objesinde extra parametresine değerler eklenmiş olur ve kullanıcının hangi token ile eşleştirileceği belirtilmiş olur. Zorunlu parametreler ve opsiyonel parametreler gönderildikten sonra sync() metodu çağrılmalıdır.

Bir uygulama mobil cihaza kurulduğu anda push subscription servisi ile bu 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 mutlaka cihazda 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.

Mobil kanaldan gelen datalarınızın RMC'ye yüklenebilmesi için, aktif RMC hesabınızda kullanmış olduğunuz referans değeriniz ne ise (KEY_ID* veya E-Mail) mobil kanaldan gelen dataların da bu referans ile gelmesine dikkat ediniz."

*KEY_ID: Uygulama sahibi tarafından müşterisinin tekilleştirilmesi için kullanılan id değerleridir. Bunlar CRM id, userid, customerid, accountid gibi farklı isimlerle ifade ediliyor olabilir.

User-token eşleşmesi için gönderilen payload ta extra parametresi bu şekilde parametreler alacaktır;

Adım 6 - IYS E-Posta Kaydı

Eğer kullanıcınız kurumsal bir hesap ise TACIR olarak göndermeniz gerekmektedir. Bunun için registerEmail metodunda bulundan false değerini true olarak değiştiriniz.

Eğer RMC panel üzerinde bir kullanıcı eşleştirmesi görmüyorsanız, RMC support ekibinden ilgili appKey’in FLAG’ini aktif hale getirmesini talep ediniz.

Adım 7 - Okundu Raporu ve Yönlendirme

Gelen push bildiriminin içeriğini yakalamak ve gerekli yönlendirmeyi yapabilmek için aşağıdaki gibi onNewIntent() metodunu kullanmalısınız. Eğer öncesinde EuroMobileManager.setPushIntent() metodu aracılığıyla bir sınıf girdiyseniz o sınıf içerisine onNewIntent() methodu eklenmelidir.

Eğer setPushIntent() metodunu kullanmadıysanız launcher activity içerisine onNewIntent() metodunun eklenmesi gereklidir.

Okundu raporlarıyla ilgili:

- Eğer 5.1.3 veya üstü bir SDK versiyonu kullanıyorsanız, okundu raporunu sizin göndermeniz gerekmektedir. Android 12 ile gelen kısıtlamalar nedeniyle SDK tarafından gönderilememektedir.

- Eğer 5.0 - 5.1.2 arası bir SDK versiyonu kullanıyorsanız, SDK otomatik olarak okundu raporlarını gönderecektir. Bu yüzden reportRead() metodunu çağırmamalısınız. (Bu metod 5.0+ SDK versiyonlarında zaten mevcut değildir.)

- Eğer 5.0 versiyonun altında bir SDK versiyonu kullanıyorsanız okundu raporlarının panele yansıması için aşağıdaki gibi reportRead() metodunu çağırmalısınız.

Öneri

Eğer RMC’den kampanya gönderimlerinizde push bildirimi cihazınıza debug modda ulaşıyor, release modda ulaşmıyorsa, uygulamanızda pro-guard ile ilgili sorunlarınıza göz atın.

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

Euromessage Android SDK Diğer Özellikleri

FCM ve HMS' nin RMC'ye Entegrasyonu

Örnek Uygulamalar :

Euromessage Demo Uygulaması

Shopping Demo Uygulaması- VL&EM