class Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest
Request message for SearchService.Search method.
Attributes
Boost specification to boost certain items. Corresponds to the JSON property `boostSpec` @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpec]
The branch resource name, such as `projects/*/locations/global/catalogs/ default_catalog/branches/0`. Use “default_branch” as the branch ID or leave this field empty, to search products under the default branch. Corresponds to the JSON property `branch` @return [String]
The filter applied to every search request when quality improvement such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality. See SearchRequest.filter for more details about filter syntax. Corresponds to the JSON property `canonicalFilter` @return [String]
The specifications of dynamically generated facets. Corresponds to the JSON property `dynamicFacetSpec` @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec]
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property `facetSpecs` @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec>]
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See more details at this [user guide](https:// cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property `filter` @return [String]
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. This field is only considered if page_token
is unset. If this field is negative, an INVALID_ARGUMENT is returned. Corresponds to the JSON property `offset` @return [Fixnum]
The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this [user guide](https:// cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property `orderBy` @return [String]
The categories associated with a category page. Required for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; 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). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: “pageCategories” : [“Sales > 2017 Black Friday Deals”]. Corresponds to the JSON property `pageCategories` @return [Array<String>]
Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to
-
If this field is negative, an INVALID_ARGUMENT is returned.
Corresponds to the JSON property `pageSize` @return [Fixnum]
A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property `pageToken` @return [String]
Raw search query. Corresponds to the JSON property `query` @return [String]
Specification to determine under which conditions query expansion should occur. Corresponds to the JSON property `queryExpansionSpec` @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec]
Information of an end user. Corresponds to the JSON property `userInfo` @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
The keys to fetch and rollup the matching variant Products attributes. The attributes from all the matching variant Products are merged and de-duplicated. Notice that rollup variant Products attributes will lead to extra query latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of “fulfillmentType. fulfillmentId”. E.g., in “pickupInStore.store123”, “pickupInStore” is fulfillment type and “store123” is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * attributes.key, where key is any key in the Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “pickup-in-store”. * shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo. type “ship-to-store”. * sameDayDelivery.id, where id is any FulfillmentInfo. place_ids for FulfillmentInfo.type “same-day-delivery”. * nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “next-day- delivery”. * customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “custom-type-1”. * customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “custom-type-2”. * customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “custom-type-3”. * customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “custom-type-4”. * customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type “custom-type-5”. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property `variantRollupKeys` @return [Array<String>]
Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property `visitorId` @return [String]
Public Class Methods
# File lib/google/apis/retail_v2/classes.rb, line 2452 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/retail_v2/classes.rb, line 2457 def update!(**args) @boost_spec = args[:boost_spec] if args.key?(:boost_spec) @branch = args[:branch] if args.key?(:branch) @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter) @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec) @facet_specs = args[:facet_specs] if args.key?(:facet_specs) @filter = args[:filter] if args.key?(:filter) @offset = args[:offset] if args.key?(:offset) @order_by = args[:order_by] if args.key?(:order_by) @page_categories = args[:page_categories] if args.key?(:page_categories) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @query = args[:query] if args.key?(:query) @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec) @user_info = args[:user_info] if args.key?(:user_info) @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end