跳到主要内容

Kotlin 版 SDK Install Referrer (版本 7.0.0)

SDK Install referrer 是一款用于广告和分析系统的归因工具。 它允许您跟踪通过广告链接从 RuStore 下载并安装您的应用程序的数量。

RuStore 接受如下格式的链接：https://www.rustore.ru/catalog/app/com.packagename.yourapp?referrerId=<referrer>。

当用户点击广告链接并开始安装应用程序时，RuStore 会保存该链接中的 referrer 值。 SDK 会请求 RuStore 获取 referrer 值，并将其通过 InstallReferrer 参数传递给您的应用程序。 这样，应用程序就能获得关于通过特定广告链接完成安装的信息。

在 RuStore 将 referrer 值传递给 SDK 后，该值将从 RuStore 中删除。 即使 SDK 没有请求 referrer，该值在 RuStore 中也仅存储 10 天，之后将被删除。

连接到项目​

重要

Kotlin 最低支持版本为 1.8

Android SDK 的最低版本由项目设置决定。

添加仓库​

build.gradle
repositories {
    maven {
        url = uri("https://nexus-external.rustore.ru/repository/maven-rustore-exposed")
    }
}

添加依赖项​

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) {
        // Handling error
    }
 
    override fun onSuccess(result: InstallReferrer) {
        // Save InstallReferrer    
    }
})

  • 在收到 onSuccess 响应时，如果您计划使用 InstallReferrer，请将其值保存在您的应用程序中。 再次请求时，将返回 null 而非 InstallReferrer 的值。

    备注

在以下情况下，InstallReferrer 的值为 null：

  • 安装应用程序时未传递 referrer；

  • 之前已请求过 InstallReferrer；

  • 自 RuStore 接收到 referrer 以来已过去 10 天或更多天。 :::

  • 在收到 onFailure 响应时，请根据您的应用程序逻辑处理错误。 所有可能的错误详见下文。

提示

Task 类的响应方法 addOnCompletionListener()、addOnSuccessListener() 和 addOnFailureListener() 可用于捕获结果：

  • addOnCompletionListener() — 两种结果：成功和错误。
  • addOnSuccessListener() — 仅成功结果。
  • addOnFailureListener() — 仅错误结果。

有关这些方法的更多信息，请参阅 Task API 文章。

可能的错误​

  • RuStoreNotInstalledException — 用户设备上未安装 RuStore。

  • RuStoreOutdatedException — 用户设备上安装的 RuStore 版本不支持此 SDK。

  • RuStoreException — RuStore 基础错误，其他错误均继承自此类。