Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest

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

Overview

Request message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SearchRequest

Returns a new instance of GoogleCloudRetailV2SearchRequest.



2452
2453
2454
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2452

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpec

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

Returns:



2316
2317
2318
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2316

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) 


2323
2324
2325
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2323

def branch
  @branch
end

#canonical_filter ⇒ 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

Returns:

  • (String) 


2333
2334
2335
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2333

def canonical_filter
  @canonical_filter
end

#dynamic_facet_spec ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec

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

Returns:



2338
2339
2340
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2338

def dynamic_facet_spec
  @dynamic_facet_spec
end

#facet_specs ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec>

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

Returns:



2345
2346
2347
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2345

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. See more details at this user guide. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property filter

Returns:

  • (String) 


2354
2355
2356
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2354

def filter
  @filter
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) 


2362
2363
2364
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2362

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. See more details at this user guide. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2371
2372
2373
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2371

def order_by
  @order_by
end

#page_categories ⇒ Array<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

Returns:

  • (Array<String>) 


2382
2383
2384
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2382

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) 


2389
2390
2391
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2389

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) 


2398
2399
2400
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2398

def page_token
  @page_token
end

#query ⇒ String

Raw search query. Corresponds to the JSON property query

Returns:

  • (String) 


2403
2404
2405
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2403

def query
  @query
end

#query_expansion_spec ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec

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

Returns:



2408
2409
2410
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2408

def query_expansion_spec
  @query_expansion_spec
end

#user_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo

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

Returns:



2413
2414
2415
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2413

def 
  @user_info
end

#variant_rollup_keys ⇒ Array<String>

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 Product.fulfillment_info, a fulfillment type and a fulfillment ID must be provided in the format of " fulfillmentType.filfillmentId". 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.ids for type FulfillmentInfo.Type.PICKUP_IN_STORE. * shipToStore.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo. Type.SHIP_TO_STORE. * sameDayDelivery.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.SAME_DAY_DELIVERY. * nextDayDelivery.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.NEXT_DAY_DELIVERY.

  • customFulfillment1.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_1. * customFulfillment2.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_2. * customFulfillment3.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_3. * customFulfillment4.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_4. * customFulfillment5.id, where id is any FulfillmentInfo.ids for type 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>) 


2440
2441
2442
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2440

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. 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) 


2450
2451
2452
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2450

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
 
# 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