Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2beta/classes.rb,
lib/google/apis/retail_v2beta/representations.rb,
lib/google/apis/retail_v2beta/representations.rb

Overview

Request message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaSearchRequest

Returns a new instance of GoogleCloudRetailV2betaSearchRequest.



7200
7201
7202
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7200

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpec

Boost specification to boost certain items. Corresponds to the JSON property boostSpec

Returns:



7018
7019
7020
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7018

def boost_spec
  @boost_spec
end

#branch ⇒ String

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

Returns:

  • (String) 


7025
7026
7027
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7025

def branch
  @branch
end

#canonical_filter ⇒ String

The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. Corresponds to the JSON property canonicalFilter

Returns:

  • (String) 


7037
7038
7039
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7037

def canonical_filter
  @canonical_filter
end

#dynamic_facet_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec

The specifications of dynamically generated facets. Corresponds to the JSON property dynamicFacetSpec

Returns:



7042
7043
7044
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7042

def dynamic_facet_spec
  @dynamic_facet_spec
end

#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. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. Corresponds to the JSON property entity

Returns:

  • (String) 


7050
7051
7052
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7050

def entity
  @entity
end

#facet_specs ⇒ Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec>

Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property facetSpecs

Returns:



7057
7058
7059
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7057

def facet_specs
  @facet_specs
end

#filter ⇒ String

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. For more information, see Filter. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property filter

Returns:

  • (String) 


7066
7067
7068
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7066

def filter
  @filter
end

#labels ⇒ Hash<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. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. For more information, see Requirements for labels in the Resource Manager documentation. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


7082
7083
7084
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7082

def labels
  @labels
end

#offset ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7090
7091
7092
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7090

def offset
  @offset
end

#order_by ⇒ String

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. For more information, see Order. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property orderBy

Returns:

  • (String) 


7099
7100
7101
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7099

def order_by
  @order_by
end

#page_categories ⇒ Array<String>

The categories associated with a category page. Must be set 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, 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

Returns:

  • (Array<String>) 


7110
7111
7112
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7110

def page_categories
  @page_categories
end

#page_size ⇒ Fixnum

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

  1. If this field is negative, an INVALID_ARGUMENT is returned. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


7117
7118
7119
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7117

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


7126
7127
7128
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7126

def page_token
  @page_token
end

#personalization_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec

The specification for personalization. Corresponds to the JSON property personalizationSpec

Returns:



7131
7132
7133
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7131

def personalization_spec
  @personalization_spec
end

#query ⇒ String

Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. Corresponds to the JSON property query

Returns:

  • (String) 


7137
7138
7139
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7137

def query
  @query
end

#query_expansion_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur. Corresponds to the JSON property queryExpansionSpec

Returns:



7142
7143
7144
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7142

def query_expansion_spec
  @query_expansion_spec
end

#search_mode ⇒ String

The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. Corresponds to the JSON property searchMode

Returns:

  • (String) 


7148
7149
7150
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7148

def search_mode
  @search_mode
end

#spell_correction_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec

The specification for query spell correction. Corresponds to the JSON property spellCorrectionSpec

Returns:



7153
7154
7155
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7153

def spell_correction_spec
  @spell_correction_spec
end

#user_info ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo

Information of an end user. Corresponds to the JSON property userInfo

Returns:



7158
7159
7160
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7158

def 
  @user_info
end

#variant_rollup_keys ⇒ Array<String>

The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. 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 * variantId * inventory(place_id,price) * inventory(place_id, original_price) * inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map. * 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

Returns:

  • (Array<String>) 


7188
7189
7190
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7188

def variant_rollup_keys
  @variant_rollup_keys
end

#visitor_id ⇒ 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. This should be the same identifier as UserEvent.visitor_id. 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

Returns:

  • (String) 


7198
7199
7200
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7198

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 7205

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)
  @entity = args[:entity] if args.key?(:entity)
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
  @filter = args[:filter] if args.key?(:filter)
  @labels = args[:labels] if args.key?(:labels)
  @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)
  @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
  @query = args[:query] if args.key?(:query)
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
  @search_mode = args[:search_mode] if args.key?(:search_mode)
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_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