Kotlin的SDK Install Referrer(版本7.0.0)
SDK Install referrer — 广告 和分析系统的归因工具。它允许您通过广告链接跟踪从RuStore下载的应用程序的安装数量。
RuStore接受以下类型的链接:https://www.rustore.ru/catalog/app/com.packagename.yourapp?referrerId=<referrer>.
当用户遵循广告链接并开始安装应用程序时,RuStore保存来自该链接的推荐值。SDK与RuStore联系,请求referrer值并将其传递给您的应用程序中的InstallReferrer参数。通过这种方式,应用程序接收到在单击特定广告链接时执行安装的信息。 在RuStore将referrer值传递给SDK后,它将从RuStore中移除。即使SDK没有请求referrer,该值也只会在RuStore中存储10天,之后会被删除。
在项目中集成
添加存储库
build.gradle
repositories {
maven {
url = uri("https://artifactory-external.vkpartner.ru/artifactory/maven")
}
}
集成依赖项
build.gradle
dependencies {
implementation("ru.rustore.sdk:installreferrer:7.0.0")
}
InstallReferrerClient创建
要使用 referrer,使用类构造函数创建 InstallReferrerClient:
初始化
val client = InstallReferrerClient(context)
获取InstallReferrer对象
调用 getInstallReferrer()来获取 InstallReferrer:
client.getInstallReferrer().addOnCompleteListener(object : OnCompleteListener<InstallReferrer> {
override fun onFailure(throwable: Throwable) {
// Handle error
}
override fun onSuccess(result: InstallReferrer) {
// Save InstallReferrer
}
})
- 当响应onSuccess时,如果您打算使用InstallReferrer值,请将其存储在应用程序中。如果您重新查询,InstallReferrer值将返回为空。
备注
InstallReferrer为空,如果:
- 安装应用程序时没有传递 referrer;
- InstallReferrer之前已经被请求过;
- 自RuStore收到referrer已经过了10天或以上。
- 当onFailure响应时,根据应用程序逻辑处理错误。下面描述了所有可能的错误。
提示
任务类的响应方法addOnCompletionListener(), addOnSuccessListener()和addOnFailureListener允许您捕获结果:
- addOnCompletionListener() - 两个结果:成功和错误。
- addOnSuccessListener() - 只有成功的结果。
- addOnFailureListener() - 只显示错误结果。
有关这些方法的更多信息,请参阅Task API文章。
可能的错误
- RuStoreNotInstalledException — 用户设备上未安装RuStore。
- RuStoreOutdatedException — 用户设备上安装的RuStore版本不支持本SDK。
- RuStoreException — RuStore的基本错误,其他错误继承自此。