アプリ内インストール プロンプトを統合する

このガイドでは、Kotlin または Java を使用して、アプリ内インストール プロンプトをアプリに統合する方法について説明します。

開発環境をセットアップする

Play In-App Install Prompts Library は Google Play Core Library の一部です。ライブラリを使用するには、次の 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
});

実装を確認するには、アプリ内インストール プロンプトをテストするをご覧ください。