Facet

A facet result.

JSON representation
 { 
 "key" 
 : 
 string 
 , 
 "values" 
 : 
 [ 
 { 
 object (  FacetValue 
 
) 
 } 
 ] 
 , 
 "dynamicFacet" 
 : 
 boolean 
 } 
Fields
key

string

The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".

values[]

object ( FacetValue )

The facet values for this field.

dynamicFacet

boolean

Whether the facet is dynamically generated.

FacetValue

A facet value which contains value names and their count.

JSON representation
 { 
 "count" 
 : 
 string 
 , 
 "minValue" 
 : 
 number 
 , 
 "maxValue" 
 : 
 number 
 , 
 // Union field facet_value 
can be only one of the following: 
 "value" 
 : 
 string 
 , 
 "interval" 
 : 
 { 
 object (  Interval 
 
) 
 } 
 // End of list of possible types for union field facet_value 
. 
 } 
Fields
count

string ( int64 format)

Number of items that have this facet value.

minValue

number

The minimum value in the FacetValue.interval . Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

maxValue

number

The maximum value in the FacetValue.interval . Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

Union field facet_value . A facet value which contains values. facet_value can be only one of the following:
value

string

Text value of a facet, such as "Black" for facet "colorFamilies".

interval

object ( Interval )

Interval value for a facet, such as [10, 20) for facet "price".

Create a Mobile Website
View Site in Mobile | Classic
Share by: