Anwendungsindizierung und Deep Linking

Artikel
07/13/2023

Download Sample Das Beispiel herunterladen

Anwendungsindizierung und Deep Linking von Xamarin.Forms stellen eine API für die Veröffentlichung von Metadaten für die Anwendungsindizierung bereit, wenn Benutzer durch Anwendungen navigieren. In der Spotlight-Suche, der Google-Suche oder in einer Websuche kann dann nach indizierten Inhalten gesucht werden. Durch das Tippen auf ein Suchergebnis, das einen Deep-Link enthält, wird ein Ereignis ausgelöst, das von einer Anwendung verarbeitet werden kann und in der Regel zum Navigieren zu der Seite verwendet wird, auf welche der Deep-Link verweist.

In dieser Beispielanwendung wird eine Anwendung mit Aufgabenlisten (ToDoList) veranschaulicht, bei der die Daten in einer lokalen SQLite-Datenbank gespeichert sind, wie aus den folgenden Screenshots hervorgeht:

TodoList Application

Jede vom Benutzer erstellte TodoItem-Instanz wird indiziert. Anschließend kann die plattformspezifische Suche zum Auffinden der indizierten Daten aus der Anwendung verwendet werden. Wenn der Benutzer in den Suchergebnissen auf ein Element für die Anwendung tippt, wird die Anwendung gestartet, die Seite TodoItemPage wird aufgerufen, und die TodoItem-Instanz, auf die der Deep-Link verweist, wird angezeigt.

Weitere Informationen zur Verwendung einer SQLite-Datenbank finden Sie unter Lokale Datenbanken von Xamarin.Forms.

Hinweis

Die Funktion für Anwendungsindizierung und Deep Linking von Xamarin.Forms ist nur auf iOS- und Android-Plattformen verfügbar und setzt mindestens iOS 9 bzw. API 23 voraus.

Setup

Die folgenden Abschnitte enthalten alle weiteren Installationsanweisungen für die Verwendung dieses Features auf iOS- und Android-Plattformen.

iOS

Stellen Sie auf der iOS-Plattform sicher, dass in Ihrem iOS-Projekt die Datei Entitlements.plist als benutzerdefinierte Berechtigungsdatei für die Signatur des Pakets festgelegt ist.

So verwenden Sie universelle iOS-Links

Fügen Sie Ihrer App die Berechtigung „Zugehörige Bereiche“ mit dem Schlüssel applinks und allen Domänen, die Ihre App unterstützen soll, hinzu.
Fügen Sie Ihrer Website eine AASA-Datei (Apple App Site Association) hinzu.
Fügen Sie der AASA-Datei den Schlüssel applinks hinzu.

Weitere Informationen finden Sie unter Allowing Apps and Websites to Link to Your Content (Apps und Websites die Verknüfung mit Ihren Inhalten erlauben) auf developer.apple.com.

Android

Auf der Android-Plattform sind eine Reihe von Voraussetzungen zu erfüllen, bevor Sie die Funktion „Anwendungsindizierung und Deep Linking“ verwenden können:

Eine Version der Anwendung muss in Google Play aktiv sein.
Eine begleitende Website muss für die Anwendung in der Google Developers Console registriert sein. Sobald die Anwendung einer Website zugeordnet ist, können URLs indiziert werden, die sowohl für die Website als auch die Anwendung gelten und dann in den Suchergebnissen bereitgestellt werden können. Weitere Informationen finden Sie auf der Google-Website App-Indexierung für die Google-Suche.
Ihre Anwendung muss HTTP-URL-Intents für die MainActivity-Klasse unterstützen, die der Anwendungsindizierung mitteilen, auf welche Art von URL-Datenschemas die Anwendung reagieren kann. Weitere Informationen finden Sie unter Konfigurieren des Intent-Filters.

Wenn diese Voraussetzungen erfüllt sind, ist die folgende zusätzliche Konfiguration erforderlich, um Anwendungsindizierung und Deep Linking von Xamarin.Forms auf der Android-Plattform zu verwenden:

Installieren Sie das NuGet-Paket Xamarin.Forms.AppLinks im Android-Anwendungsprojekt.
Fügen Sie in der Datei MainActivity.cs eine Deklaration zur Verwendung des Namespace Xamarin.Forms.Platform.Android.AppLinks hinzu.
Fügen Sie in der Datei MainActivity.cs eine Deklaration zur Verwendung des Namespace Firebase hinzu.
Erstellen Sie in einem Webbrowser über die Firebase-Konsole ein neues Projekt.
Fügen Sie in der Firebase-Konsole Firebase zu Ihrer Android-App hinzu, und geben Sie die erforderlichen Daten ein.
Laden Sie die resultierende Datei google-services.json herunter.
Fügen Sie die Datei google-services.json im Stammverzeichnis des Android-Projekts hinzu, und legen Sie den Buildvorgang auf GoogleServicesJson fest.
Fügen Sie in der MainActivity.OnCreate-Methodenüberschreibung unter Forms.Init(this, bundle) die folgende Codezeile hinzu:

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

Wenn die Datei google-services.json dem Projekt hinzugefügt wird (und der Buildvorgang auf GoogleServicesJson* festgelegt ist), extrahiert der Buildvorgang die Client-ID und den API-Schlüssel und fügt dann diese Anmeldeinformationen der generierten Manifestdatei hinzu.

Hinweis

In diesem Artikel werden die Begriffe Anwendungslinks und Deep-Links oft synonym verwendet. Unter Android haben diese Begriffe jedoch jeweils eine andere Bedeutung. Unter Android ist ein Deep-Link ein Intent-Filter, der es Benutzern ermöglicht, eine bestimmte Aktivität in der App direkt einzugeben. Wenn Sie auf einen Deep-Link klicken, wird ggf. ein Dialogfeld mit mehrere Apps zur Auswahl angezeigt, aus der der Benutzer die auswählen kann, die die URL verarbeiten können. Ein Android-App-Link ist ein Deep-Link, der auf Ihrer Website-URL basiert, und dessen Zugehörigkeit zu Ihrer Website überprüft wurde. Wenn Sie auf einen App-Link klicken, wird die App geöffnet, wenn sie installiert ist, ohne dass ein Dialogfeld mit Auswahlmöglichkeiten anzeigt wird.

Weitere Informationen finden Sie im Xamarin-Blog unter Deep Linking von Inhalten mit der URL-Navigation von Xamarin.Forms.

Indizierung einer Seite

Folgender Vorgang wird zum Indizieren einer Seite und zum Offenlegen für die Google- und Spotlight-Suche verwendet:

Erstellen Sie eine AppLinkEntry-Klasse, die die zum Indizieren der Seite erforderlichen Metadaten und einen Deep-Link enthält, der auf die Seite zurückverweist, wenn der Benutzer den indizierten Inhalt in den Suchergebnissen auswählt.
Registrieren Sie die AppLinkEntry-Instanz, um sie für die Suche zu indizieren.

Im folgenden Codebeispiel wird veranschaulicht, wie Sie eine AppLinkEntry-Instanz erstellen:

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

Die AppLinkEntry-Instanz enthält eine Reihe von Eigenschaften, deren Werte erforderlich sind, um die Seite zu indizieren und einen Deep-Link zu erstellen. Die Eigenschaften Title, Description und Thumbnail werden zum Identifizieren des indizierten Inhalts verwendet, wenn er in den Suchergebnissen angezeigt wird. Die IsLinkActive-Eigenschaft wird auf true festgelegt, um anzugeben, dass der indizierte Inhalt derzeit angezeigt wird. Die AppLinkUri-Eigenschaft ist ein Uri und enthält die Informationen, die für die Rückkehr zur aktuellen Seite und zum Anzeigen der aktuellen TodoItem-Instanz erforderlich sind. Das folgende Beispiel zeigt einen Beispiel-Uri für die Beispielanwendung:

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

Dieser Uri enthält alle Informationen, die zum Starten der deeplinking-App, zum Navigieren zur Seite DeepLinking.TodoItemPage und zum Anzeigen der TodoItem-Instanz mit der ID = 2 erforderlich sind.

Registrieren von Inhalt für die Indizierung

Wenn eine AppLinkEntry-Instanz erstellt wurde, muss sie für die Indizierung registriert werden, damit sie in den Suchergebnissen angezeigt wird. Dies erfolgt mit der RegisterLink-Methode, wie aus dem folgenden Codebeispiel hervorgeht:

Application.Current.AppLinks.RegisterLink (appLink);

Dadurch wird die AppLinkEntry-Instanz der AppLinks-Sammlung der Anwendung hinzugefügt.

Hinweis

Mit der RegisterLink-Methode können Sie auch den für eine Seite indizierten Inhalt aktualisieren.

Wenn Sie die AppLinkEntry-Instanz für die Indizierung registriert haben, kann sie in den Suchergebnissen angezeigt werden. Der folgende Screenshot zeigt den indizierten Inhalt, wie er auf der iOS-Plattform in den Suchergebnissen angezeigt wird:

Aufheben der Registrierung von indizierten Inhalten

Mit der DeregisterLink-Methode können Sie indizierte Inhalte aus den Suchergebnissen entfernen, wie aus dem folgenden Codebeispiel hervorgeht:

Application.Current.AppLinks.DeregisterLink (appLink);

Dadurch wird die AppLinkEntry-Instanz aus der AppLinks-Sammlung der Anwendung entfernt.

Hinweis

Unter Android ist es nicht möglich, indizierten Inhalt aus den Suchergebnissen zu entfernen.

Reagieren auf einen Deep-Link

Wenn indizierter Inhalt in den Suchergebnissen angezeigt und von einem Benutzer ausgewählt wird, erhält die App-Klasse für die Anwendung eine Anforderung zum Verarbeiten des Uri, der in dem indizierten Inhalt enthalten ist. Diese Anforderung kann in der OnAppLinkRequestReceived-Methodenüberschreibung verarbeitet werden, wie im folgenden Codebeispiel gezeigt:

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

Die OnAppLinkRequestReceived-Methode überprüft, ob der empfangene Uri für die Anwendung bestimmt ist. Erst dann analysiert sie die Seite, zu der mit dem Uri navigiert werden soll, und den Parameter, welcher der Seite übergeben werden soll. Es wird eine Instanz der Seite erstellt, zu der navigiert werden soll, und die vom Seitenparameter dargestellte TodoItem-Instanz wird abgerufen. BindingContext wird auf der Seite, zu der navigiert werden soll, auf TodoItem gesetzt. So wird sichergestellt, dass bei der Anzeige von TodoItemPage mit der PushAsync-Methode die TodoItem-Instanz angezeigt wird, deren ID sich im Deep-Link befindet.

Bereitstellen von Inhalt für die Suchindizierung

Jedes Mal, wenn die durch einen Deep-Link dargestellte Seite angezeigt wird, kann die AppLinkEntry.IsLinkActive-Eigenschaft auf true festgelegt werden. Unter iOS und Android wird dadurch die AppLinkEntry-Instanz für die Suchindizierung bereitgestellt. Nur unter iOS wird zusätzlich auch die AppLinkEntry-Instanz für das Handoff verfügbar gemacht. Weitere Informationen zum Handoff finden Sie unter Handoff in Xamarin.iOS.

Das folgende Codebeispiel zeigt, wie die AppLinkEntry.IsLinkActive-Eigenschaft in der Page.OnAppearing-Methodenüberschreibung auf true festgelegt wird:

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

In ähnlicher Weise kann die AppLinkEntry.IsLinkActive-Eigenschaft auf false festgelegt werden, wenn bei der Navigation die von einem Deep-Link dargestellte Seite verlassen wird. Unter iOS und Android wird dadurch die Ankündigung der AppLinkEntry-Instanz für die Suchindizierung beendet. Nur unter iOS wird zusätzlich auch die Ankündigung der AppLinkEntry-Instanz für das Handoff beendet. Dies kann in der Page.OnDisappearing-Methodenüberschreibung verarbeitet werden, wie im folgenden Codebeispiel gezeigt:

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

Bereitstellen von Daten für das Handoff

Unter iOS können anwendungsspezifische Daten beim Indizieren der Seite gespeichert werden. Dies erfolgt durch Hinzufügen von Daten zur KeyValues-Sammlung, ein Dictionary<string, string> zum Speichern von Schlüssel-Wert-Paaren, die beim Handoff verwendet werden. „Handoff“ ist eine Funktion, mit welcher der Benutzer eine Aktivität auf einem seiner Geräte beginnen und auf einem anderen Gerät (nach Identifizierung durch das iCloud-Benutzerkonto) fortsetzen kann. Der folgende Code zeigt ein Beispiel für das Speichern von anwendungsspezifischen Schlüssel-Wert-Paaren:

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

In der KeyValues-Sammlung gespeicherte Werte werden in den Metadaten für die indizierte Seite gespeichert und wiederhergestellt, wenn der Benutzer auf ein Suchergebnis tippt, das einen Deep-Link enthält (oder wenn er zum Anzeigen des Inhalts auf einem anderen angemeldeten Gerät die Handoff-Funktion verwendet).

Darüber hinaus können Werte für die folgenden Schlüssel angegeben werden:

contentType: Ein string zur Angabe des einheitlichen Typbezeichners des indizierten Inhalts. Die empfohlene Konvention für die Verwendung dieses Werts ist der Typname der Seite, die den indizierten Inhalt enthält.
associatedWebPage: Ein string, der die zu besuchende Webseite darstellt, wenn der indizierte Inhalt auch im Web angezeigt werden kann, oder wenn die Anwendung Deep-Links von Safari unterstützt.
shouldAddToPublicIndex: Ein string mit dem Wert true oder false, der steuert, ob der indizierte Inhalt dem Index der öffentlichen iCloud von Apple hinzugefügt werden soll, der dann auch Benutzern angezeigt wird, welche die Anwendung nicht auf ihrem iOS-Gerät installiert haben. Auch wenn Sie Inhalte für die öffentliche Indizierung festgelegt haben, bedeutet das nicht, dass sie automatisch dem Index der öffentlichen iCloud von Apple hinzugefügt werden. Weitere Informationen finden Sie unter Indizieren für die öffentliche Suche. Beachten Sie, dass dieser Schlüssel auf false festgelegt werden sollte, wenn Sie der KeyValues-Sammlung persönliche Daten hinzufügen.

Hinweis

Die KeyValues-Sammlung wird auf der Android-Plattform nicht verwendet.

Weitere Informationen zum Handoff finden Sie unter Handoff in Xamarin.iOS.

Anwendungsindizierung und Deep Linking

Setup

iOS

Android

Indizierung einer Seite

Registrieren von Inhalt für die Indizierung

Aufheben der Registrierung von indizierten Inhalten

Reagieren auf einen Deep-Link

Bereitstellen von Inhalt für die Suchindizierung

Bereitstellen von Daten für das Handoff

Verwandte Links

Zusätzliche Ressourcen