Play Store’s Install Referrer API to securely retrieve referral

You can use the Google Play Store’s Install Referrer API to securely retrieve referral content from Google Play.

You can get the following information by using referral API as below:

The referrer URL of the installed package.
The timestamp, in seconds, of when the referrer click happened.
The timestamp, in seconds, of when the installation began.
The app’s version at the time when the app was first installed.
Whether the user has interacted with your app’s instant experience in the past 7 days.

You can use Referrer data to know which campaigns and traffic sources are sending users to download your app from the Google Play Store.

Add Dependency

You need to add Play Store’s Install Referrer dependency in the module build Gradle file.

dependencies {
  //Play Store's Install Referrer dependency 
    implementation 'com.android.installreferrer:installreferrer:2.1'
}

dependencies {

//Play Store's Install Referrer dependency

implementation 'com.android.installreferrer:installreferrer:2.1'

}

Referral API Implementations

You can add InstallReferrerClient in Activity or other class to retrieve referral data.

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.android.installreferrer.api.InstallReferrerClient
import com.android.installreferrer.api.InstallReferrerClient.InstallReferrerResponse
import com.android.installreferrer.api.InstallReferrerStateListener
import com.android.installreferrer.api.ReferrerDetails

class HomeActivity : AppCompatActivity() {

  private lateinit var referrerClient: InstallReferrerClient

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

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

      override fun onInstallReferrerSetupFinished(responseCode: Int) {
        when (responseCode) {
          InstallReferrerResponse.OK -> {
            // Connection established.
            getReferrerData()
          }
          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.
      }
    })
  }

  private fun getReferrerData() {

    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

    referrerClient.endConnection()
  }
}

import android.os.Bundle

import androidx.appcompat.app.AppCompatActivity

import com.android.installreferrer.api.InstallReferrerClient

import com.android.installreferrer.api.InstallReferrerClient.InstallReferrerResponse

import com.android.installreferrer.api.InstallReferrerStateListener

import com.android.installreferrer.api.ReferrerDetails

class HomeActivity : AppCompatActivity() {

private lateinit var referrerClient: InstallReferrerClient

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

setContentView(R.layout.activity_main)

referrerClient = InstallReferrerClient.newBuilder(this).build()

referrerClient.startConnection(object : InstallReferrerStateListener {

override fun onInstallReferrerSetupFinished(responseCode: Int) {

when (responseCode) {

InstallReferrerResponse.OK -> {

// Connection established.

getReferrerData()

}

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.

}

})

}

private fun getReferrerData() {

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

referrerClient.endConnection()

}

Happy Learning 🙂

Reference –

https://developer.android.com/google/play/installreferrer

campaigns Google Play Install Referrer

yogendra singh 1 September 2020

. . .

Google Play Install Referrer

Leave a Comment Cancel Reply

Message Sent!