Windows Suchanbieter für die Websuche

Windows Suche verwendet derzeit die Websuche aus Microsoft Bing App, um Webinhalte und Suchergebnisse zurückzugeben. Im Europäischen Wirtschaftsraum (EWR) können Sie Apps installieren, die einen Websuchanbieter implementieren, um Webinhalte und Suchergebnisse in Windows Suche zurückzugeben.

Screenshot der Windows-Benutzeroberfläche mit Integration von Drittanbieter-Suchanbietern.

Suchanbieter sind in die Suchumgebung integriert, indem Sie ein MSIX-Paket mit einer Paketmanifestdatei erstellen, die die erforderlichen Informationen für das Betriebssystem zum Registrieren des Suchanbieters bereitstellt. Nach der Installation ist der Suchanbieter in Windows Suchfunktionen standardmäßig aktiviert. In Windows Einstellungen können Benutzer installierte Suchanbieter aktivieren und deaktivieren und die Reihenfolge der Anbieter in Suchergebnissen verwalten. Benutzer können einen Suchanbieter über die Seite Settings > Apps > Installed apps in Windows Einstellungen entfernen.

Wenn der Entwicklermodus aktiviert ist und die Suchanbieter-App auf dem Gerät quergeladen wurde, wird sie zu Entwicklungs- und Testzwecken in der Liste der verfügbaren Suchanbieter angezeigt. Weitere Informationen finden Sie unter "Einstellungen für Entwickler".

Sobald der Suchanbieter beim Betriebssystem registriert ist, werden Benutzerabfragen mithilfe einer standardisierten Abfragezeichenfolge an den vom Anbieter im Paketmanifest angegebenen HTTP-Endpunkt übergeben. Der Endpunkt gibt vorgeschlagene Ergebnisse in einem JSON-Dokument zurück. Bei jeder vorgeschlagenen URL im Antwortdokument enthält der Suchanbieter die Vorschauendpunkt-URL, die ein HTML-Dokument zurückgibt, das im Vorschaubereich in der Benutzeroberfläche der Suchergebnisse angezeigt wird.

Dieser Artikel enthält Anleitungen zum Erstellen eines Suchanbieter-App-Pakets und Details zu den Protokollen für die Implementierung von HTTP-Endpunkten des Suchanbieters.

Erstellen eines Sucherweiterungs-App-Pakets

Suchanbieter registrieren sich beim Betriebssystem, indem sie ein MSIX-Paket bereitstellen, das erforderliche Informationen zum Anbieter enthält, z. B. den Namen des Suchanbieters und die HTTP-Endpunkte für Vorschläge und Vorschauen.

Suchanbieter-App-Erweiterung

Die App-Paketmanifestdatei unterstützt viele verschiedene Erweiterungen und Features für Windows Apps. Das Format des App-Paketmanifests wird durch eine Reihe von Schemas definiert, die in der Paketmanifestschemareferenz dokumentiert sind. Suchanbieter deklarieren ihre Registrierungsinformationen innerhalb der uap3:AppExtension. Das Name-Attribut der Erweiterung muss auf "com.microsoft.windows.websearchprovider" festgelegt werden.

Suchanbieter sollten die uap3:Properties als untergeordnetes Element von uap3:AppExtension enthalten. Das Paketmanifestschema erzwingt nicht die Struktur des uap3:Properties--Elements, außer der Anforderung, dass es sich um wohlgeformtes XML handelt. Der Rest dieses Abschnitts beschreibt das XML-Format, das das Betriebssystem erwartet, um einen Suchanbieter erfolgreich zu registrieren.

<uap3:Extension Category="windows.appExtension">
  <uap3:AppExtension Name="com.microsoft.windows.websearchprovider" DisplayName="SearchExampleApp" Id="ContosoSearchApp" PublicFolder="Public">
    <uap3:Properties>
    <!-- Search provider registration content goes here -->
    </uap3:Properties>
  </uap3:AppExtension>
</uap3:Extension>

Elementhierarchie

uap3:Eigenschaften

  Endpunkt

  Protokoll

Endpunkt

Die URL des HTTPS-Endpunkts, an den das Betriebssystem Suchabfrageanforderungen sendet.

Protokoll

Das Protokollschema, das beim Starten der bereitgestellten Websuchergebnisse verwendet wird. Wenn das angegebene Protokoll nicht von einer App im Betriebssystem registriert wird, wird der Standardbrowser für Suchergebnisse gestartet. Weitere Informationen zum Registrieren von Protokollschemas finden Sie unter "uap:Protocol".

Beispiel-Paketmanifestdatei

Es folgt ein Beispiel appmanifest.xml Paketmanifestdatei zum Registrieren eines Windows Suchanbieters.

<!-- appxmanifest.xml -->

  <uap3:Extension Category="windows.appExtension">
	  <uap3:AppExtension Name="com.microsoft.windows.websearchprovider" DisplayName="CustomSearch" Id="CustomSearchApp" PublicFolder="Public">
		  <uap3:Properties>
			  <Endpoint>https://customsearchendpoint</Endpoint>
			  <Protocol>customsearch</Protocol>
		  </uap3:Properties>
	  </uap3:AppExtension>
  </uap3:Extension>
  <uap:Extension Category="windows.protocol">
	  <uap:Protocol Name="customsearch"/>
  </uap:Extension>

Implementieren eines Windows Endpunkts für Suchanbietervorschlag

Suchanbieter müssen einen HTTPS-Endpunkt verfügbar machen und registrieren, der vom Betriebssystem aufgerufen wird, wenn ein Benutzer in das Windows-Suchfeld eingibt. Dieser Endpunkt sollte eine JSON-formatierte Zeichenfolge zurückgeben, die die Suchvorschläge für die bereitgestellte Benutzerabfrage enthält. Inhalte müssen über HTTPS übermittelt werden. Die Suchintegration unterstützt keine Inhalte, die über HTTP bereitgestellt werden.

Format-Vorschläge für HTTPS-Anforderungen

Die HTTPS-Anforderung an den Vorschlagsendpunkt verwendet das folgende Format.

https://contoso.com?setlang=en-US&cc=US&qry=

Die an den Vorschlagsendpunkt übergebenen Abfragezeichenfolgenparameter lauten wie folgt:

Parameter BESCHREIBUNG
setlang Das gebietsschema, das der Abfrage zugeordnet ist.
cm³ Der mit der Abfrage verknüpfte Ländercode.
qry Die vom Benutzer bereitgestellte Abfrage. Wenn der Parameter keinen Wert aufweist, d. h. in der Abfragezeichenfolge als qry=angezeigt wird, ist die Benutzerabfrage leer. Suchanbieter können weiterhin Vorschläge und Vorschauseiten als Reaktion auf eine leere Abfrage bereitstellen. ANMERKUNG Das Betriebssystem führt keine Bereinigung von Abfragezeichenfolgen durch. Suchanbieter können ihre eigene Bereinigung implementieren, wenn die Abfrage empfangen wird.

Vorschlags-HTTPS-Antwort-Header

Der Suchanbieter muss die folgenden Header in der Antwort vom Vorschlags-HTTPS-Endpunkt enthalten.

  • Zugriffskontrolle-Allow-Origin: https://www.bing.com
  • Zugriffssteuerung-Erlaube-Anmeldedaten: true
  • Access-Control-Allow-Methods: GET
  • Content-Type: application/json; charset=utf-8
  • Inhaltslänge: [Muss die genaue Antwortlänge sein]

JSON-Format der Vorschlagsantwort

Der HTTPS-Endpunkt des Suchanbieters für Vorschläge muss ein JSON-Dokument mit dem folgenden Format zurückgeben. Die Schlüsselnamen müssen exakt mit dem Format übereinstimmen.

Schlüssel BESCHREIBUNG
Anregungen Enthält eine Liste von JSON-Objekten mit Schlüssel Attributes , die den Vorschlägen entsprechen, die der Benutzerabfrage zugeordnet sind.
Attribute Enthält die Attribute eines Vorschlags.
URL Die URL für den Suchvorschlag auf der Anbieterwebsite.
Anfrage Die Benutzerabfrage, die dem Suchvorschlag zugeordnet ist.
previewPaneUrl Die URL des Vorschauendpunkts, aus dem eine HTML-Vorschau des Vorschlags abgerufen werden kann.
Text Die Textbeschreibung des Vorschlags. 
{"Suggestions": 
   [{"Attributes": 
     {"url":"https://www.contoso.com/search?q=projection+matrix","query":"projection matrix","previewPaneUrl":"http://www.contoso.com/preview"} ,"Text":"projection matrix"}, 
    {"Attributes": 
     {"url":"https://www.contoso.com/search?q=rotation+matrix","query":"rotation matrix","previewPaneUrl":"http://www.contoso.com/preview"} ,"Text":"rotation matrix"}
    ] 
}

Implementieren eines Windows Suchanbieter-Vorschauendpunkts

Suchanbieter geben die URL eines HTTPS-Endpunkts zurück, der eine HTML-Vorschau der Seite bereitstellt, die jedem Vorschlag in den Suchergebnissen zugeordnet ist. Die Vorschauendpunktantwort muss den HTML-Code für eine funktionierende Seite zurückgeben.

Vorschau des HTTPS-Anforderungsformats

Die HTTPS-Anforderung an den Vorschauendpunkt verwendet das folgende Format.

https://contoso.com?Darkschemeovr=1

Die an den Vorschlagsendpunkt übergebenen Abfragezeichenfolgenparameter lauten wie folgt:

Parameter BESCHREIBUNG
Darkschemeovr Gibt an, ob das aufrufende Windows System das dunkle Design aktiviert hat. Der Wert ist 1, wenn das dunkle Design aktiviert ist, und 0, wenn das dunkle Design deaktiviert ist.

Vorschau von HTTPS-Antwortheadern

  • Zugriffskontrolle-Allow-Origin: https://www.bing.com
  • Zugriffssteuerung-Erlaube-Anmeldedaten: true
  • Access-Control-Allow-Methods: GET
  • Inhaltstyp: Text/HTML; charset=utf-8
  • Inhaltslänge: [Muss die genaue Länge der Vorschau-HTML sein]

OPTIONS-Anfrage und Cross-Origin-Ressourcenfreigabe (CORS)

Der Windows Search-Client sendet vor jeder GET-Anforderung eine HTTP OPTIONS-Anforderung (CORS Preflight). Suchanbieter müssen die OPTIONS-Anforderungsmethode unterstützen und mit HTTP 200 OK antworten.

  • Last updated on