ディープリンクを作成する

ディープリンクを使用すると、ウェブブラウザ、通知、ソーシャルメディア、広告などのソースからユーザーをアプリに直接誘導できます。ディープリンクは、アプリ間やウェブからアプリへの直接的な遷移を実現し、コンテキストに応じたターゲット設定されたコンテンツを通じてエンゲージメントを高めることができます。

このガイドでは、ディープリンクの仕組みと、コンテンツへのディープリンクを作成してテストする方法について説明します。

独自のウェブサイトやドメインを参照するディープリンクの場合は、アプリリンクを使用することをおすすめします。アプリリンクを使用すると、ユーザーにシームレスで信頼性の高いエクスペリエンスを提供できます。

ディープリンクの仕組み

ディープリンクは、すべてのデバイスのすべてのバージョンでサポートされている Android の一般的なシステム機能です。Android のインテントシステムを利用して、ディープリンクを対象のアプリにルーティングします。特定のディープリンク URI を処理するアプリは、アプリマニフェストファイルで一致するインテントフィルタを宣言します。

実行時にユーザーがリンクをタップすると、Android はインテントをトリガーして、アプリにルーティングしようとします。複数のアプリが特定の URI に一致するインテントフィルタを宣言できるため、Android は次のアクションをこの順序で実行してインテントをルーティングします。

URI を処理できる優先アプリが指定されている場合は、そのアプリを開きます。
URI を処理できるアプリが 1 つだけしかない場合は、そのアプリを開きます。
ユーザーが 確認ダイアログからアプリを選択できるようにします。

つまり、インテントフィルタが特定の URI に一致していても、システムがディープリンクインテントをアプリにルーティングするとは限りません。インテントを処理するアプリの管理はユーザーが主導で行うため、ユーザーはアプリを制御して選択できます。独自のウェブサイトやドメインへのディープリンクをより細かく制御するには、アプリリンクの使用を検討してください。

Android の確認ダイアログでは、ディープリンクインテントを処理するために登録されているインストール済みアプリがすべて表示されます。ユーザーは、このタイプのリンクのデフォルトとしてアプリを選択することもできます。ユーザーがデフォルトを設定すると、システムはその特定のインテントのダイアログを表示しなくなり、選択したアプリが自動的に開きます。

図 1.確認ダイアログ

確認ダイアログの動作は、Android のバージョンによって異なります。たとえば、Android 12 以降では、検証済みのアプリリンクではないウェブリンクは通常、デフォルトでウェブブラウザで開きますが、以前のバージョンでは、アプリがウェブリンクを処理できる場合、確認ダイアログが表示されることがあります。

注: Android 12（API レベル 31）以降、一般的なウェブインテントは、そのウェブインテントに含まれる特定のドメインについてアプリが承認されている場合のみ、アプリのアクティビティに解決されます。アプリがそのドメインに対して承認されていない場合、ウェブインテントは代わりにユーザーのデフォルトのブラウザアプリに解決されます。

ディープリンクの種類

Android でサポートできるディープリンクには、次の 3 種類があります。

カスタムディープリンク: カスタム URI スキーム（たとえば example://products/123 など）を使用して、ユーザーをアプリ内の特定のコンテンツに直接誘導するディープリンクです。内部ナビゲーションや、管理しているソースからのリンクに有効ですが、標準のウェブリンクではないため、別のアプリが同じカスタムスキームを登録している場合は、確認ダイアログがトリガーされる可能性があります。
ウェブリンク: 標準の http と https スキームを使用するディープリンクです。標準の URL であるため汎用性が高いですが、Android 12 以降ではほぼ常に確認ダイアログがトリガーされます。つまり、アプリにルーティングされるのではなく、デフォルトでユーザーのウェブブラウザで処理される可能性が高くなります。
アプリリンク: Android 6.0（API レベル 23）以降で利用可能な、 検証済みのウェブリンクです。ウェブサイトの関連付けプロセスを通じて、ドメインの所有者であることを Android システムに証明できます。検証が完了すると、システムはそのドメインのリンクをアプリに直接ルーティングし、確認ダイアログを完全にスキップします。これにより、ユーザーに信頼性の高いシームレスなエクスペリエンスを提供できます。

受信リンク用のインテントフィルタを追加する

アプリコンテンツ用のリンクを作成するには、次の要素と属性値を含むインテントフィルタをマニフェスト内に追加します。

<action>

Google 検索からインテントフィルタに到達できるように ACTION_VIEW インテントのアクションを指定します。

<data>

1 つ以上の <data> タグを追加します。各タグは、アクティビティに変換される URI 形式を示します。<data> タグには、少なくとも android:scheme 属性を含める必要があります。

属性を追加することで、アクティビティが受け入れる URI タイプを絞り込むことができます。たとえば、ベースとなるパス名だけが異なる類似の URI をそれぞれ受け入れる複数のアクティビティがあるとします。このような場合、 android:path 属性またはその pathPattern や pathPrefix バリアントを使用することで、各 URI パスに対してどのアクティビティを開くのかを指定できます。

<category>

BROWSABLE カテゴリを含めます。インテントフィルタにウェブブラウザからアクセスできるようにするために必要です。このカテゴリを指定しないと、ブラウザ内のリンクをアプリに変換できなくなります。

DEFAULT カテゴリも追加します。これにより、アプリが暗黙的インテントに応答できるようになります。このカテゴリを指定しなかった場合、インテントがアプリコンポーネント名を指定していない限り、アクティビティを起動できなくなります。

マニフェスト内でディープリンク用のインテントフィルタを指定する方法を次の XML スニペットに示します。URI "example://gizmos" と "http://www.example.com/gizmos" は、どちらもこのアクティビティに解決されます。

<activity
    android:name="com.example.android.GizmosActivity"
    android:label="@string/title_gizmos" >
    <intent-filter android:label="@string/filter_view_http_gizmos">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- Accepts URIs that begin with "http://www.example.com/gizmos” -->
        <data android:scheme="http"
              android:host="www.example.com"
              android:pathPrefix="/gizmos" />
        <!-- note that the leading "/" is required for pathPrefix-->
    </intent-filter>
    <intent-filter android:label="@string/filter_view_example_gizmos">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- Accepts URIs that begin with "example://gizmos” -->
        <data android:scheme="example"
              android:host="gizmos" />
    </intent-filter>
</activity>

2 つのインテントフィルタの違いは <data> 要素だけです。同じフィルタに複数の <data> 要素を含めることができますが、一意の URL（scheme と host の特定の組み合わせなど）の宣言を意図している場合は、フィルタを個別に作成することが重要です。これは、同じインテントフィルタ内の複数の <data> 要素が実際に結合されて、組み合わされた属性のバリエーションがすべて考慮されるためです。たとえば、次のような場合を考えてみましょう。

<intent-filter>
  ...
  <data android:scheme="https" android:host="www.example.com" />
  <data android:scheme="app" android:host="open.my.app" />
</intent-filter>

これは、https://www.example.com と app://open.my.app だけをサポートしているように見えるかもしれません。しかし、実際には、上記の 2 つに加えて app://www.example.com と https://open.my.app もサポートしています。

注意: 複数のアクティビティに、同じ検証済みの Android アプリリンクに解決されるインテントフィルタが含まれている場合、どのアプリがリンクを処理するかは保証されません。

アクティビティコンテンツ用の URI を含むインテントフィルタをアプリマニフェストに追加すると、Android は、合致する URI を持つ Intent を実行時にアプリにルーティングできるようになります。

インテントフィルタの定義方法については、別のアプリからアクティビティを起動するのを許可するをご覧ください。

受信インテントからデータを読み取る

システムがインテントフィルタ経由でアクティビティを起動したら、データによって提供されるIntentを使用することで、アプリで何を表示する必要があるのか判断できます。 getData() メソッドと getAction() メソッドを呼び出して、受信 Intent に関連付けられているデータとアクションを取得します。メソッドの呼び出しは、アクティビティのライフサイクル中であれば、いつでも行うことができますが、通常は、早い段階のコールバックの間に行うことをおすすめします。onCreate()onStart

Intent からデータを取得する方法を以下のスニペットに示します。

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.main)

    val action: String? = intent?.action
    val data: Uri? = intent?.data
}

Java

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main);

    Intent intent = getIntent();
    String action = intent.getAction();
    Uri data = intent.getData();
}

ユーザーエクスペリエンスを向上させるには、次に示すおすすめの方法を採り入れます。

ディープリンクは、プロンプトや、インタースティシャルページ、ログインなしで、ユーザーをコンテンツに直接誘導する必要があります。ユーザーがそのアプリを以前に開いたことがない場合でも、アプリコンテンツを表示できるようにしてください。対象コンテンツの表示後に後続の操作をユーザーが行った場合や、ランチャーからアプリを開いた場合は、プロンプトを表示しても構いません。
ユーザーがディープリンク経由でアプリにアクセスした後、想定どおりに [戻る] ナビゲーションを実現できるように、[戻る] ボタンと [上へ] ボタンを使用したナビゲーションで説明されている設計ガイダンスに沿うようにしてください。

ディープリンクをテストする

Android Debug Bridge と Activity Manager（am）ツールを使用することで、ディープリンク用に指定したインテントフィルタ URI が、正しいアプリのアクティビティに解決されるかテストできます。デバイスまたはエミュレータに対して adb コマンドを実行できます。

adb でインテントフィルタ URI をテストする一般的な構文は、次のとおりです。

$ adb shell am start
        -W -a android.intent.action.VIEW
        -d <URI> <PACKAGE>

たとえば、指定 URI に関連付けられているターゲットアプリアクティビティを表示するコマンドは次のとおりです。

$ adb shell am start
        -W -a android.intent.action.VIEW
        -d "example://gizmos" com.example.android

注: ルートでプリミティブ型のコレクションを定義すると、自動生成されるディープリンク URL の形式は **basePath?colors={value**} になります。**@Serializable data class Product(val colors: List)**複数のクエリパラメータを含む URI（たとえば、 **basepath?colors=red&colors=blue**）を指定する場合は、アンパサンドをエスケープする必要があります（たとえば、**basepath?colors=red\&colors=blue**）。

設定したマニフェスト宣言とインテントハンドラは、アプリとウェブサイトの間の接続と、受信リンクの処理内容について定義しています。ただし、システムがアプリを URI セットのデフォルトハンドラとして扱うようにするには、この接続自体を検証するようにリクエストする必要があります。アプリリンクを検証するは、この検証機能を実装する方法について説明しています。

インテントやアプリリンクの詳細については、以下の参考リンクをご覧ください。

ディープリンクを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。