Udostępnij za pośrednictwem

Dostawcy wyszukiwania w sieci Windows Search

Usługa Windows Search używa obecnie funkcji wyszukiwania w sieci Web z aplikacji Microsoft Bing do zwracania zawartości internetowej i wyników wyszukiwania. W Europejskim Obszarze Gospodarczym (EOG) można instalować aplikacje, które implementują dostawcę wyszukiwania w internecie, aby zwracać zawartość internetową i wyniki wyszukiwania w usłudze Windows Search.

Zrzut ekranu przedstawiający interfejs użytkownika usługi Windows Search z integracją dostawcy wyszukiwania innej firmy.

Dostawcy wyszukiwania integrują się ze środowiskiem wyszukiwania, tworząc pakiet MSIX z plikiem manifestu pakietu, który udostępnia wymagane informacje dla systemu operacyjnego w celu zarejestrowania dostawcy wyszukiwania. Po zakończeniu instalacji dostawca wyszukiwania jest domyślnie włączony w środowiskach usługi Windows Search. W aplikacji Ustawienia systemu Windows użytkownicy mogą włączać i wyłączać zainstalowanych dostawców wyszukiwania oraz zarządzać kolejnością dostawców w wynikach wyszukiwania. Użytkownicy mogą usunąć dostawcę wyszukiwania za pośrednictwem > strony Aplikacje > ustawienia Zainstalowane aplikacje w aplikacji Ustawienia systemu Windows.

W przypadku programowania i testowania, gdy tryb dewelopera jest włączony, a aplikacja dostawcy wyszukiwania została załadowana bezpośrednio na urządzeniu, zostanie wyświetlona na liście dostępnych dostawców wyszukiwania. Aby uzyskać więcej informacji, zobacz Funkcje trybu dewelopera i debugowanie.

Po zarejestrowaniu dostawcy wyszukiwania w systemie operacyjnym zapytania użytkownika są przekazywane do punktu końcowego HTTP określonego przez dostawcę w manifeście pakietu przy użyciu ustandaryzowanego ciągu zapytania. Punkt końcowy zwraca sugerowane wyniki w dokumencie JSON. Po każdym sugerowanym adresie URL w dokumencie odpowiedzi dostawca wyszukiwania zawiera adres URL punktu końcowego podglądu, który zwraca dokument HTML wyświetlany w okienku podglądu w interfejsie użytkownika wyników wyszukiwania.

Ten artykuł zawiera wskazówki dotyczące tworzenia pakietu aplikacji dostawcy wyszukiwania i szczegółów dotyczących protokołów implementowania punktów końcowych HTTP dostawcy wyszukiwania.

Tworzenie pakietu aplikacji rozszerzalności wyszukiwania

Dostawcy wyszukiwania rejestrują się w systemie operacyjnym, podając pakiet MSIX zawierający wymagane informacje o dostawcy, takie jak nazwa dostawcy wyszukiwania i punkty końcowe HTTP pod kątem sugestii i podglądów.

Rozszerzenie aplikacji dostawcy wyszukiwania

Plik manifestu pakietu aplikacji obsługuje wiele różnych rozszerzeń i funkcji dla aplikacji systemu Windows. Format manifestu pakietu aplikacji jest określany przez zestaw schematów, które są udokumentowane w odwołaniu do schematu manifestu pakietu . Dostawcy wyszukiwania deklarują swoje informacje rejestracyjne w rozszerzeniu uap3:AppExtension. Atrybut Name rozszerzenia musi być ustawiony na "com.microsoft.windows.websearchprovider".

Dostawcy wyszukiwania powinni uwzględnić element uap3:Properties jako element podrzędny uap3:AppExtension. Schemat manifestu pakietu nie wymusza struktury elementu uap3:Properties innego niż wymaganie poprawnie sformułowanego kodu XML. W pozostałej części tej sekcji opisano format XML oczekiwany przez system operacyjny w celu pomyślnego zarejestrowania dostawcy wyszukiwania.

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

Hierarchia elementów

uap3:Właściwości

  Punkt końcowy

  Protokół

Punkt końcowy

Adres URL punktu końcowego HTTPS, do którego system operacyjny będzie wysyłać żądania zapytań wyszukiwania.

Protokół

Schemat protokołu, który będzie używany podczas uruchamiania podanych wyników wyszukiwania w Internecie. Jeśli określony protokół nie jest zarejestrowany przez aplikację w systemie operacyjnym, zostanie uruchomiona domyślna przeglądarka dla wyników wyszukiwania. Aby uzyskać więcej informacji na temat rejestrowania schematów protokołu, zobacz uap:Protocol.

DynamicContentEndpoint

Ta funkcja nie jest już obsługiwana. Aby uzyskać więcej informacji, zobacz Implementacja punktu końcowego ikony gleam. Adres URL punktu końcowego HTTPS, do którego system operacyjny wyśle żądanie wyświetlenia ikony błysku w polu wyszukiwania.

Przykładowy plik manifestu pakietu

Poniżej przedstawiono przykładowy appmanifest.xml plik manifestu pakietu na potrzeby rejestrowania dostawcy usługi Windows Search.

<!-- 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>
        <DynamicContentEndpoint>https://sub.contoso.com/dynamic</DynamicContentEndpoint>
		  </uap3:Properties>
	  </uap3:AppExtension>
  </uap3:Extension>
  <uap:Extension Category="windows.protocol">
	  <uap:Protocol Name="customsearch"/>
  </uap:Extension>

Implementowanie punktu końcowego sugestii dostawcy usługi Windows Search

Dostawcy wyszukiwania muszą uwidocznić i zarejestrować punkt końcowy HTTPS wywoływany przez system operacyjny, gdy użytkownik wpisze je w polu Wyszukiwania systemu Windows. Ten punkt końcowy powinien zwrócić ciąg w formacie JSON zawierający sugestie wyszukiwania dla podanego zapytania użytkownika. Zawartość musi być dostarczana za pośrednictwem protokołu HTTPS. Integracja wyszukiwania nie obsługuje zawartości dostarczanej za pośrednictwem protokołu HTTP.

Format sugestii żądania HTTPS

Żądanie HTTPS do punktu końcowego sugestii używa następującego formatu.

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

Parametry ciągu zapytania przekazane do punktu końcowego sugestii są następujące.

Parametr Opis
setlang Lokalizacja związana z zapytaniem.
DW Kod kraju skojarzony z zapytaniem.
qry Zapytanie dostarczone przez użytkownika. Jeśli parametr nie ma wartości, tj. pojawia się w ciągu zapytania jako qry=, zapytanie użytkownika jest puste. Dostawcy wyszukiwania nadal mogą udostępniać sugestie i strony podglądu w odpowiedzi na puste zapytanie. NUTA System operacyjny nie wykonuje żadnego oczyszczania ciągów zapytania. Dostawcy wyszukiwania mogą zaimplementować własne oczyszczanie po odebraniu zapytania.

Sugestie dotyczące nagłówków odpowiedzi HTTPS

Dostawca wyszukiwania musi zawierać następujące nagłówki w odpowiedzi z sugestii punktu końcowego HTTPS.

  • Access-Control-Allow-Origin: https://www.bing.com
  • Access-Control-Allow-Credentials: prawda
  • Access-Control-Allow-Methods: GET
  • Typ zawartości: application/json; charset=utf-8
  • Długość zawartości: [Musi być dokładną długością odpowiedzi]

Format JSON odpowiedzi sugestii

Punkt końcowy protokołu HTTPS dostawcy wyszukiwania dla sugestii musi zwrócić dokument JSON w następującym formacie. Nazwy kluczy muszą być dokładnie zgodne z formatem.

Klawisz Opis
Sugestie Zawiera listę obiektów JSON z kluczem Attributes reprezentującym sugestie skojarzone z zapytaniem użytkownika.
Atrybuty Zawiera atrybuty sugestii.
URL Adres URL sugestii wyszukiwania w witrynie internetowej dostawcy.
zapytanie Zapytanie użytkownika skojarzone z sugestią wyszukiwania.
URL podglądu panelu Adres URL punktu końcowego podglądu, z którego można pobrać podgląd HTML sugestii.
Tekst Opis tekstowy sugestii. 
{"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"}
    ] 
}

Implementowanie punktu końcowego dostawcy usługi Windows Search w wersji zapoznawczej

Dostawcy wyszukiwania zwracają adres URL punktu końcowego HTTPS, który udostępnia podgląd HTML strony skojarzonej z każdą sugestią w wynikach wyszukiwania. Odpowiedź punktu końcowego w wersji zapoznawczej musi zwrócić kod HTML dla działającej strony.

Podgląd formatu żądania HTTPS

Żądanie HTTPS do punktu końcowego wersji próbnej używa następującego formatu.

https://contoso.com?Darkschemeovr=1

Parametry ciągu zapytania przekazane do punktu końcowego sugestii są następujące.

Parametr Opis
Darkschemeovr Sprawdza, czy system operacyjny Windows ma włączony motyw ciemny. Wartość to 1, jeśli motyw ciemny jest włączony i 0, jeśli motyw ciemny jest wyłączony.

Podgląd nagłówków odpowiedzi HTTPS

  • Access-Control-Allow-Origin: https://www.bing.com
  • Access-Control-Allow-Credentials: true
  • Access-Control-Allow-Methods: GET
  • Typ zawartości: tekst/html; charset=utf-8
  • Długość treści: [Powinna być dokładną długością podglądu HTML]

Żądanie OPTIONS i współdzielenie zasobów między źródłami (CORS)

Dostawcy wyszukiwania muszą obsługiwać metodę żądania OPTIONS i odpowiadać na to żądanie za pomocą protokołu HTTP OK. Jeśli punkt końcowy dostawcy wyszukiwania używa mechanizmu CORS, klient wyszukiwania systemu Windows wyśle żądanie HTTP OPTIONS przed każdym żądaniem GET.

Implementacja punktu końcowego ikony blasku

Uwaga / Notatka

Ta funkcja "gleam" nie jest już włączona. Ikony Gleam nie są już wyświetlane dla wszystkich dostawców usług internetowych w Europejskim Obszarze Gospodarczym. Zawartość tej sekcji dokumentacji jest przestarzała.

Dostawcy wyszukiwania mogą opcjonalnie udostępniać ikony błysku w trybie jasnym i ciemnym, które są wyświetlane na pasku wyszukiwania, gdy dostawca wyszukiwania jest obecnie włączony. Gdy element DynamicContentEndpoint zostanie podany w manifeście aplikacji, żądanie zostanie wysłane do określonego adresu URL, a dostawca wyszukiwania odpowie przy użyciu pliku json w formacie zdefiniowanym poniżej, który zawiera adresy URL plików obrazów ikony i inne metadane. Żądanie ikony błysku będzie okresowo wysyłane, gdy ostatni dostawca wyszukiwania jest aktywnym dostawcą w usłudze Windows Search. Częstotliwość dla tego żądania wynosi co 6 godzin. Żądanie zostanie również wysłane po każdym uruchomieniu wyszukiwania i odblokowaniu urządzenia.

Format żądania HTTPS ikony Gleam

Żądanie HTTPS do punktu końcowego dla ikony błysku używa następującego formatu.

https://www.contoso.com/Gleam?cc=FR&setlang=en-us&dateTime=3%2F29%2F2024%2C%208%3A33%3A56%20PM&deviceOs=windows10&schemaversion=1.0.0

Parametry ciągu zapytania przekazane do punktu końcowego sugestii są następujące.

Parametr Opis
setlang Lokalizacja związana z zapytaniem.
DW Kod kraju skojarzony z zapytaniem.
Data i godzina Bieżąca data i godzina z urządzenia klienckiego zakodowana w formacie URL.
system operacyjny urządzenia System operacyjny urządzenia klienckiego. Wartość tego parametru może być "Windows10" lub "Windows11". W systemie Windows 10 rozmiar ikony 'gleam' wynosi 30x60. W systemie Windows 11 rozmiar ikony gleam to 20x36
schemaversion Wersja schematu przełącznika.

Format JSON odpowiedzi ikony Gleam

Punkt końcowy HTTPS dostawcy wyszukiwania dla ikon "gleam" musi zwrócić dokument JSON z następującym formatem. Nazwy kluczy muszą być dokładnie zgodne z formatem. Bieżąca wersja schematu to 1.0.0.

Klawisz Opis
wersja schematu Wersja schematu przełącznika. Powinno to być zgodne z parametrem ciągu zapytania schemaVersion w żądaniu.
identyfikator telemetrii Unikatowy identyfikator ikony błyszczącej. Jeśli wartość w odpowiedzi jest taka sama jak wartość dla bieżącej ikony błysku, system operacyjny nie zaktualizuje ikony.
czas wygaśnięcia Czas wygaśnięcia ikonki błysku. Musi być czas w przyszłości.
zawartość Sekcja zawartości odpowiedzi.
pasek zadań pole wyszukiwania Zawiera ustawienia pola wyszukiwania.
połyskiwać Zawiera ustawienia ikony blasku.
tekst alternatywny Alternatywny tekst ikony błysku.
dimensionEnum Wartość "30x60", jeśli żądanie zostało wysłane z urządzenia z systemem Windows 10. Wartość "20x36", jeśli żądanie zostało wysłane z urządzenia z systemem Windows 11.
iconUrl Zawiera adresy URL dla jasnych i ciemnych plików obrazów ikon błysku.
światło Adres URL pliku obrazu ikony światła.
ciemny Adres URL dla pliku obrazu ikony o ciemnym blasku. 
{
  "schemaVersion":"1.0.0",
  "telemetryId":"<unique gleam Id>",
  "expirationTime":"2025-12-09T20:37:13Z",
  "content": {
    "taskbarSearchBox": {
      "gleam":{
        "altText": "<alt text of the gleam>",
        "dimensionEnum": "(30x60 for Windows 10, 20x36 for Windows 11)",
        "iconUrl": {
          "light":"<3p's light gleam url>",
          "dark": "<3p's dark gleam url>"
        }
      }
    }
  }
}

Walidacja odpowiedzi dla ikony błysku

Odpowiedź musi określać zarówno jasny adres URL zasobu, jak i ciemny adres URL zasobu. Domeny adresów URL obrazu ikony muszą używać protokołu HTTPS, a poddomena musi być zgodna z poddomeną określoną w elemencie DynamicContentEndpoint w pliku manifestu aplikacji.

Pliki obrazów muszą być w formacie SVG, a maksymalny rozmiar pliku to 300 kB. Blask musi znajdować się w ramce o wymiarach 240x120px wewnątrz SVG.

Jeśli zostanie odebrany pusty ładunek danych, spowoduje to wyczyszczenie aktywnej ikony błysku, a błysk nie zostanie wyświetlony.