集成应用内安装提示

本指南介绍了如何使用 Kotlin 或 Java 将应用内安装提示集成到您的应用中。

设置您的开发环境

Play 应用内安装提示库是 Google Play Core 库的一部分。如需使用该库,请添加以下 Gradle 依赖项:

Groovy

// In your app's build.gradle file:
...
dependencies {
    // This dependency is downloaded from the <a href="/studio/build/dependencies#google-maven">Google's Maven repository</a>.
    // So, make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.play:crossdeviceprompt:0.0.1-eap01'
    ...
}

Kotlin

// In your app's build.gradle.kts file:
...
dependencies {
    // This dependency is downloaded from the <a href="/studio/build/dependencies#google-maven">Google's Maven repository</a>.
    // So, make sure you also include that repository in your project's build.gradle file.
    implementation("com.google.android.play:crossdeviceprompt:0.0.1-eap01")
    ...
}

创建 CrossDevicePromptManager

CrossDevicePromptManager 界面可让您的应用请求信息并启动安装提示流程。创建实例以获取它:

Kotlin

import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptInfo
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManager
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManagerFactory
import com.google.android.play.core.crossdeviceprompt.model.CrossDevicePromptInstallationRequest

...

val crossDevicePromptManager: CrossDevicePromptManager =
    CrossDevicePromptManagerFactory.create(context)

Java

import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptInfo;
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManager;
import com.google.android.play.core.crossdeviceprompt.CrossDevicePromptManagerFactory;
import com.google.android.play.core.crossdeviceprompt.model.CrossDevicePromptInstallationRequest;

...

CrossDevicePromptManager crossDevicePromptManager =
    CrossDevicePromptManagerFactory.create(context);

请求 CrossDevicePromptInstallationRequest 对象

确定在应用流程中的哪个时刻提示用户在另一设备上安装您的应用效果最好(例如,当用户将手机中的视频投放到电视上时)。当您的应用达到其中一个阶段时,请执行以下步骤:

  1. 创建 CrossDevicePromptInstallationRequest
  2. 使用 CrossDevicePromptManager 创建一个接受请求作为参数的请求任务。

如果任务成功,API 会在成功回调中返回 CrossDevicePromptInfo 对象。否则,该 API 会在失败回调中返回 Exception

Kotlin

val request: CrossDevicePromptInstallationRequest? =
    CrossDevicePromptInstallationRequest.create()
val result: Task<CrossDevicePromptInfo?> =
    crossDevicePromptManager.requestInstallationPromptFlow(request)

result.addOnSuccessListener { crossDevicePromptInfo ->
    // Requested a prompt flow successfully
}

result.addOnFailureListener { e ->
    // Failed to request a prompt flow
}

Java

CrossDevicePromptInstallationRequest request =
    CrossDevicePromptInstallationRequest.create();
Task<CrossDevicePromptInfo> result =
    crossDevicePromptManager.requestInstallationPromptFlow(request);

result.addOnSuccessListener(crossDevicePromptInfo -> {
    // Requested a prompt flow successfully
});

result.addOnFailureListener(e -> {
    // Failed to request a prompt flow
});

如需验证您的实现,请参阅测试应用内安装提示