Windows Keresés webkereső szolgáltatók

Windows Keresés jelenleg az Microsoft Bing alkalmazás webkeresését használja a webes tartalom és a keresési eredmények visszaadásához. Az Európai Gazdasági Térségben (EGT) olyan alkalmazásokat telepíthet, amelyek webkeresési szolgáltatót implementálnak a webes tartalmak és keresési eredmények Windows Keresésben való visszaadásához.

A Windows Keresési felhasználói felület képernyőképe külső keresési szolgáltató integrációjával.

A keresési szolgáltatók integrálhatók a Keresési felülettel, ha létrehoznak egy MSIX-csomagot egy csomagjegyzékfájllal, amely biztosítja az operációs rendszer számára a keresési szolgáltató regisztrálásához szükséges információkat. A telepítés után a keresési szolgáltató alapértelmezés szerint engedélyezve van Windows keresési szolgáltatásokban. A Windows beállításokban a felhasználók engedélyezhetik és letilthatják a telepített keresési szolgáltatókat, és kezelhetik a szolgáltatók sorrendjét a keresési eredményekben. A felhasználók a Settings > Apps > Telepített alkalmazások lapon távolíthatják el a keresőszolgáltatót a Windows Beállítások lapon.

A fejlesztéshez és teszteléshez, ha a fejlesztői mód engedélyezve van, és a keresőszolgáltató alkalmazás közvetlenül az eszközön van betöltve, megjelenik az elérhető keresési szolgáltatók listájában. További információ: Beállítások fejlesztőknek.

Miután a keresési szolgáltató regisztrálva lett az operációs rendszeren, a rendszer a felhasználói lekérdezéseket egy szabványosított lekérdezési sztring használatával továbbítja a szolgáltató által a csomagjegyzékben megadott HTTP-végpontnak. A végpont egy JSON-dokumentumban visszaadja a javasolt eredményeket. A válaszdokumentum minden javasolt URL-címével a keresési szolgáltató tartalmazza az előnézeti végpont URL-címét, amely egy HTML-dokumentumot ad vissza, amely a keresési eredmények felhasználói felületén, az előnézet panelen jelenik meg.

Ez a cikk útmutatást nyújt a keresőszolgáltató alkalmazáscsomagjának létrehozásához, valamint a keresőszolgáltató HTTP-végpontok implementálásának protokolljaival kapcsolatos részleteket.

Keresési bővíthetőségi alkalmazáscsomag létrehozása

A keresési szolgáltatók regisztrálnak az operációs rendszeren egy MSIX-csomag megadásával, amely tartalmazza a szolgáltatóval kapcsolatos szükséges információkat, például a keresési szolgáltató nevét és a HTTP-végpontokat a javaslatokhoz és az előnézetekhez.

Keresési szolgáltató alkalmazásbővítménye

Az alkalmazáscsomag jegyzékfájlja számos különböző bővítményt és funkciót támogat Windows alkalmazásokhoz. Az alkalmazáscsomag jegyzékformátumát a Csomagjegyzék sémahivatkozásában dokumentált sémák határozzák meg. A keresési szolgáltatók deklarálják regisztrációs adataikat az uap3:AppExtension webhelyen belül. A bővítmény Név attribútumának a "com.microsoft.windows.websearchprovider" értékre kell állítania.

A keresési szolgáltatóknak tartalmazniuk kell az uap3:Properties elemet az uap3:AppExtension gyermekként. A csomagjegyzék sémája nem kényszeríti ki az uap3:Properties elem szerkezetét, kivéve, ha jól formázott XML-t igényel. A szakasz további része azt az XML-formátumot ismerteti, amelyet az operációs rendszer elvár a keresési szolgáltató sikeres regisztrálásához.

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

Elemhierarchia

uap3:Tulajdonságok

  Végpont

  Protokoll

Végpont

Annak a HTTPS-végpontnak az URL-címe, amelyre az operációs rendszer keresési lekérdezési kéréseket küld.

Protokoll

A megadott webes keresési eredmények indításakor használt protokollséma. Ha a megadott protokollt nem regisztrálja egy alkalmazás az operációs rendszeren, akkor a rendszer elindítja az alapértelmezett böngészőt a keresési eredményekhez. A protokollsémák regisztrálásával kapcsolatos további információkért lásd : uap:Protocol.

Példa csomagjegyzékfájlra

Az alábbiakban egy példa appmanifest.xml csomagjegyzékfájlra egy Windows Search-szolgáltató regisztrálására.

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

Windows keresési szolgáltató javaslati végpont implementálása

A keresési szolgáltatóknak közzé kell tennie és regisztrálniuk kell egy HTTPS-végpontot, amelyet az operációs rendszer hív meg, amikor egy felhasználó begépeli a Windows Keresőmezőbe. Ennek a végpontnak egy JSON formátumú sztringet kell visszaadnia, amely tartalmazza a megadott felhasználói lekérdezés keresési javaslatait. A tartalmat HTTPS-en keresztül kell kézbesíteni. A keresési integráció nem támogatja a HTTP-en keresztül kézbesített tartalmakat.

Javaslat HTTPS-kérés formátuma

A javaslatvégpontra irányuló HTTPS-kérés a következő formátumot használja.

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

A javaslatvégpontnak átadott lekérdezési sztringparaméterek a következők.

Paraméter Leírás
setlang A lekérdezéshez társított helyi beállítás.
másolat A lekérdezéshez társított országkód.
qry A felhasználó által megadott lekérdezés. Ha a paraméternek nincs értéke, azaz a lekérdezési sztringben qry=a következőképpen jelenik meg, akkor a felhasználói lekérdezés üres. A keresési szolgáltatók továbbra is javaslatokat és előnézeti lapokat adhatnak meg egy üres lekérdezésre válaszul. JEGYZET Az operációs rendszer nem végez el a lekérdezési sztringek megtisztítását. A keresési szolgáltatók a lekérdezés fogadásakor saját fertőtlenítést végezhetnek.

Javaslat HTTPS-válaszfejlécek

A keresési szolgáltatónak a következő fejléceket kell tartalmaznia a javaslat HTTPS-végpontjának válaszában.

  • Access-Control-Allow-Origin: https://www.bing.com (Ez egy HTTP fejlécként szolgáló konfiguráció, amely meghatározza, hogy mely források férhetnek hozzá egy adott erőforráshoz.)
  • Access-Control-Allow-Credentials: true
  • Hozzáférés-vezérlési-engedélyezési módszerek: GET
  • Tartalomtípus: alkalmazás/json; charset=utf-8
  • Tartalomhossz: [A válasz pontos hosszának kell lennie]

A javaslat válaszának JSON-formátuma

A javaslatok keresésszolgáltatói HTTPS-végpontjának egy JSON-dokumentumot kell visszaadnia az alábbi formátumban. A kulcsneveknek pontosan meg kell egyeznie a formátummal.

Kulcs Leírás
Javaslatok A JSON-objektumok listáját tartalmazza a felhasználói lekérdezéshez társított javaslatoknak megfelelő kulccsal Attributes .
Tulajdonságok Egy javaslat attribútumait tartalmazza.
URL-cím A keresési javaslat URL-címe a szolgáltató webhelyén.
lekérdezés A keresési javaslathoz társított felhasználói lekérdezés.
previewPaneUrl Annak az előnézeti végpontnak az URL-címe, amelyből lekérhető a javaslat HTML-előnézete.
Szöveg A javaslat szöveges leírása. 
{"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"}
    ] 
}

Windows Keresési szolgáltató előzetes verziójú végpont implementálása

A keresési szolgáltatók egy HTTPS-végpont URL-címét adja vissza, amely a keresési eredményekben szereplő egyes javaslatokhoz társított oldal HTML-előnézetét biztosítja. Az előnézeti végpont válaszának egy működő lap HTML-kódját kell visszaadnia.

HTTPS-kérelem formátumának előnézete

Az előnézeti végpontra irányuló HTTPS-kérés a következő formátumot használja.

https://contoso.com?Darkschemeovr=1

A javaslatvégpontnak átadott lekérdezési sztringparaméterek a következők.

Paraméter Leírás
Darkschemeovr Megadja, hogy a hívó Windows rendszer sötét témát engedélyez-e. Az érték 1, ha a sötét téma engedélyezve van, és 0, ha a sötét téma le van tiltva.

HTTPS-válaszfejlécek előnézete

  • Access-Control-Allow-Origin: https://www.bing.com (Ez egy HTTP fejlécként szolgáló konfiguráció, amely meghatározza, hogy mely források férhetnek hozzá egy adott erőforráshoz.)
  • Access-Control-Allow-Credentials: true
  • Hozzáférés-vezérlési-engedélyezési módszerek: GET
  • Tartalomtípus: szöveg/html; charset=utf-8
  • Tartalomhossz: [Az előnézeti html pontos hosszának kell lennie]

OPTIONS kérés és Cross-Origin Resource Sharing (CORS)

A Windows Search-ügyfél minden GET-kérés előtt http-beállításokat (CORS-elővizsgálat) küld. A keresési szolgáltatóknak támogatniuk kell a OPTIONS kérési metódust, és a HTTP 200 OK-val kell válaszolniuk.

  • Last updated on