ファセット フィルタリングのリファレンス

ファセットIDによる単純なファセット フィルタリングを行うには、文字列の配列をsearch.facet.types.filter.valuesキーの値として渡します。Filtering facetsのFiltering a term facetセクションには、サンプル呼び出しがあります。

次の表は、search.facet.types.filter.valuesオブジェクトがarray of strings型の場合に必要なキーを示しています。

"values": ["facet_id123", "facet_id456", "facet_id789"]

たとえば、lte (以下以下)、geoDistance、notなどのoperatorsを使用して複雑なファセット フィルタリングを行うには、フィルター オブジェクトの配列をsearch.facet.types.filter.valuesキーの値として渡します。Filtering facetsのUsing complex facet filtersセクションには、サンプル呼び出しがあります。

次の表は、search.facet.types.filter.valuesオブジェクトがarray of filter objects型の場合に取るキーを示しています。

およびファセットフィルターオブジェクト

結果を得るためにすべて一致する必要があるネストされたファセットフィルターを追加するには、andファセットフィルターオブジェクトを使用します。このファセット フィルター オブジェクトは再帰的です。

次の表に、andファセット フィルター オブジェクトが受け取るキーを示します。

たとえば、lte、gte、およびnotファセットフィルターオブジェクトをandファセットフィルターオブジェクト内にネストします。これを行う際に、金額より大きい、金額より小さい、および金額に等しくないという条件を満たす結果を要求します。

ファセットフィルターオブジェクトandサンプルを次に示します。

{
   "type": "and",
   "filters": [
      {
         "type": "lte",
         "value": "1000"
      },
      {
         "type": "gte",
         "value": "200"
      },
      {
         "type": "not",
         "filter": {
            "type": "eq",
            "value": "350"
         }
      }
   ]
}

anyOfファセット・フィルタ・オブジェクト

任意の値に一致する結果を取得するには、anyOfファセット フィルター オブジェクトを使用します。

次の表に、anyOfファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトanyOfサンプルを次に示します。

{
   "type": "anyOf",
   "values": [
      "History",
      "Science Fiction",
      "Classics"
   ]
}

allOfファセットフィルターオブジェクト

指定されたすべての値に一致する結果を取得するには、allOfファセット フィルター オブジェクトを使用します。

次の表に、allOfファセット フィルター オブジェクトが受け取るキーを示します。

EQファセット フィルター オブジェクト

特定の値に一致する結果を取得するには、eqファセット フィルター オブジェクトを使用します。

次の表に、eqファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトeqサンプルを次に示します。

{
   "type": "eq",
   "value": "Science Fiction"
}

geoDistanceファセット フィルター オブジェクト

定義した円形領域内で結果を取得するには、geoDistanceファセットフィルターオブジェクトを使用します。

次の表に、geoDistanceファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトgeoDistanceサンプルを次に示します。

{
   "type": "geoDistance",
   "distance": "50km",
   "lat": -59.11309610169502,
   "lon": -37.329354589260596
}

geoWithinファセット フィルター オブジェクト

定義された多角形領域内で結果を取得するには、geoWithinファセットフィルターオブジェクトを使用します。

次の表に、geoWithinファセット フィルター オブジェクトが受け取るキーを示します。

coordinates オブジェクト

ポリゴン領域を作成するSearchに少なくとも3つのcoordinatesオブジェクトを渡します。

次の表に、coordinatesオブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトgeoWithinサンプルを次に示します。

{
   "type": "geoWithin",
   "coordinates": [
      {
         "lat": 43.194852,
         "lon": -79.570522
      },
      {
         "lat": 43.176515,
         "lon": -79.929493
      },
      {
         "lat": 43.521512,
         "lon": -79.912504
      },
      {
         "lat": 43.871014,
         "lon": -78.780655
      }
   ]
}

GTファセット フィルター オブジェクト

特定の値よりも大きい結果を取得するには、gtファセット フィルター オブジェクトを使用します。このファセットフィルターオブジェクトは、ヒストグラムfacetsでのみ使用できます。

次の表に、gtファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトgtサンプルを次に示します。

{
   "type": "gt",
   "value": 999
}

GTEファセット フィルター オブジェクト

特定の値以上の結果を取得するには、gteファセット フィルター オブジェクトを使用します。このファセットフィルターオブジェクトは、ヒストグラムfacetsでのみ使用できます。

次の表に、gteファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトgteサンプルを次に示します。

{
   "type": "gte",
   "value": 1000
}

ファセットフィルターオブジェクト

特定の値より小さい結果を得るには、ltファセット フィルター オブジェクトを使用します。このファセットフィルターオブジェクトは、ヒストグラムfacetsでのみ使用できます。

次の表に、ltファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトltサンプルを次に示します。

{
   "type": "lt",
   "value": 1000
}

LTEファセット フィルター オブジェクト

特定の値以下の結果を得るには、lteファセットフィルターオブジェクトを使用します。このファセットフィルターオブジェクトは、ヒストグラムfacetsでのみ使用できます。

次の表に、lteファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトlteサンプルを次に示します。

{
   "type": "lte",
   "value": 999
}

ファセットなしフィルターオブジェクト

ネストされたファセット フィルターを追加するには、結果を取得するために一致する必要はない、notファセット フィルター オブジェクトを使用します。このファセット フィルター オブジェクトは再帰的です。

次の表に、notファセット フィルター オブジェクトが受け取るキーを示します。

ファセットフィルターオブジェクトnotサンプルを次に示します。

{
   "type": "not",
   "filter":"facet_id123"
}

またはファセットフィルターオブジェクト

結果を得るために一致する必要があるネストされたファセットフィルターを追加するには、orファセットフィルターオブジェクトを使用します。このファセット フィルター オブジェクトは再帰的です。

次の表に、orファセット フィルター オブジェクトが受け取るキーを示します。

たとえば、lte、gte、およびeqファセットフィルターオブジェクトをorファセットフィルターオブジェクト内にネストします。これを行う際に、金額より大きい、金額より小さい、または金額に等しいという条件を満たす結果を要求します。

ファセットフィルターオブジェクトorサンプルを次に示します。

{
   "type": "or",
   "filters": [
      {
         "type": "lte",
         "value": "150"
      },
      {
         "type": "gte",
         "value": "350"
      },
      {
         "type": "eq",
         "value": "200"
      }
   ]
}