GoogleCloudRetailV2SearchRequest class

Request message for SearchService.Search method.

Constructors

GoogleCloudRetailV2SearchRequest({GoogleCloudRetailV2SearchRequestBoostSpec? boostSpec, String? branch, String? canonicalFilter, GoogleCloudRetailV2SearchRequestDynamicFacetSpec? dynamicFacetSpec, String? entity, List<GoogleCloudRetailV2SearchRequestFacetSpec>? facetSpecs, String? filter, Map<String, String>? labels, int? offset, String? orderBy, List<String>? pageCategories, int? pageSize, String? pageToken, GoogleCloudRetailV2SearchRequestPersonalizationSpec? personalizationSpec, String? query, GoogleCloudRetailV2SearchRequestQueryExpansionSpec? queryExpansionSpec, String? searchMode, GoogleCloudRetailV2SearchRequestSpellCorrectionSpec? spellCorrectionSpec, GoogleCloudRetailV2UserInfo? userInfo, List<String>? variantRollupKeys, String? visitorId})

GoogleCloudRetailV2SearchRequest.fromJson(Map json_)

Properties

boostSpec ↔ GoogleCloudRetailV2SearchRequestBoostSpec?

Boost specification to boost certain products.

getter/setter pair

branch ↔ String?

The branch resource name, such as projects / * /locations/global/catalogs/default_catalog/branches/0.

getter/setter pair

canonicalFilter ↔ String?

The default filter that is applied when a user performs a search without checking any filters on the search page.

getter/setter pair

dynamicFacetSpec ↔ GoogleCloudRetailV2SearchRequestDynamicFacetSpec?

Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets.

getter/setter pair

entity ↔ String?

The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc.

getter/setter pair

facetSpecs ↔ List<GoogleCloudRetailV2SearchRequestFacetSpec>?

Facet specifications for faceted search.

getter/setter pair

filter ↔ String?

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

labels ↔ Map<String, String>?

The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.

getter/setter pair

offset ↔ int?

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results.

getter/setter pair

orderBy ↔ String?

The order in which products are returned.

getter/setter pair

pageCategories ↔ List<String>?

The categories associated with a category page.

getter/setter pair

pageSize ↔ int?

Maximum number of Products to return.

getter/setter pair

pageToken ↔ String?

A page token SearchResponse.next_page_token, received from a previous SearchService.Search call.

getter/setter pair

personalizationSpec ↔ GoogleCloudRetailV2SearchRequestPersonalizationSpec?

The specification for personalization.

getter/setter pair

query ↔ String?

Raw search query.

getter/setter pair

queryExpansionSpec ↔ GoogleCloudRetailV2SearchRequestQueryExpansionSpec?

The query expansion specification that specifies the conditions under which query expansion occurs.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchMode ↔ String?

The search mode of the search request.

getter/setter pair

spellCorrectionSpec ↔ GoogleCloudRetailV2SearchRequestSpellCorrectionSpec?

The spell correction specification that specifies the mode under which spell correction will take effect.

getter/setter pair

userInfo ↔ GoogleCloudRetailV2UserInfo?

User information.

getter/setter pair

variantRollupKeys ↔ List<String>?

The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes.

getter/setter pair

visitorId ↔ String?

A unique identifier for tracking visitors.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited