ไลบรารี Play Install Referrer

คุณสามารถใช้ Install Referrer API ของ Google Play Store เพื่อดึงข้อมูลได้อย่างปลอดภัย เนื้อหาที่แนะนำจาก Google Play ไลบรารีของไคลเอ็นต์ Play Setup Referrer API เขียนในภาษาโปรแกรม Java และเป็น Wrapper สำหรับ Android ไฟล์ Interface Definition Language (AIDL) ที่กำหนดอินเทอร์เฟซสำหรับ ติดตั้งบริการผู้อ้างอิง คุณใช้ไคลเอ็นต์ Play Install Referrer API ได้ ไลบรารีเพื่อลดความซับซ้อนของขั้นตอนการพัฒนา

คู่มือนี้ครอบคลุมพื้นฐานการเรียกข้อมูลการอ้างอิงจาก Google เล่นโดยใช้ไลบรารี Play install Referrer

กำลังอัปเดตทรัพยากร Dependency ของแอป

เพิ่มบรรทัดต่อไปนี้ลงในส่วนทรัพยากร Dependency ของไฟล์ build.gradle สำหรับแอปของคุณ

ดึงดูด

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

Kotlin

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

กำลังเชื่อมต่อกับ Google Play

ก่อนที่คุณจะใช้ไลบรารี Play Install Referrer API ได้ คุณต้อง สร้างการเชื่อมต่อกับแอป Play Store โดยใช้สิ่งต่อไปนี้ ขั้นตอน:

  1. เรียกใช้ newBuilder() ในการสร้างอินสแตนซ์ InstallReferrerClient

  2. เรียกใช้ startConnection() เพื่อสร้างการเชื่อมต่อกับ Google Play

  3. startConnection() ไม่พร้อมกัน คุณจึงต้องลบล้าง InstallReferrerStateListener เพื่อให้ได้รับการติดต่อกลับหลังจาก startConnection() เสร็จสมบูรณ์

  4. ลบล้างonInstallReferrerSetupFinished() เพื่อรับการแจ้งเตือนเมื่อการติดต่อกลับเสร็จสิ้น วิธีการนี้เรียกว่า พร้อมด้วยโค้ดตอบกลับที่คุณต้องใช้ในการจัดการสถานะต่างๆ OK แสดงว่าเชื่อมต่อสำเร็จ กันและกัน InstallReferrerResponse ค่าคงที่มีไว้สำหรับข้อผิดพลาดประเภทต่างๆ

  5. ลบล้างonInstallReferrerServiceDisconnected() ในการจัดการการสูญเสียการเชื่อมต่อกับ Google Play สำหรับ ตัวอย่างเช่น ไคลเอ็นต์ไลบรารีการอ้างอิงสำหรับการติดตั้ง Play อาจสูญเสียการเชื่อมต่อหาก บริการ Play Store กำลังอัปเดตอยู่เบื้องหลัง ไคลเอ็นต์ไลบรารีจะต้องเรียก เวลา startConnection() ในการรีสตาร์ทการเชื่อมต่อก่อนที่จะส่งคำขอเพิ่มเติม

โค้ดต่อไปนี้แสดงวิธีเริ่มต้นและทดสอบการเชื่อมต่อกับ แอป 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.
    }
});

การรับ URL ที่มาของการติดตั้ง

หลังจากสร้างการเชื่อมต่อกับแอป Play Store แล้ว ให้ดูรายละเอียด จาก URL ที่มาของการติดตั้งโดยทำตามขั้นตอนต่อไปนี้

  1. ใช้รายการที่ซิงค์ getInstallReferrer() ในการแสดงผลอินสแตนซ์ของ ReferrerDetails

  2. ใช้วิธีการที่ ReferrerDetails ให้เพื่อรับรายละเอียดเกี่ยวกับ URL ที่มาการติดตั้ง

โค้ดต่อไปนี้แสดงวิธีการเข้าถึง URL ที่มาของการติดตั้ง ข้อมูล:

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 วันและจะไม่เปลี่ยนแปลง เว้นแต่แอปพลิเคชันจะ ติดตั้งอีกครั้งแล้ว เพื่อหลีกเลี่ยงการเรียก API โดยไม่จำเป็นในแอป คุณควรเรียกใช้ API เพียงครั้งเดียวในระหว่างการดำเนินการครั้งแรกหลังการติดตั้ง

กำลังปิดการเชื่อมต่อบริการ

หลังจากได้รับข้อมูลแหล่งอ้างอิงแล้ว ให้โทรไปที่ endConnection() ใน InstallReferrerClient เพื่อปิดการเชื่อมต่อ การปิดการเชื่อมต่อจะช่วยให้คุณหลีกเลี่ยง การรั่วไหลและปัญหาด้านประสิทธิภาพ

ดูข้อมูลเพิ่มเติมได้ที่ไลบรารีการอ้างอิงการติดตั้ง Play ข้อมูลอ้างอิง