Apple ユニバーサルリンク

[アーティクル]
05/14/2024

Web サイトとモバイルアプリを接続し、Web サイト上のリンクによってモバイルアプリが起動し、モバイルアプリにコンテンツが表示されるようにするのが望ましい場合がよくあります。 "ディープリンク" とも呼ばれる "アプリリンク" は、モバイルデバイスが URL に応答し、URL で表されるコンテンツをモバイルアプリで起動できるようにする手法です。

Apple プラットフォームでは、ディープリンクは "ユニバーサルリンク" と呼ばれます。ユーザーがユニバーサルリンクをタップすると、システムは Safari や Web サイトを介したルーティングを使用せずに、リンクをアプリに直接リダイレクトします。これらのリンクでは、myappname:// などのカスタムスキームをベースにすることも、HTTP や HTTPS スキームを使用することもできます。たとえば、レシピの Web サイトのリンクをクリックすると、その Web サイトに関連付けられているモバイルアプリが開き、特定のレシピがユーザーに表示されます。アプリをインストールしていないユーザーは、Web サイト上のコンテンツに移動させられます。この記事では、HTTPS スキームを使用するユニバーサルリンクに重点を置きます。

.NET MAUI iOS アプリでは、ユニバーサルリンクがサポートされています。これには、アプリとのリレーションシップを記述するデジタル資産リンク JSON ファイルをドメイン上でホストする必要があります。これにより、Apple は、URL を処理しようとしているアプリが URL の所有権を持っていることを確認し、悪意のあるアプリがアプリリンクを妨害するのを防ぐことができます。

.NET MAUI iOS または Mac Catalyst アプリで Apple ユニバーサルリンクを処理するプロセスは以下のとおりです。

関連付けられたドメインファイルを Web サイト上に作成してホストする。詳細については、「関連付けられたドメインファイルを作成してホストする」を参照してください。
関連付けられたドメインエンタイトルメントをアプリに追加する。詳細については、「関連付けられたドメインエンタイトルメントをアプリに追加する」を参照してください。
Apple Developer アカウントで、関連付けられたドメイン機能をアプリのアプリ ID に追加します。詳細については、「関連付けられたドメイン機能をアプリ ID に追加する」を参照してください。
ユニバーサルリンクがアプリにルーティングされたときに、システムが提供するユーザーアクティビティオブジェクトに応答するようにアプリを更新する。詳細については、「ユニバーサルリンクに応答する」を参照してください。

詳細については、developer.apple.com の「アプリと Web サイトがコンテンツへのリンクを行うことの許可」を参照してください。アプリのカスタム URL スキームの定義については、developer.apple.com の「アプリのカスタム URL スキームの定義」を参照してください。

ユニバーサルリンクに応答する

ユーザーがユニバーサルリンクをアクティブにすると、iOS と Mac Catalyst によってアプリが起動され、それが NSUserActivity オブジェクトに送信されます。このオブジェクトにはクエリを実行して、アプリがどのように起動されたかを決定し、実行するべきアクションを決定することができます。これは、FinishedLaunching および ContinueUserActivity ライフサイクルデリゲートで実行する必要があります。 FinishedLaunching デリゲートはアプリの起動時に呼び出され、ContinueUserActivity デリゲートはアプリの実行中または中断時に呼び出されます。ライフサイクルデリゲートの詳細については、「プラットフォームライフサイクルイベント」を参照してください。

呼び出されている iOS ライフサイクルデリゲートに応答するには、MauiProgram クラスの CreateMauiapp メソッド内の MauiAppBuilder オブジェクトに対して ConfigureLifecycleEvents メソッドを呼び出します。次に、ILifecycleBuilder オブジェクトで AddiOS メソッドを呼び出して、必要なデリゲートのハンドラーを登録する Action を指定します。

using Microsoft.Maui.LifecycleEvents;
using Microsoft.Extensions.Logging;

namespace MyNamespace;

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp.CreateBuilder();
        builder
            .UseMauiApp<App>()
            .ConfigureFonts(fonts =>
            {
                fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
                fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
            })
            .ConfigureLifecycleEvents(lifecycle =>
            {
#if IOS || MACCATALYST
                lifecycle.AddiOS(ios =>
                {
                    // Universal link delivered to FinishedLaunching after app launch.
                    ios.FinishedLaunching((app, data) => HandleAppLink(app.UserActivity));

                    // Universal link delivered to ContinueUserActivity when the app is running or suspended.
                    ios.ContinueUserActivity((app, userActivity, handler) => HandleAppLink(userActivity));

                    // Only required if using Scenes for multi-window support.
                    if (OperatingSystem.IsIOSVersionAtLeast(13) || OperatingSystem.IsMacCatalystVersionAtLeast(13))
                    {
                        // Universal link delivered to SceneWillConnect after app launch
                        ios.SceneWillConnect((scene, sceneSession, sceneConnectionOptions)
                            => HandleAppLink(sceneConnectionOptions.UserActivities.ToArray()
                                .FirstOrDefault(a => a.ActivityType == Foundation.NSUserActivityType.BrowsingWeb)));

                        // Universal link delivered to SceneContinueUserActivity when the app is running or suspended
                        ios.SceneContinueUserActivity((scene, userActivity) => HandleAppLink(userActivity));
                    }
                });
#endif
            });

#if DEBUG
        builder.Logging.AddDebug();
#endif

        return builder.Build();
    }

#if IOS || MACCATALYST
    static bool HandleAppLink(Foundation.NSUserActivity? userActivity)
    {
        if (userActivity is not null && userActivity.ActivityType == Foundation.NSUserActivityType.BrowsingWeb && userActivity.WebPageUrl is not null)
        {
            HandleAppLink(userActivity.WebPageUrl.ToString());
            return true;
        }
        return false;
    }
#endif

    static void HandleAppLink(string url)
    {
        if (Uri.TryCreate(url, UriKind.RelativeOrAbsolute, out var uri))
            App.Current?.SendOnAppLinkRequestReceived(uri);
    }
}

ユニバーサルリンクの結果として iOS によってアプリが開かれると、NSUserActivity オブジェクトの ActivityType プロパティの値は BrowsingWeb になります。アクティビティオブジェクトの WebPageUrl プロパティには、ユーザーがアクセスしようとしている URL が含まれます。この URL は、SendOnAppLinkRequestReceived メソッドを使用して App クラスに渡すことができます。

Note

アプリで複数ウィンドウのサポートに Scenes を使用していない場合は、Scene メソッドのライフサイクルハンドラーを省略できます。

App クラスで、以下のように OnAppLinkRequestReceived メソッドをオーバーライドし、URL を受け取って処理します。

namespace MyNamespace;

public partial class App : Application
{
    public App()
    {
        InitializeComponent();

        MainPage = new AppShell();
    }

    protected override async void OnAppLinkRequestReceived(Uri uri)
    {
        base.OnAppLinkRequestReceived(uri);

        // Show an alert to test that the app link was received.
        await Dispatcher.DispatchAsync(async () =>
        {
            await Windows[0].Page!.DisplayAlert("App link received", uri.ToString(), "OK");
        });

        Console.WriteLine("App link: " + uri.ToString());
    }
}

上記の例では、OnAppLinkRequestReceived のオーバーライドによってアプリリンク URL が表示されます。実際には、アプリリンクは、プロンプト、ログイン、その他の中断なしで、URL で表されるコンテンツにユーザーを直接移動させる必要があります。したがって、OnAppLinkRequestReceived のオーバーライドは、URL で表されるコンテンツへのナビゲーションを呼び出すための場所です。

警告

ユニバーサルリンクは、アプリに潜在的な攻撃ベクトルを与えるため、すべての URL パラメーターを検証し、形式に誤りがある URL はすべて破棄するように注意してください。

詳細については、developer.apple.com の「アプリでのユニバーサルリンクのサポート」を参照してください。

ユニバーサルリンクをテストする

重要

iOS では、シミュレーター上ではなくデバイス上でユニバーサルリンクをテストする必要があります。

ユニバーサルリンクをテストするには、Notes アプリにリンクを貼り付けてそれを長押しするか (iOS の場合)、control キーを押しながらクリックして (macOS の場合)、リンクをフォローするための選択肢を確認します。ユニバーサルリンクが正しく構成されている場合は、アプリと Safari で開くための選択肢が表示されます。ここでの選択によって、デバイス上でこのドメインからユニバーサルリンクをフォローする際の既定の動作が設定されます。この既定の選択を変更するには、手順を繰り返し、別の選択を行います。

Note

Safari に URL を入力しても、アプリが開くことはありません。代わりに、Safari はこのアクションを直接のナビゲーションとして捉えます。ユーザーが直接移動してドメイン上にいる場合、サイトはアプリを開くためのバナーを表示します。

iOS では、以下のように開発者設定で関連するドメイン診断テストを使用してユニバーサルリンクをテストできます。

[設定] で開発者モードを有効にします。詳細については、developer.apple.com の「デバイスでの開発者モードの有効化」を参照してください。
[設定] > [開発者] で、[ユニバーサルリンク] までスクロールして [関連付けられたドメイン開発] を有効にします。
[診断] を開き、URL を入力します。するとインストールされたアプリでリンクが有効かどうかについてのフィードバックが提供されます。

多くの場合、無効なユニバーサルリンクは、applinks が誤って構成されていることが原因です。

トラブルシューティングのアドバイスについては、developer.apple.com の「ユニバーサルリンクのデバッグ」を参照してください。

次の方法で共有

Apple ユニバーサルリンク

関連付けられたドメインファイルを作成してホストする

関連付けられたドメインエンタイトルメントをアプリに追加する

関連付けられたドメイン機能をアプリ ID に追加する

ユニバーサルリンクに応答する

ユニバーサルリンクをテストする

その他のリソース

次の方法で共有

Apple ユニバーサル リンク

関連付けられたドメイン ファイルを作成してホストする

関連付けられたドメイン エンタイトルメントをアプリに追加する

関連付けられたドメイン機能をアプリ ID に追加する

ユニバーサル リンクに応答する

ユニバーサル リンクをテストする

その他のリソース

Apple ユニバーサルリンク

関連付けられたドメインファイルを作成してホストする

関連付けられたドメインエンタイトルメントをアプリに追加する

ユニバーサルリンクに応答する

ユニバーサルリンクをテストする