Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse

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

Response message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SearchResponse

Returns a new instance of GoogleCloudRetailV2SearchResponse.



2796
2797
2798
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2796

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

Instance Attribute Details

#attribution_token ⇒ String

A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


2753
2754
2755
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2753

def attribution_token
  @attribution_token
end

#corrected_query ⇒ String

If spell correction applies, the corrected query. Otherwise, empty. Corresponds to the JSON property correctedQuery

Returns:

  • (String) 


2758
2759
2760
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2758

def corrected_query
  @corrected_query
end

#facets ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>

Results of facets requested by user. Corresponds to the JSON property facets

Returns:



2763
2764
2765
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2763

def facets
  @facets
end

#next_page_token ⇒ String

A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


2769
2770
2771
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2769

def next_page_token
  @next_page_token
end

#query_expansion_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred. Corresponds to the JSON property queryExpansionInfo

Returns:



2775
2776
2777
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2775

def query_expansion_info
  @query_expansion_info
end

#redirect_uri ⇒ String

The URI of a customer-defined redirect page. If redirect action is triggered, no search will be performed, and only redirect_uri and attribution_token will be set in the response. Corresponds to the JSON property redirectUri

Returns:

  • (String) 


2782
2783
2784
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2782

def redirect_uri
  @redirect_uri
end

#results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>

A list of matched items. The order represents the ranking. Corresponds to the JSON property results

Returns:



2787
2788
2789
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2787

def results
  @results
end

#total_size ⇒ Fixnum

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum) 


2794
2795
2796
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2794

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2801

def update!(**args)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
  @facets = args[:facets] if args.key?(:facets)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
  @results = args[:results] if args.key?(:results)
  @total_size = args[:total_size] if args.key?(:total_size)
end