คุณสามารถใช้ Install Referrer API ของ Google Play Store เพื่อดึงข้อมูลเนื้อหาการอ้างอิงจาก Google Play ได้อย่างปลอดภัย ไลบรารีของไคลเอ็นต์ Play Install Referrer API เขียนขึ้นในภาษาโปรแกรม Java และเป็น Wrapper สำหรับไฟล์ภาษาที่ใช้สื่อสารข้อมูลระหว่างคอมโพเนนต์ของ Android (AIDL) ซึ่งกำหนดอินเทอร์เฟซสำหรับบริการ Install Referrer คุณสามารถใช้ไลบรารีของไคลเอ็นต์ Play Install Referrer API เพื่อลดความซับซ้อนในขั้นตอนการพัฒนาซอฟต์แวร์
คู่มือนี้ครอบคลุมข้อมูลเบื้องต้นเกี่ยวกับการดึงข้อมูลการอ้างอิงจาก Google Play โดยใช้ Play Install Referrer Library
การอัปเดตทรัพยากร 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 โดยทำตามขั้นตอนต่อไปนี้
- เรียกใช้เมธอด
newBuilder()เพื่อสร้างอินสแตนซ์ของคลาสInstallReferrerClient - เรียกใช้เมธอด
startConnection()เพื่อสร้างการเชื่อมต่อกับ Google Play - เนื่องจาก
startConnection()เป็นแบบอะซิงโครนัส ให้ใช้InstallReferrerStateListenerเพื่อรับ Callback หลังจากstartConnection()เสร็จสมบูรณ์ - ลบล้างเมธอด
onInstallReferrerSetupFinished()เพื่อรับการแจ้งเตือนเมื่อ Callback เสร็จสมบูรณ์ เมธอดนี้จะส่งโค้ดตอบกลับที่คุณต้องใช้เพื่อจัดการสถานะต่างๆOKบ่งบอกว่าการเชื่อมต่อสำเร็จ ค่าคงที่InstallReferrerResponseอื่นๆ จะระบุข้อผิดพลาดประเภทต่างๆ - ลบล้างเมธอด
onInstallReferrerServiceDisconnected()เพื่อจัดการการเชื่อมต่อที่ขาดหายไปกับ Google Play ตัวอย่างเช่น ไคลเอ็นต์ Play Install Referrer Library อาจสูญเสียการเชื่อมต่อหากบริการ 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 แล้ว ให้ดูรายละเอียดจาก Install Referrer โดยทำตามขั้นตอนต่อไปนี้
- ใช้เมธอด
getInstallReferrer()ที่ซิงค์ข้อมูลแล้วเพื่อแสดงผลอินสแตนซ์ของReferrerDetails - ใช้เมธอดที่คลาส
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();
กำลังปิดการเชื่อมต่อบริการ
หลังจากได้รับข้อมูลผู้แนะนำแล้ว ให้เรียกใช้เมธอด endConnection() ในอินสแตนซ์ InstallReferrerClient เพื่อปิดการเชื่อมต่อ การปิดการเชื่อมต่อจะช่วยหลีกเลี่ยงการรั่วไหลและปัญหาด้านประสิทธิภาพ
ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงเกี่ยวกับไลบรารี Play Install Referrer