NavigationMenuConfig

NavigationMenuConfigは、対話Webサービス・リクエストの要素で、絞込みを返す方法およびそれらの絞込みの動作方法についての指示を指定します。これにより、エンドユーザー向けのガイド付きナビゲーション・エクスペリエンス構築のために取得する絞込みに関する情報を柔軟に制御できます。たとえば、すべての絞込みの値を計算して返すかどうか、階層絞込みのフルパスを返すかどうか、返す絞込みの最大数をいくつにするか、すでに適用済の絞込み(暗黙的に適用されたものなど)を取得するかどうかなどをリクエストで指定できます。

NavigationMenuConfigの構文は次のとおりです。 
<NavigationMenuConfig 
      Id="?" 
      ExposeAllRefinements="?" 
      ReturnFullPath="false" 
      MaximumRefinementCount="?" 
      IncludeAllExplicitSelections="false" 
      IncludeAllImplicitSelections="false">
   <StateName>?</StateName>
   <RefinementGroupConfig ...>
      ...
   </RefinementGroupConfig>
   <RefinementConfig .../>
</NavigationMenuConfig>
NavigationMenuConfigには次のパラメータが含まれます。
属性 説明
Id 必須です。この問合せ構成の識別子。
ExposeAllRefinements オプションです。グループのすべての属性に対して絞込みを公開する(つまり、絞込み値を計算する)かどうかを示します(デフォルトはfalseです)。これをtrueに設定することは、各標準属性および管理属性においてExpose="true"でRefinementConfigを送信することと同等です。
ReturnFullPath オプションです。trueに設定した場合、絞込みの各セットにその絞込みのセットのルートへのパスが付与されます。デフォルトはfalseです。
MaximumRefinementCount オプションです。標準属性または管理属性当たり返される絞込みの数に最大制限を指定する整数です。デフォルトは10です。
IncludeAllExplicitSelections オプションです。返される提案される絞込み(使用可能な場合は常に返されます)に加えて、すべての明示的に選択された絞込みを返すかどうかを指定します。デフォルトはfalseです。
IncludeAllImplicitSelections オプションです。返される提案される絞込みに加えて、すべての暗黙的に選択された絞込みを返すかどうかを指定します。デフォルトはfalseです。
StateName 次のルールを使用して、名前付きの状態を指定します。
  • リクエストに複数の名前付きの状態がある場合は、StateName要素で名前付きの状態を1つだけ参照する必要があります。
  • リクエストに名前付きの状態が1つだけある場合は、StateName要素を使用してその名前付きの状態を参照するかどうかはオプションです(NavigationMenuConfigのどのイベントでもその状態が使用されるため)。
  • リクエストに名前のない状態がある場合は、StateName要素を使用できません。
RefinementGroupConfig 属性グループに含まれる属性から絞込みのリストを返します。

この要素の下にあるオプションを使用すると、グループ内の絞込みについてUIで展開と折りたたみを有効にし、グループ内のすべての絞込みの背後で値を計算し、グループ内の個々の属性の動作を制御できます。

この要素にはRefinementConfig要素が含まれます。グループの個々の属性に対して操作を実行する場合、そのすべてに対して実行するのではなく(たとえば、個々の属性の設定をオーバーライドするなど)、RefinementGroupConfigで複数のRefinementConfig要素を使用できます。

RefinementConfig要素を、RefinementGroupConfigで囲まずに単独でNavigationMenuConfigに含めることもできることに注意してください。これは、グループに含まれない属性がある場合に役立ちます。

RefinementConfig NavigationMenuConfigで個々の属性の動作を制御します。これは、ナビゲーション問合せで返される有効なすべての絞込みのうち、どの属性が実際の絞込み値を返す必要があるかを指定し、絞込み値の順序と数も指定します。

オプションの項目が必要ない場合は、リクエストでRefinementConfigを省略できます。