Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchRequest::FacetSpec.
A facet specification to perform faceted search.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#enable_dynamic_position
def enable_dynamic_position() -> ::Boolean-
(::Boolean) — Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search.
Another example, assuming you have the following facets in the request:
"rating", enable_dynamic_position = true
"price", enable_dynamic_position = false
"brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
#enable_dynamic_position=
def enable_dynamic_position=(value) -> ::Boolean-
value (::Boolean) — Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search.
Another example, assuming you have the following facets in the request:
"rating", enable_dynamic_position = true
"price", enable_dynamic_position = false
"brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
-
(::Boolean) — Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search.
Another example, assuming you have the following facets in the request:
"rating", enable_dynamic_position = true
"price", enable_dynamic_position = false
"brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
#excluded_filter_keys
def excluded_filter_keys() -> ::Array<::String>-
(::Array<::String>) — List of keys to exclude when faceting.
By default, FacetKey.key is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
#excluded_filter_keys=
def excluded_filter_keys=(value) -> ::Array<::String>-
value (::Array<::String>) — List of keys to exclude when faceting.
By default, FacetKey.key is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
-
(::Array<::String>) — List of keys to exclude when faceting.
By default, FacetKey.key is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
#facet_key
def facet_key() -> ::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey- (::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey) — Required. The facet key specification.
#facet_key=
def facet_key=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey- value (::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey) — Required. The facet key specification.
- (::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey) — Required. The facet key specification.
#limit
def limit() -> ::Integer-
(::Integer) — Maximum of facet values that should be returned for this facet. If
unspecified, defaults to 20. The maximum allowed value is 300. Values
above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
#limit=
def limit=(value) -> ::Integer-
value (::Integer) — Maximum of facet values that should be returned for this facet. If
unspecified, defaults to 20. The maximum allowed value is 300. Values
above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
-
(::Integer) — Maximum of facet values that should be returned for this facet. If
unspecified, defaults to 20. The maximum allowed value is 300. Values
above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.