Class: Google::Apis::PlacesV1::GoogleMapsPlacesV1SearchTextRequest

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

Overview

Request proto for SearchText.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleMapsPlacesV1SearchTextRequest

Returns a new instance of GoogleMapsPlacesV1SearchTextRequest.



891
892
893
 
# File 'lib/google/apis/places_v1/classes.rb', line 891

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

Instance Attribute Details

#included_type ⇒ String

The requested place type. Full list of types supported: https://developers. google.com/places/supported_types. Only support one included type. Corresponds to the JSON property includedType

Returns:

  • (String) 


798
799
800
 
# File 'lib/google/apis/places_v1/classes.rb', line 798

def included_type
  @included_type
end

#language_code ⇒ String

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist. Current list of supported languages: https://developers.google.com/maps/faq# languagesupport. Corresponds to the JSON property languageCode

Returns:

  • (String) 


807
808
809
 
# File 'lib/google/apis/places_v1/classes.rb', line 807

def language_code
  @language_code
end

#location ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1SearchTextRequestLocation

[Deprecated!]The region to search. Corresponds to the JSON property location

Returns:



812
813
814
 
# File 'lib/google/apis/places_v1/classes.rb', line 812

def location
  @location
end

#location_bias ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1SearchTextRequestLocationBias

The region to search. This location serves as a bias which means results around given location might be returned. Corresponds to the JSON property locationBias

Returns:



818
819
820
 
# File 'lib/google/apis/places_v1/classes.rb', line 818

def location_bias
  @location_bias
end

#location_restriction ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1SearchTextRequestLocationRestriction

The region to search. This location serves as a restriction which means results outside given location will not be returned. Corresponds to the JSON property locationRestriction

Returns:



824
825
826
 
# File 'lib/google/apis/places_v1/classes.rb', line 824

def location_restriction
  @location_restriction
end

#max_result_count ⇒ Fixnum

Maximum number of results to return. It must be between 1 and 20, inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property maxResultCount

Returns:

  • (Fixnum) 


831
832
833
 
# File 'lib/google/apis/places_v1/classes.rb', line 831

def max_result_count
  @max_result_count
end

#min_rating ⇒ Float

Filter out results whose average user rating is strictly less than this limit. A valid value must be an float between 0 and 5 (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] inclusively. This is to keep parity with LocalRefinement_UserRating. The input rating will round up to the nearest 0.5( ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating. Corresponds to the JSON property minRating

Returns:

  • (Float) 


841
842
843
 
# File 'lib/google/apis/places_v1/classes.rb', line 841

def min_rating
  @min_rating
end

#open_now ⇒ Boolean Also known as: open_now?

Used to restrict the search to places that are open at a specific time. open_now marks if a business is currently open. Corresponds to the JSON property openNow

Returns:

  • (Boolean) 


847
848
849
 
# File 'lib/google/apis/places_v1/classes.rb', line 847

def open_now
  @open_now
end

#price_levels ⇒ Array<String>

Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels. Corresponds to the JSON property priceLevels

Returns:

  • (Array<String>) 


855
856
857
 
# File 'lib/google/apis/places_v1/classes.rb', line 855

def price_levels
  @price_levels
end

#price_range ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1Int32Range

int 32 range. Both min and max are optional. If only min is set, then the range only has a lower bound. If only max is set, then range only has an upper bound. At least one of min and max must be set. Values are inclusive. Corresponds to the JSON property priceRange

Returns:



862
863
864
 
# File 'lib/google/apis/places_v1/classes.rb', line 862

def price_range
  @price_range
end

#rank_preference ⇒ String

How results will be ranked in the response. Corresponds to the JSON property rankPreference

Returns:

  • (String) 


867
868
869
 
# File 'lib/google/apis/places_v1/classes.rb', line 867

def rank_preference
  @rank_preference
end

#region_code ⇒ String

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region- specific place name, if available. The parameter can affect results based on applicable law. For more information, see http://www.unicode.org/reports/tr35/# unicode_region_subtag. Note that 3-digit region codes are not currently supported. Corresponds to the JSON property regionCode

Returns:

  • (String) 


877
878
879
 
# File 'lib/google/apis/places_v1/classes.rb', line 877

def region_code
  @region_code
end

#strict_type_filtering ⇒ Boolean Also known as: strict_type_filtering?

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false. Corresponds to the JSON property strictTypeFiltering

Returns:

  • (Boolean) 


883
884
885
 
# File 'lib/google/apis/places_v1/classes.rb', line 883

def strict_type_filtering
  @strict_type_filtering
end

#text_query ⇒ String

Required. The text query for textual search. Corresponds to the JSON property textQuery

Returns:

  • (String) 


889
890
891
 
# File 'lib/google/apis/places_v1/classes.rb', line 889

def text_query
  @text_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/google/apis/places_v1/classes.rb', line 896

def update!(**args)
  @included_type = args[:included_type] if args.key?(:included_type)
  @language_code = args[:language_code] if args.key?(:language_code)
  @location = args[:location] if args.key?(:location)
  @location_bias = args[:location_bias] if args.key?(:location_bias)
  @location_restriction = args[:location_restriction] if args.key?(:location_restriction)
  @max_result_count = args[:max_result_count] if args.key?(:max_result_count)
  @min_rating = args[:min_rating] if args.key?(:min_rating)
  @open_now = args[:open_now] if args.key?(:open_now)
  @price_levels = args[:price_levels] if args.key?(:price_levels)
  @price_range = args[:price_range] if args.key?(:price_range)
  @rank_preference = args[:rank_preference] if args.key?(:rank_preference)
  @region_code = args[:region_code] if args.key?(:region_code)
  @strict_type_filtering = args[:strict_type_filtering] if args.key?(:strict_type_filtering)
  @text_query = args[:text_query] if args.key?(:text_query)
end