مكتبة المُحيل في متجر Play

يمكنك استخدام واجهة Install Referrer API في "متجر Google Play" لاسترداد محتوى الإحالة من Google Play مكتبة عملاء Play Install Referrer API بلغة برمجة Java وهو برنامج تضمين لنظام التشغيل Android ملف لغة تعريف الواجهة (AIDL) الذي يحدد واجهة تثبيت خدمة المُحيل. يمكنك استخدام برنامج Play Install Referrer API مكتبة لتبسيط عملية التطوير.

يتناول هذا الدليل أساسيات استرداد معلومات الإحالة من Google. يمكنك اللعب باستخدام مكتبة مُحيل التثبيت على Play.

تعديل اعتماديات تطبيقك

أضِف السطر التالي إلى قسم الموارد التابعة في ملف build.gradle. عن تطبيقك:

Groovy

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

Kotlin

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

جارٍ الاتصال بـ Google Play

قبل أن تتمكّن من استخدام مكتبة واجهة برمجة التطبيقات Play Install Referrer API، عليك عليك الربط بتطبيق "متجر Play" باستخدام ما يلي: الخطوات:

  1. عليك استدعاء newBuilder() لإنشاء مثيل InstallReferrerClient الصف.
  2. عليك استدعاء startConnection() لإنشاء اتصال بـ Google Play.

  3. startConnection() غير متزامن، لذا يجب تجاوز InstallReferrerStateListener لتلقي معاودة الاتصال بعد startConnection() تكتمل.

  4. إلغاء onInstallReferrerSetupFinished() إرسال إشعار عند اكتمال معاودة الاتصال. تُسمى هذه الطريقة برمز استجابة يجب استخدامه للتعامل مع الحالات المختلفة. OK إلى أن الاتصال كان ناجحًا. كل من الآخر InstallReferrerResponse تشير الثوابت إلى أنواع مختلفة من الأخطاء.

  5. إلغاء onInstallReferrerServiceDisconnected() للتعامل مع الاتصالات المفقودة مع Google Play. بالنسبة مثلاً، قد يفقد برنامج "Play Install Referrer Library" (مكتبة المُحيلة) من Play الاتصال في حال يتم تحديث خدمة "متجر Play" في الخلفية. يجب أن يستدعي برنامج المكتبة الـ startConnection() لإعادة تشغيل الاتصال قبل إجراء طلبات أخرى.

توضح التعليمة البرمجية التالية كيفية بدء واختبار اتصال تطبيق "متجر Play":

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.
    }
});

الحصول على مُحيل التثبيت

بعد الاتصال بتطبيق "متجر Play"، يمكنك الحصول على التفاصيل. من مُحيل التثبيت من خلال إكمال الخطوات التالية:

  1. استخدام ملف getInstallReferrer() لإرجاع مثيل ReferrerDetails

  2. استخدم الطرق التي ReferrerDetails الفئة للحصول على تفاصيل عن مُحيل التثبيت.

يوضح الرمز التالي كيفية الوصول إلى مُحيل التثبيت المعلومات:

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();

تحذير: ستكون معلومات مُحيل التثبيت متاحة لمدة 90 يومًا ولن تتغير ما لم يكن التطبيق تمت إعادة تثبيته. لتجنّب الطلبات غير الضرورية من واجهة برمجة التطبيقات في تطبيقك، عليك استدعاء واجهة برمجة التطبيقات مرة واحدة فقط أثناء عملية التنفيذ الأولى بعد التثبيت.

جارٍ إغلاق اتصال الخدمة

بعد الحصول على معلومات المُحيل، اتصل endConnection() على InstallReferrerClient المثيل لإغلاق الاتصال. سيساعدك إغلاق الاتصال على تجنب التسريبات ومشكلات الأداء.

لمزيد من المعلومات، يُرجى الرجوع إلى مكتبة مُحيل التثبيت في Play. المرجع: