Retail v2 API - Enum SearchRequest.Types.SearchMode (2.8.0)

public enum SearchRequest.Types.SearchMode

Reference documentation and code samples for the Retail v2 API enum SearchRequest.Types.SearchMode.

The search mode of each search request.

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Fields

Name Description
FacetedSearchOnly

Only faceted search will be performed. The product search will be disabled.

When in this mode, one or both of [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs] and [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec] should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will be returned. [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] will not be returned.

ProductSearchOnly

Only product search will be performed. The faceted search will be disabled.

Only [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] will be returned. [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will not be returned, even if [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs] or [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec] is set.

Unspecified

Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult] and [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will be returned.