Library Play Install Referrer

Anda dapat menggunakan Install Referrer API dari Google Play Store untuk mengambil konten perujuk dengan aman dari Google Play. Library Klien Play Install Referrer API ditulis dalam bahasa pemrograman Java dan merupakan wrapper untuk file Android Interface Definition Language (AIDL) yang menentukan antarmuka ke layanan Install Referrer. Anda dapat menggunakan Library Klien Play Install Referrer API untuk menyederhanakan proses pengembangan.

Panduan ini mencakup dasar-dasar pengambilan informasi perujuk dari Google Play menggunakan Library Play Install Referrer.

Catatan: Jika mengembangkan aplikasi menggunakan bahasa selain bahasa pemrograman Kotlin atau bahasa pemrograman Java, Anda dapat berinteraksi langsung dengan file AIDL menggunakan Play Install Referrer API.

Mengupdate dependensi aplikasi Anda

Tambahkan baris berikut ke bagian dependensi file build.gradle untuk aplikasi Anda:

Groovy

dependencies {
    ...
    implementation "com.android.installreferrer:installreferrer:2.2"
}

Kotlin

dependencies {
    ...
    implementation("com.android.installreferrer:installreferrer:2.2")
}

Menghubungkan ke Google Play

Sebelum dapat menggunakan Library Play Install Referrer API, Anda harus membuat koneksi ke aplikasi Play Store dengan langkah-langkah berikut:

1. Panggil metode newBuilder() untuk membuat instance class InstallReferrerClient.
2. Panggil metode startConnection() untuk membuat koneksi ke Google Play.
3. Karena startConnection() bersifat asinkron, terapkan InstallReferrerStateListener untuk menerima callback setelah startConnection() selesai.
4. Ganti metode onInstallReferrerSetupFinished() untuk menerima notifikasi saat callback selesai. Metode ini meneruskan kode respons yang harus Anda gunakan untuk menangani berbagai status. OK menunjukkan bahwa koneksi berhasil. Konstanta InstallReferrerResponse lainnya menunjukkan berbagai jenis error.
5. Ganti metode onInstallReferrerServiceDisconnected() untuk menangani koneksi yang terputus ke Google Play. Misalnya, klien Library Play Install Referrer mungkin kehilangan koneksi jika layanan Google Play Store sedang diupdate di latar belakang. Klien library harus memanggil metode startConnection() untuk memulai ulang koneksi sebelum membuat permintaan lebih lanjut.

Kode berikut menunjukkan cara memulai dan menguji koneksi ke aplikasi Play Store:

Kotlin

private lateinit var referrerClient: InstallReferrerClient

referrerClient = InstallReferrerClient.newBuilder(this).build()
referrerClient.startConnection(object : InstallReferrerStateListener {

    override fun onInstallReferrerSetupFinished(responseCode: Int) {
        when (responseCode) {
            InstallReferrerResponse.OK -> {
                // Connection established.
            }
            InstallReferrerResponse.FEATURE_NOT_SUPPORTED -> {
                // API not available on the current Play Store app.
            }
            InstallReferrerResponse.SERVICE_UNAVAILABLE -> {
                // Connection couldn't be established.
            }
        }
    }

    override fun onInstallReferrerServiceDisconnected() {
        // Try to restart the connection on the next request to
        // Google Play by calling the startConnection() method.
    }
})

Java

InstallReferrerClient referrerClient;

referrerClient = InstallReferrerClient.newBuilder(this).build();
referrerClient.startConnection(new InstallReferrerStateListener() {
    @Override
    public void onInstallReferrerSetupFinished(int responseCode) {
        switch (responseCode) {
            case InstallReferrerResponse.OK:
                // Connection established.
                break;
            case InstallReferrerResponse.FEATURE_NOT_SUPPORTED:
                // API not available on the current Play Store app.
                break;
            case InstallReferrerResponse.SERVICE_UNAVAILABLE:
                // Connection couldn't be established.
                break;
        }
    }

    @Override
    public void onInstallReferrerServiceDisconnected() {
        // Try to restart the connection on the next request to
        // Google Play by calling the startConnection() method.
    }
});

Mendapatkan perujuk instal

Setelah koneksi Anda terhubung ke aplikasi Play Store, dapatkan detail dari perujuk penginstalan dengan menyelesaikan langkah-langkah berikut:

1. Gunakan metode getInstallReferrer() yang disinkronkan untuk menampilkan instance ReferrerDetails.
2. Gunakan metode yang disediakan class ReferrerDetails untuk mendapatkan detail tentang perujuk penginstalan.

Kode berikut ini menunjukkan cara mengakses informasi perujuk penginstalan:

Kotlin

val response: ReferrerDetails = referrerClient.installReferrer
val referrerUrl: String = response.installReferrer
val referrerClickTime: Long = response.referrerClickTimestampSeconds
val appInstallTime: Long = response.installBeginTimestampSeconds
val instantExperienceLaunched: Boolean = response.googlePlayInstantParam

Java

ReferrerDetails response = referrerClient.getInstallReferrer();
String referrerUrl = response.getInstallReferrer();
long referrerClickTime = response.getReferrerClickTimestampSeconds();
long appInstallTime = response.getInstallBeginTimestampSeconds();
boolean instantExperienceLaunched = response.getGooglePlayInstantParam();

Perhatian: Informasi perujuk penginstalan tersedia selama 90 hari dan tidak berubah kecuali jika aplikasi diinstal ulang. Untuk menghindari panggilan API yang tidak perlu di aplikasi Anda, panggil API hanya sekali saat aplikasi Anda pertama kali dijalankan setelah diinstal.

Memutus koneksi layanan

Setelah mendapatkan informasi perujuk, panggil metode endConnection() pada instance InstallReferrerClient untuk menutup koneksi. Menutup koneksi membantu Anda menghindari kebocoran dan masalah performa.

Untuk informasi lebih lanjut, lihat Referensi Library Play Install Referrer.