Mit der Install Referrer API des Google Play Store können Sie Empfehlungsinhalte sicher aus Google Play abrufen. Die Clientbibliothek der Play Install Referrer API ist in der Programmiersprache Java geschrieben und ist ein Wrapper für die AIDL-Datei (Android Interface Definition Language), die die Schnittstelle zum Installationsverweisdienst definiert. Mit der Play Install Referrer API-Clientbibliothek kannst du den Entwicklungsprozess vereinfachen.
In diesem Leitfaden erfahren Sie, wie Sie Empfehlungsinformationen aus Google Play mithilfe der Verweisbibliothek für Play-Installationen abrufen.
Abhängigkeiten der Anwendung aktualisieren
Fügen Sie die folgende Zeile im Abschnitt „Abhängigkeiten“ der Datei build.gradle
für Ihre Anwendung hinzu:
Groovig
dependencies { ... implementation "com.android.installreferrer:installreferrer:2.2" }
Kotlin
dependencies { ... implementation("com.android.installreferrer:installreferrer:2.2") }
Verbindung mit Google Play wird hergestellt
Bevor Sie die Play Install Referrer API-Bibliothek verwenden können, müssen Sie eine Verbindung zur Play Store App herstellen. Gehen Sie dazu so vor:
- Rufen Sie die Methode
newBuilder()
auf, um eine Instanz der KlasseInstallReferrerClient
zu erstellen. Rufen Sie
startConnection()
auf, um eine Verbindung zu Google Play herzustellen.Die Methode
startConnection()
ist asynchron. Daher müssen SieInstallReferrerStateListener
überschreiben, um einen Callback zu erhalten, nachdemstartConnection()
abgeschlossen ist.Überschreiben Sie die Methode
onInstallReferrerSetupFinished()
, damit Sie benachrichtigt werden, wenn der Callback abgeschlossen ist. Diese Methode wird mit einem Antwortcode aufgerufen, mit dem Sie die verschiedenen Zustände verarbeiten müssen.OK
gibt an, dass die Verbindung erfolgreich hergestellt wurde. Die anderenInstallReferrerResponse
-Konstanten stehen für verschiedene Fehlertypen.Überschreiben Sie die Methode
onInstallReferrerServiceDisconnected()
, um unterbrochene Verbindungen zu Google Play zu verarbeiten. Beispielsweise kann es sein, dass der Play Install Referrer Library-Client die Verbindung verliert, wenn der Play Store-Dienst im Hintergrund aktualisiert wird. Der Bibliotheksclient muss die MethodestartConnection()
aufrufen, um die Verbindung neu zu starten, bevor weitere Anfragen gesendet werden.
Der folgende Code zeigt, wie Sie eine Verbindung zur Play Store App starten und testen:
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. } });
Installations-Referrer-URL abrufen
Nachdem Sie eine Verbindung zur Play Store App hergestellt haben, rufen Sie die Details von der Installations-Referrer-URL ab. Führen Sie dazu die folgenden Schritte aus:
Verwenden Sie die synchronisierte Methode
getInstallReferrer()
, um eine Instanz vonReferrerDetails
zurückzugeben.Verwenden Sie die Methoden der Klasse
ReferrerDetails
, um Details zur Installations-Referrer-URL zu erhalten.
Der folgende Code zeigt, wie Sie auf die Informationen zur Referrer-URL für die Installation zugreifen können:
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();
Achtung:Die Informationen zur Verweis-URL für die Installation sind 90 Tage lang verfügbar und ändern sich nicht, sofern die App nicht neu installiert wird. Um unnötige API-Aufrufe in Ihrer Anwendung zu vermeiden, sollten Sie die API bei der ersten Ausführung nach der Installation nur einmal aufrufen.
Dienstverbindung wird geschlossen
Nachdem Sie die Referrer-Informationen abgerufen haben, rufen Sie die Methode endConnection()
in der InstallReferrerClient
-Instanz auf, um die Verbindung zu trennen. Durch das Schließen der Verbindung lassen sich Lecks und Leistungsprobleme vermeiden.
Weitere Informationen finden Sie in der Referenz zur Referrer-URL-Bibliothek von Google Play.