SharePoint Framework 拡張機能を使用した Microsoft Search エクスペリエンスの変更

SharePoint Framework v1.10 リリースでは、検索クエリ拡張機能が導入されています。 これらはSharePoint Framework (SPFx) 拡張機能です。これは、検索エクスペリエンスを使用して実行される検索クエリを変更するために使用できます。

クエリ拡張機能は、通常のSharePoint Framework拡張機能として機能しますが、クエリを変更できるように、検索クエリが実行される直前に呼び出されます。 プレビュー中、クエリ拡張機能には次の特性があります。

• クエリ拡張機能は SharePoint のコンテキストでのみ機能します
• サイトまたはサイト コレクションスコープでクエリ拡張機能を明示的に有効にする必要があります
• クエリ拡張機能は、サイト コレクションがカスタム検索結果ページを使用するように関連付けられている場合にのみ機能します
• カスタム検索結果ページでは、ヘッダーのコンテンツを減らすために新しい HeaderlessSearchResults ページ レイアウトを使用できます
• HeaderlessSearchResults ページ レイアウトは、カスタム検索結果ページとして関連付けられているページでのみサポートされます
• オープンソースのモダン検索エクスペリエンス ソリューションを使用して、最新の検索エクスペリエンスを提供できます

開発プロセス

SharePoint Framework v1.10 以降のパッケージを使用するだけで、クエリ拡張機能の開発を開始できます。 この機能はプレビュー状態であるため、次に示すように、スイッチを使用して Yeoman ジェネレーターを --plusbeta 実行する必要があります。

yo @microsoft/sharepoint --plusbeta

拡張機能の選択の下に 、検索クエリ修飾子 という新しいオプションが表示され、クエリ拡張機能コンポーネントがスキャフォールディングされます。

クエリ拡張機能をサイトに関連付ける

既定では、拡張機能を含むソリューションがサイトにインストールされている場合、クエリ拡張機能はサイト コレクションに関連付けられます。 これは、ソリューション パッケージの一部として自動的にパッケージ化された Feature Framework 定義を使用して自動的に発生します。 技術的には、この関連付けは、 属性として と のUserCustomActionコレクションをClientSideExtension.SearchQueryModifierLocation使用して行われます。

検索クエリ修飾子を使用して新しいソリューションを作成すると、次のelements.xml ファイルが含まれます。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
      Title="QueryModifyer"
      Location="ClientSideExtension.SearchQueryModifier"
      ClientSideComponentId="801f82d5-1a21-4b2c-94b6-f13f6672142c"
      ClientSideComponentProperties="{&quot;testMessage&quot;:&quot;Test message&quot;}">
  </CustomAction>
</Elements>

技術的には、SharePoint Framework拡張機能のテナント スコープ展開を使用して、拡張機能をテナント内の複数のサイト コレクションに自動的に関連付けることもできます。

拡張機能のデプロイ

デプロイは、少なくともプレビュー中に 検索クエリ修飾子 に対して既定で 2 段階のプロセスです。

1. ソリューションを SharePoint アプリ カタログにデプロイする
2. 拡張機能を使用するサイト コレクションにソリューションをインストールする
3. カスタム検索結果ページを作成し、サイト コレクションで使用するように構成する

サイト設定からサイト コレクションのカスタム検索結果ページを構成するには、[ 検索設定] をクリックし、カスタム検索エクスペリエンス オプションを有効にします。