アプリケーションインデックス作成とディープリンク作成

[アーティクル]
07/13/2023

Xamarin.Forms のアプリケーションインデックス作成とディープリンクの設定では、ユーザーがアプリケーション間を移動するときにアプリケーションインデックス作成用のメタデータを発行する API が提供されます。インデックスが付けられたコンテンツは、Spotlight 検索、Google 検索、または Web 検索で検索することができます。ディープリンクが含まれている検索結果をタップすると、アプリケーションによって処理できるイベントが開始されます。これは、通常、ディープリンクから参照されているページに移動するために使用されます。

サンプルアプリケーションは、次のスクリーンショットに示すように、データがローカルの SQLite データベースに格納される Todo リストアプリケーションの例です。

TodoList Application

ユーザーによって作成された各 TodoItem インスタンスにインデックスが付けられます。これにより、プラットフォーム固有の検索を使用して、アプリケーションからインデックス付きのデータを特定できるようになります。アプリケーションに関する検索結果の項目をユーザーがタップすると、そのアプリケーションが起動し、TodoItemPage に移動し、ディープリンクから参照された TodoItem が表示されます。

SQLite データベースの使用の詳細については、「Xamarin.Forms ローカルデータベース」を参照してください。

Note

Xamarin.Forms のアプリケーションインデックス作成およびディープリンクの設定の機能は、iOS および Android プラットフォーム上でのみ使用することができ、そのためにはそれぞれ iOS 9 以上および API 23 以上が必要です。

段取り

次のセクションでは、iOS および Android プラットフォーム上でこの機能を使用する上で必要な追加のセットアップ手順を説明します。

iOS

iOS プラットフォーム上では、バンドルに署名するためのカスタムのエンタイトルメントファイルとして Entitlements.plist ファイルがご利用の iOS プラットフォームプロジェクトによって設定されていることを確認します。

iOS ユニバーサルリンクを使用するには:

applinks キーを使用して関連付けられているドメインのエンタイトルメントをご利用のアプリに追加します。そのアプリでサポートされるすべてのドメインが対象となります。
ご利用の Web サイトに Apple アプリサイトの関連ファイルを追加します。
その Apple アプリサイトの関連ファイルに applinks キーを追加します。

詳細については、developer.apple.com に掲載されている「Allowing Apps and Websites to Link to Your Content」(アプリおよび Web サイトから自分のコンテンツへのリンクを許可) を参照してください。

Android

Android プラットフォーム上でアプリケーションインデックス作成およびディープリンクの設定の機能を使用するためには、複数の前提条件を満たす必要があります。

ご利用のアプリケーションのバージョンが Google Play で動作状態にある必要があります。
Google の開発者コンソール内で、アプリケーションに対してコンパニオン Web サイトを登録する必要があります。アプリケーションが Web サイトに関連付けられたら、URL にインデックスを付けて Web サイトとアプリケーションの両方で使用できます。これにより、検索結果に提供されるようになります。詳細については、Google の Web サイト上の「Google 検索での App Indexing」を参照してください。
ご利用のアプリケーションでは、MainActivity クラス上の HTTP URL インテントがサポートされている必要があります。これにより、アプリケーションが応答可能な URL データスキームの種類がアプリケーションインデックス作成に指示されます。詳細については、「Configuring the Intent Filter」(インテントフィルタの構成) を参照してください。

これらの前提条件が満たされたら、Android プラットフォーム上で Xamarin.Forms のアプリケーションインデックス作成およびディープリンクの設定を使用するために、以下のような追加のセットアップが必要です。

Xamarin.Forms.AppLinks NuGet パッケージを Android アプリケーションプロジェクトにインストールします。
MainActivity.cs ファイル内に、Xamarin.Forms.Platform.Android.AppLinks 名前空間を使用するための宣言を追加します。
MainActivity.cs ファイル内に、Firebase 名前空間を使用するための宣言を追加します。
Web ブラウザーで、Firebase Console を介して新しいプロジェクトを作成します。
Firebase Console で、ご利用の Android アプリに Firebase を追加し、必要なデータを入力します。
結果として生成された google-services.json ファイルをダウンロードします。
google-services.json ファイルを、Android プロジェクトのルートディレクトリに追加し、そのビルドアクションを GoogleServicesJson に設定します。
MainActivity.OnCreate オーバーライド内で、Forms.Init(this, bundle) の下に次のコード行を追加します。

FirebaseApp.InitializeApp(this);
AndroidAppLinks.Init(this);

google-services.json をプロジェクトに追加 (および GoogleServicesJson* ビルドアクションを設定) すると、ビルドプロセスによって、クライアント ID と API キーが抽出され、さらにこれらの資格情報が、生成されたマニフェストファイルに追加されます。

Note

この記事では、多くの場合、アプリケーションリンクとディープリンクという用語が同じ意味で使用されます。しかし、Android に関しては、これらの用語は異なる意味を持ちます。 Android の場合、ディープリンクとは、ユーザーがそのアプリで特定のアクティビティに直接移行できるようにするためのインテントフィルターのことです。ディープリンクをクリックすると、あいまいさ排除のためのダイアログが表示されることがあります。これにより、ユーザーはその URL を処理できる複数のアプリのいずれかを選択できます。 Android のアプリリンクは、Web サイトの URL に基づくディープリンクです。これは Web サイトに属することが検証済みです。アプリリンクをクリックすると、アプリがインストールされている場合はアプリが開き、あいまいさ排除のダイアログが開くことはありません。

詳細については、Xamarin ブログの Xamarin.Forms URL ナビゲーションを使用したディープリンクコンテンツに関するページを参照してください。

ページのインデックス作成

ページのインデックスを作成し、それを Google および Spotlight 検索に公開するプロセスは次のとおりです。

ページのインデックス作成に必要なメタデータを含む AppLinkEntry と、ユーザーが検索結果内のインデックス付けされたコンテンツを選択したときにページに戻るためのディープリンクを作成します。
AppLinkEntry インスタンスを登録し、検索できるようにそれにインデックスを付けます。

次のコード例では、AppLinkEntry インスタンスを作成する方法について示します。

AppLinkEntry GetAppLink(TodoItem item)
{
    var pageType = GetType().ToString();
    var pageLink = new AppLinkEntry
    {
        Title = item.Name,
        Description = item.Notes,
        AppLinkUri = new Uri($"http://{App.AppName}/{pageType}?id={item.ID}", UriKind.RelativeOrAbsolute),
        IsLinkActive = true,
        Thumbnail = ImageSource.FromFile("monkey.png")
    };

    pageLink.KeyValues.Add("contentType", "TodoItemPage");
    pageLink.KeyValues.Add("appName", App.AppName);
    pageLink.KeyValues.Add("companyName", "Xamarin");

    return pageLink;
}

AppLinkEntry インスタンスには、ページのインデックス作成およびディープリンクの作成に必要な値が格納された複数のプロパティが含まれています。 Title、Description、Thumbnail の各プロパティは、検索結果内にインデックス付きのコンテンツが表示された場合にそれを識別するために使用されます。 IsLinkActive プロパティは true に設定されます。これは、インデックス付きのコンテンツが現在表示されていることを示します。 AppLinkUri プロパティは、現在のページに戻るため、および現在の TodoItem を表示するために必要な情報が含まれる Uri です。次の例には、サンプルアプリケーションの Uri 例が示されています。

http://deeplinking/DeepLinking.TodoItemPage?id=2

この Uri には、deeplinking アプリを起動し、DeepLinking.TodoItemPage に移動し、ID が 2 である TodoItem を表示するために必要な情報がすべて含まれています。

インデックス作成のためのコンテンツの登録

AppLinkEntry インスタンスが作成されたら、検索結果に表示されるようにするためのインデックス作成に備えてそれを登録する必要があります。これは、次のコード例に示すように、RegisterLink メソッドを使用して行われます。

Application.Current.AppLinks.RegisterLink (appLink);

これにより、AppLinkEntry インスタンスがアプリケーションの AppLinks コレクションに追加されます。

Note

RegisterLink メソッドを使用することで、インデックスが付けられたページのコンテンツを更新することもできます。

インデックス作成のために AppLinkEntry インスタンスが登録されると、それを検索結果に表示できるようになります。次のスクリーンショットは、iOS プラットフォームでの検索結果に表示されているインデックス付きコンテンツの例です。

インデックス付きコンテンツの登録を解除する

DeregisterLink メソッドは、次のコード例に示すように、検索結果からインデックス付けされたコンテンツを削除するために使用されます。

Application.Current.AppLinks.DeregisterLink (appLink);

これにより、アプリケーションの AppLinks コレクションから AppLinkEntry インスタンスが削除されます。

Note

Android 上では、インデックス付けされたコンテンツを検索結果から削除することはできません。

ディープリンクへの応答

インデックス付きコンテンツが検索結果に表示され、それをユーザーが選択すると、インデックス付きコンテンツに含まれている Uri を処理するための要求がアプリケーションの App クラスによって受信されます。この要求は、次のコード例に示すように、OnAppLinkRequestReceived オーバーライド内で処理できます。

public class App : Application
{
    ...
    protected override async void OnAppLinkRequestReceived(Uri uri)
    {
        string appDomain = "http://" + App.AppName.ToLowerInvariant() + "/";
        if (!uri.ToString().ToLowerInvariant().StartsWith(appDomain, StringComparison.Ordinal))
            return;

        string pageUrl = uri.ToString().Replace(appDomain, string.Empty).Trim();
        var parts = pageUrl.Split('?');
        string page = parts[0];
        string pageParameter = parts[1].Replace("id=", string.Empty);

        var formsPage = Activator.CreateInstance(Type.GetType(page));
        var todoItemPage = formsPage as TodoItemPage;
        if (todoItemPage != null)
        {
            var todoItem = await App.Database.GetItemAsync(int.Parse(pageParameter));
            todoItemPage.BindingContext = todoItem;
            await MainPage.Navigation.PushAsync(formsPage as Page);
        }
        base.OnAppLinkRequestReceived(uri);
    }
}

受信した Uri を解析して移動先のページおよびページに渡すパラメーターを特定する前に、その Uri がアプリケーションを対象とするものかどうかが、OnAppLinkRequestReceived メソッドによって確認されます。移動先のページのインスタンスが作成され、ページパラメーターによって表現される TodoItem が取得されます。次に、移動先であるページの BindingContext が TodoItem に設定されます。これにより、PushAsync メソッドによって TodoItemPage が表示されると、ディープリンクに含まれている ID を持つ TodoItem が確実に表示されます。

Search インデックス処理でコンテンツを利用できるようにする

ディープリンクによって表されるページが表示されるたびに、AppLinkEntry.IsLinkActive プロパティを true に設定することができます。 iOS と Android では、これによって、Search インデックス処理で AppLinkEntry インスタンスが有効になります。また、iOS の場合のみ、ハンドオフに対しても AppLinkEntry インスタンスが有効になります。ハンドオフの詳細については、ハンドオフの概要に関するページを参照してください。

Page.OnAppearing オーバーライド内で、AppLinkEntry.IsLinkActive プロパティを true に設定するコード例を次に示します。

protected override void OnAppearing()
{
    appLink = GetAppLink(BindingContext as TodoItem);
    if (appLink != null)
    {
        appLink.IsLinkActive = true;
    }
}

同様に、ディープリンクによって表されるページから離れるときに、AppLinkEntry.IsLinkActive プロパティを false に設定することができます。 iOS と Android では、これによって、Search インデックス処理に対する AppLinkEntry インスタンスの公開が停止されます。また、iOS の場合のみ、ハンドオフに対する AppLinkEntry インスタンスの公開が停止されます。これは、次のコード例に示すように、Page.OnDisappearing オーバーライド内で達成できます。

protected override void OnDisappearing()
{
    if (appLink != null)
    {
        appLink.IsLinkActive = false;
    }
}

ハンドオフにデータを提供する

iOS 上では、ページのインデックスを作成するとき、アプリケーション固有のデータを格納することができます。これを実現するには、KeyValues コレクションにデータを追加します。これは、ハンドオフに使用されるキーと値のペアを格納するための Dictionary<string, string> です。ハンドオフは、ユーザーが自分のデバイスのいずれかでアクティビティを開始し、自分の別のデバイス (ユーザーの iCloud アカウントによって識別される) でそのアクティビティを継続するための方法です。次のコードは、アプリケーション固有のキーと値のペアを格納する例です。

var pageLink = new AppLinkEntry
{
    ...
};
pageLink.KeyValues.Add("appName", App.AppName);
pageLink.KeyValues.Add("companyName", "Xamarin");

KeyValues コレクションに格納された値は、インデックス付きページのメタデータに格納され、ディープリンクが含まれている検索結果をユーザーがタップしたとき (または、別のサインインデバイス上のコンテンツを表示するためにハンドオフが使用されたとき) に復元されます。

さらに、次のキーの値を指定できます。

contentType – インデックス付きのコンテンツの uniform 型識別子を指定する string。この値に対して使用が推奨される規約は、インデックス付きコンテンツが含まれるページの型名です。
associatedWebPage – Web 上でインデックス付きコンテンツも表示できる場合、またはアプリケーションによって Safari のディープリンクがサポートされている場合にアクセスする Web ページを表す string。
shouldAddToPublicIndex – true または false のいずれか string。これにより、インデックス付きコンテンツを Apple のパブリッククラウドインデックスに追加するかどうかが制御されます。それは自分の iOS デバイス上にアプリケーションをインストールしていないユーザーに提供することができます。ただし、パブリックインデックス作成に対してコンテンツが設定されているからといって、Apple のパブリッククラウドインデックスにそれが自動的に追加されることを意味するものではありません。詳細については、パブリック Search インデックス処理に関するページを参照してください。個人データを KeyValues コレクションに追加する場合は、このキーを false に設定する必要があることに注意してください。

Note

KeyValues コレクションは、Android プラットフォームでは使用されません。

ハンドオフの詳細については、ハンドオフの概要に関するページを参照してください。

アプリケーション インデックス作成とディープ リンク作成

段取り

iOS

Android

ページのインデックス作成

インデックス作成のためのコンテンツの登録

インデックス付きコンテンツの登録を解除する

ディープ リンクへの応答

Search インデックス処理でコンテンツを利用できるようにする

ハンドオフにデータを提供する

関連リンク

その他のリソース

アプリケーションインデックス作成とディープリンク作成

ディープリンクへの応答