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.



2307
2308
2309
 
# File 'lib/google/apis/places_v1/classes.rb', line 2307

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

Instance Attribute Details

#ev_options ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1SearchTextRequestEvOptions

Searchable EV options of a place search request. Corresponds to the JSON property evOptions

Returns:



2195
2196
2197
 
# File 'lib/google/apis/places_v1/classes.rb', line 2195

def ev_options
  @ev_options
end

#included_type ⇒ String

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

Returns:

  • (String) 


2202
2203
2204
 
# File 'lib/google/apis/places_v1/classes.rb', line 2202

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) 


2211
2212
2213
 
# File 'lib/google/apis/places_v1/classes.rb', line 2211

def language_code
  @language_code
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:



2217
2218
2219
 
# File 'lib/google/apis/places_v1/classes.rb', line 2217

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:



2223
2224
2225
 
# File 'lib/google/apis/places_v1/classes.rb', line 2223

def location_restriction
  @location_restriction
end

#max_result_count ⇒ Fixnum

Deprecated: Use page_size instead. The maximum number of results per page that can be returned. If the number of available results is larger than max_result_count, a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be coerced to 20. Negative values will return an INVALID_ARGUMENT error. If both max_result_count and page_size are specified, max_result_count will be ignored. Corresponds to the JSON property maxResultCount

Returns:

  • (Fixnum) 


2235
2236
2237
 
# File 'lib/google/apis/places_v1/classes.rb', line 2235

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 a float between 0 and 5 (inclusively) at a 0.5 cadence i. e. [0, 0.5, 1.0, ... , 5.0] inclusively. 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) 


2244
2245
2246
 
# File 'lib/google/apis/places_v1/classes.rb', line 2244

def min_rating
  @min_rating
end

#open_now ⇒ Boolean Also known as: open_now?

Used to restrict the search to places that are currently open. The default is false. Corresponds to the JSON property openNow

Returns:

  • (Boolean) 


2250
2251
2252
 
# File 'lib/google/apis/places_v1/classes.rb', line 2250

def open_now
  @open_now
end

#page_size ⇒ Fixnum

Optional. The maximum number of results per page that can be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be set to 20. Negative values will return an INVALID_ARGUMENT error. If both max_result_count and page_size are specified, max_result_count will be ignored. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


2262
2263
2264
 
# File 'lib/google/apis/places_v1/classes.rb', line 2262

def page_size
  @page_size
end

#page_token ⇒ String

Optional. A page token, received from a previous TextSearch call. Provide this to retrieve the subsequent page. When paginating, all parameters other than page_token, page_size, and max_result_count provided to TextSearch must match the initial call that provided the page token. Otherwise an INVALID_ARGUMENT error is returned. Corresponds to the JSON property pageToken

Returns:

  • (String) 


2271
2272
2273
 
# File 'lib/google/apis/places_v1/classes.rb', line 2271

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


2278
2279
2280
 
# File 'lib/google/apis/places_v1/classes.rb', line 2278

def price_levels
  @price_levels
end

#rank_preference ⇒ String

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

Returns:

  • (String) 


2283
2284
2285
 
# File 'lib/google/apis/places_v1/classes.rb', line 2283

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 https://www.unicode.org/cldr/charts/ latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. Corresponds to the JSON property regionCode

Returns:

  • (String) 


2293
2294
2295
 
# File 'lib/google/apis/places_v1/classes.rb', line 2293

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) 


2299
2300
2301
 
# File 'lib/google/apis/places_v1/classes.rb', line 2299

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) 


2305
2306
2307
 
# File 'lib/google/apis/places_v1/classes.rb', line 2305

def text_query
  @text_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
 
# File 'lib/google/apis/places_v1/classes.rb', line 2312

def update!(**args)
  @ev_options = args[:ev_options] if args.key?(:ev_options)
  @included_type = args[:included_type] if args.key?(:included_type)
  @language_code = args[:language_code] if args.key?(:language_code)
  @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)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @price_levels = args[:price_levels] if args.key?(:price_levels)
  @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