Integrar comandos de instalação no app

Este guia descreve como integrar solicitações de instalação no app usando Kotlin ou Java.

Observação: somente parceiros de acesso antecipado podem mostrar solicitações de instalação no app. Saiba como participar do programa de acesso antecipado.

Configurar seu ambiente de desenvolvimento

A biblioteca Play In-App Install Prompts faz parte das bibliotecas Google Play Core. Para usar a biblioteca, inclua a seguinte dependência do 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")
    ...
}

Criar o CrossDevicePromptManager

O CrossDevicePromptManager é a interface que permite ao app solicitar informações e iniciar o fluxo de solicitação de instalação. Crie uma instância para obtê-lo:

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);

Solicitar um objeto CrossDevicePromptInstallationRequest

Determine o melhor momento no fluxo do app para pedir que o usuário instale o app em outro dispositivo (por exemplo, quando ele transmite um vídeo do smartphone para uma TV). Quando o app atingir um desses pontos, siga estas etapas:

1. Crie um CrossDevicePromptInstallationRequest.
2. Use o CrossDevicePromptManager para criar uma tarefa de solicitação que aceite a solicitação como um parâmetro.

Se a tarefa for bem-sucedida, a API vai retornar o objeto CrossDevicePromptInfo no callback de sucesso. Caso contrário, a API vai retornar um Exception no callback de falha.

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
});

Importante: se ocorrer um erro durante o fluxo de solicitação de instalação no app, não informe o usuário nem mude o fluxo normal dele. Continue o fluxo normal do app depois que onComplete for chamado.

Para verificar sua implementação, consulte Testar solicitações de instalação no app.