Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 4.8 KB

SearchRequestDto.md

File metadata and controls

35 lines (31 loc) · 4.8 KB
Raw

SearchRequestDto

Properties

Name Type Description Notes
query String Base textual search query. [optional]
area String Area name the search is being performed in. [optional] [default to "Production"]
collection String Name of collection in project configuration setting which is mapped to the google retail backend. [optional] [default to "default"]
visitorId String Unique identifier identifying the shopper. Will be autogenerated if not provided. [optional]
refinements [SelectedRefinementDto]
pageSize Int The number of products to be returned on each page. [optional] [default to 10]
skip Int64 Where in the list of products to begin the page. [optional] [default to 0]
biasingProfile String Name of a biasing profile which should be applied to the search. Takes priority over area default. [optional]
biasing BiasingProfileDto
customUrlParams [CustomParameterDto]
sorts [SortDto]
includedNavigations [String] Set of navigation fields to include in the search result. Cannot be set if 'excludedNavigations' is set. [optional]
excludedNavigations [String] Set of navigation fields to exclude in the search result. Cannot be set if 'includedNavigations' is set. [optional]
dynamicFacet Bool Set the specifications of dynamically generated facets. [optional]
variantRollupKeys [String] Set the variant rollup keys. [optional]
preFilter String Set of the prefilter specifications value. [optional]
site String Name of site filter. If not specified, the specified area's default site will be applied if configured in Command Center. To not use default specify empty value i.e."". If the site doesn't exist then the search will execute without the site filter and a warning will be provided. [optional]
responseMask [String] List with fields which should be included in metadata object associated with each record in response. [optional]
pageCategories [String] The categories associated with a category page. Required for category navigation queries to achieve good search quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s).Max item length = 1. [optional]
spellCorrectionMode SpellCorrectionMode [optional]
includeExpandedResults Bool When a shopper uses an ambiguous or a multi-word search phrase, they can get an empty response. After turning on include expanded results, Retail Search analyzes the request and returns the expanded list of products based on the parsed search query. For example, if you search "Google Pixel 5" without query expansion, you might only get "google_pixel_5" in the result. With query expansion, you might get "google_pixel_4a_with_5g", "google_pixel_4a" and "google_pixel_5_case" as well.The default value is configured in the tenant settings or true if there is no such setting [optional]
pinUnexpandedResults Bool This configuration depends on include expanded results settings. If this field is set to true,unexpanded products are always at the top of the search results, followed by the expanded results. Default value: true [optional]
debug Bool Enable additional debug info in response. Note: attaching debug info significantly affects performance. Is not supposed to be used for large requests. [optional]
facetLimit Int Maximum of facet values that should be returned for this facet. If not specified, 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. This limit (300) is configured on Google side, but Google have an ability to change it for specific project. [optional]
loginId String Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. [optional]
overwrites SearchRequestDtoOverwrites [optional]

[Back to Model list] [Back to API list] [Back to README]