Android SDK 4.0.0 への移行ガイド

LogBase Android SDKはバージョン4.0.0よりFCMを利用します。これに伴い SDK の導入方法・設定が変更されます。

4.0.0未満のバージョンをご利用中でバージョン4.0.0以上に更新する際は、以下の移行手順に従ってください。

移行手順

共通

  1. LogBase SDKの更新をします。app/build.gradleでバージョン4.0.0以上を指定してください。

    dependencies {
      implementation('net.p-lucky:logbase-android-sdk:4.0.1@aar') { transitive = true }
    }
  2. logbase.xml の次の行を削除してください。

    <string name="logpush_sender_id" translatable="false">SENDER_ID</string>

プッシュ通知機能をご利用中の場合

  1. アプリへのFirebaseの導入が必要となります。 Android プロジェクトに Firebase を追加するの「Firebaseを手動で追加する」の手順に従い、 アプリにFirebaseを導入してください。
    なお、「SDK を追加する」項にあるcom.google.firebase:firebase-coreの依存指定は不要です。

    また、従来 LogBase と連携していただいていた Firebase プロジェクトをそのままご利用いただけます。

  2. AndroidManifest.xmlの記述を編集します。 従来の記述のうち、以下のpermission及びreceiverを削除してください。

    <permission
        android:name="${applicationId}.permission.C2D_MESSAGE"
        android:protectionLevel="signature" />
    <uses-permission android:name="${applicationId}.permission.C2D_MESSAGE" />
    <receiver
        android:name="net.p_lucky.logpush.GCMReceiver"
        android:exported="true"
        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="${applicationId}" />
        </intent-filter>
    </receiver>

    次に以下の記述を<application />タグの子要素として追加してください。

    <service android:name="net.p_lucky.logpush.LogBaseMessagingService">
        <intent-filter>
            <action android:name="com.google.firebase.MESSAGING_EVENT" />
        </intent-filter>
    </service>
  3. GCMを用いる他のSDKと同時に利用していた場合
    バージョン4.0.0以降net.p_lucky.logpush.GCMReceiverは削除され、他receiverへのプッシュ受信イベントの転送機能はご利用いただけません。

    他の SDK によって提供されるreceiverAndroidManifest.xmlに上記のserviceと併記してください。 端末がプッシュ通知を受信したとき、LogBaseMessagingService及び他 SDK のreceiverの処理は共に呼ばれます。LogBaseSDK は LogBase を用いてプッシュを送信したときのみ通知の表示を行います。