Class: Google::Apis::PlacesV1::GoogleMapsPlacesV1Place

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

All the information representing a Place.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleMapsPlacesV1Place

Returns a new instance of GoogleMapsPlacesV1Place.



402
403
404
 
# File 'lib/google/apis/places_v1/classes.rb', line 402

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

Instance Attribute Details

#accessibility_options ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceAccessibilityOptions

Information about the accessibility options a place offers. Corresponds to the JSON property accessibilityOptions

Returns:



137
138
139
 
# File 'lib/google/apis/places_v1/classes.rb', line 137

def accessibility_options
  @accessibility_options
end

#address_components ⇒ Array<Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceAddressComponent>

Repeated components for each locality level. Note the following facts about the address_components[] array: - The array of address components may contain more components than the formatted_address. - The array does not necessarily include all the political entities that contain an address, apart from those included in the formatted_address. To retrieve all the political entities that contain a specific address, you should use reverse geocoding, passing the latitude/longitude of the address as a parameter to the request. - The format of the response is not guaranteed to remain the same between requests. In particular, the number of address_components varies based on the address requested and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response. Corresponds to the JSON property addressComponents

Returns:



153
154
155
 
# File 'lib/google/apis/places_v1/classes.rb', line 153

def address_components
  @address_components
end

#adr_format_address ⇒ String

The place's address in adr microformat: http://microformats.org/wiki/adr. Corresponds to the JSON property adrFormatAddress

Returns:

  • (String) 


158
159
160
 
# File 'lib/google/apis/places_v1/classes.rb', line 158

def adr_format_address
  @adr_format_address
end

#attributions ⇒ Array<Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceAttribution>

A set of data provider that must be shown with this result. Corresponds to the JSON property attributions

Returns:



163
164
165
 
# File 'lib/google/apis/places_v1/classes.rb', line 163

def attributions
  @attributions
end

#business_status ⇒ String

The business status for the place. Corresponds to the JSON property businessStatus

Returns:

  • (String) 


168
169
170
 
# File 'lib/google/apis/places_v1/classes.rb', line 168

def business_status
  @business_status
end

#curbside_pickup ⇒ Boolean Also known as: curbside_pickup?

Specifies if the business supports curbside pickup. Corresponds to the JSON property curbsidePickup

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/google/apis/places_v1/classes.rb', line 173

def curbside_pickup
  @curbside_pickup
end

#current_opening_hours ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceOpeningHours

Information about business hour of the place. Corresponds to the JSON property currentOpeningHours

Returns:



179
180
181
 
# File 'lib/google/apis/places_v1/classes.rb', line 179

def current_opening_hours
  @current_opening_hours
end

#current_secondary_opening_hours ⇒ Array<Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceOpeningHours>

Contains an array of entries for the next seven days including information about secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. This field includes the special_days subfield of all hours, set for dates that have exceptional hours. Corresponds to the JSON property currentSecondaryOpeningHours

Returns:



191
192
193
 
# File 'lib/google/apis/places_v1/classes.rb', line 191

def current_secondary_opening_hours
  @current_secondary_opening_hours
end

#delivery ⇒ Boolean Also known as: delivery?

Specifies if the business supports delivery. Corresponds to the JSON property delivery

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/google/apis/places_v1/classes.rb', line 196

def delivery
  @delivery
end

#dine_in ⇒ Boolean Also known as: dine_in?

Specifies if the business supports indoor or outdoor seating options. Corresponds to the JSON property dineIn

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/google/apis/places_v1/classes.rb', line 202

def dine_in
  @dine_in
end

#display_name ⇒ Google::Apis::PlacesV1::GoogleTypeLocalizedText

Localized variant of a text in a particular language. Corresponds to the JSON property displayName

Returns:



208
209
210
 
# File 'lib/google/apis/places_v1/classes.rb', line 208

def display_name
  @display_name
end

#editorial_summary ⇒ Google::Apis::PlacesV1::GoogleTypeLocalizedText

Localized variant of a text in a particular language. Corresponds to the JSON property editorialSummary

Returns:



213
214
215
 
# File 'lib/google/apis/places_v1/classes.rb', line 213

def editorial_summary
  @editorial_summary
end

#formatted_address ⇒ String

A full, human-readable address for this place. Corresponds to the JSON property formattedAddress

Returns:

  • (String) 


218
219
220
 
# File 'lib/google/apis/places_v1/classes.rb', line 218

def formatted_address
  @formatted_address
end

#google_maps_uri ⇒ String

A URL providing more information about this place. Corresponds to the JSON property googleMapsUri

Returns:

  • (String) 


223
224
225
 
# File 'lib/google/apis/places_v1/classes.rb', line 223

def google_maps_uri
  @google_maps_uri
end

#icon_background_color ⇒ String

Background color for icon_mask in hex format, e.g. #909CE1. Corresponds to the JSON property iconBackgroundColor

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/places_v1/classes.rb', line 228

def icon_background_color
  @icon_background_color
end

#icon_mask_base_uri ⇒ String

A truncated URL to an v2 icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png"). Corresponds to the JSON property iconMaskBaseUri

Returns:

  • (String) 


234
235
236
 
# File 'lib/google/apis/places_v1/classes.rb', line 234

def icon_mask_base_uri
  @icon_mask_base_uri
end

#id ⇒ String

The unique identifier of a place. Corresponds to the JSON property id

Returns:

  • (String) 


239
240
241
 
# File 'lib/google/apis/places_v1/classes.rb', line 239

def id
  @id
end

#international_phone_number ⇒ String

A human-readable phone number for the place, in international format. Corresponds to the JSON property internationalPhoneNumber

Returns:

  • (String) 


244
245
246
 
# File 'lib/google/apis/places_v1/classes.rb', line 244

def international_phone_number
  @international_phone_number
end

#location ⇒ Google::Apis::PlacesV1::GoogleTypeLatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property location

Returns:



252
253
254
 
# File 'lib/google/apis/places_v1/classes.rb', line 252

def location
  @location
end

#name ⇒ String

An ID representing this place which may be used to look up this place again (a. k.a. the API "resource" name: places/place_id). Corresponds to the JSON property name

Returns:

  • (String) 


258
259
260
 
# File 'lib/google/apis/places_v1/classes.rb', line 258

def name
  @name
end

#national_phone_number ⇒ String

A human-readable phone number for the place, in national format. Corresponds to the JSON property nationalPhoneNumber

Returns:

  • (String) 


263
264
265
 
# File 'lib/google/apis/places_v1/classes.rb', line 263

def national_phone_number
  @national_phone_number
end

#plus_code ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1PlacePlusCode

Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location. Corresponds to the JSON property plusCode

Returns:



270
271
272
 
# File 'lib/google/apis/places_v1/classes.rb', line 270

def plus_code
  @plus_code
end

#price_level ⇒ String

Price level of the place. Corresponds to the JSON property priceLevel

Returns:

  • (String) 


275
276
277
 
# File 'lib/google/apis/places_v1/classes.rb', line 275

def price_level
  @price_level
end

#rating ⇒ Float

A rating between 1.0 and 5.0, based on user reviews of this place. Corresponds to the JSON property rating

Returns:

  • (Float) 


280
281
282
 
# File 'lib/google/apis/places_v1/classes.rb', line 280

def rating
  @rating
end

#regular_opening_hours ⇒ Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceOpeningHours

Information about business hour of the place. Corresponds to the JSON property regularOpeningHours

Returns:



285
286
287
 
# File 'lib/google/apis/places_v1/classes.rb', line 285

def regular_opening_hours
  @regular_opening_hours
end

#regular_secondary_opening_hours ⇒ Array<Google::Apis::PlacesV1::GoogleMapsPlacesV1PlaceOpeningHours>

Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. Corresponds to the JSON property regularSecondaryOpeningHours

Returns:



295
296
297
 
# File 'lib/google/apis/places_v1/classes.rb', line 295

def regular_secondary_opening_hours
  @regular_secondary_opening_hours
end

#reservable ⇒ Boolean Also known as: reservable?

Specifies if the place supports reservations. Corresponds to the JSON property reservable

Returns:

  • (Boolean) 


300
301
302
 
# File 'lib/google/apis/places_v1/classes.rb', line 300

def reservable
  @reservable
end

#reviews ⇒ Array<Google::Apis::PlacesV1::GoogleMapsPlacesV1Review>

List of reviews about this place. Corresponds to the JSON property reviews

Returns:



306
307
308
 
# File 'lib/google/apis/places_v1/classes.rb', line 306

def reviews
  @reviews
end

#serves_beer ⇒ Boolean Also known as: serves_beer?

Specifies if the place serves beer. Corresponds to the JSON property servesBeer

Returns:

  • (Boolean) 


311
312
313
 
# File 'lib/google/apis/places_v1/classes.rb', line 311

def serves_beer
  @serves_beer
end

#serves_breakfast ⇒ Boolean Also known as: serves_breakfast?

Specifies if the place serves breakfast. Corresponds to the JSON property servesBreakfast

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/google/apis/places_v1/classes.rb', line 317

def serves_breakfast
  @serves_breakfast
end

#serves_brunch ⇒ Boolean Also known as: serves_brunch?

Specifies if the place serves brunch. Corresponds to the JSON property servesBrunch

Returns:

  • (Boolean) 


323
324
325
 
# File 'lib/google/apis/places_v1/classes.rb', line 323

def serves_brunch
  @serves_brunch
end

#serves_dinner ⇒ Boolean Also known as: serves_dinner?

Specifies if the place serves dinner. Corresponds to the JSON property servesDinner

Returns:

  • (Boolean) 


329
330
331
 
# File 'lib/google/apis/places_v1/classes.rb', line 329

def serves_dinner
  @serves_dinner
end

#serves_lunch ⇒ Boolean Also known as: serves_lunch?

Specifies if the place serves lunch. Corresponds to the JSON property servesLunch

Returns:

  • (Boolean) 


335
336
337
 
# File 'lib/google/apis/places_v1/classes.rb', line 335

def serves_lunch
  @serves_lunch
end

#serves_vegetarian_food ⇒ Boolean Also known as: serves_vegetarian_food?

Specifies if the place serves vegetarian food. Corresponds to the JSON property servesVegetarianFood

Returns:

  • (Boolean) 


341
342
343
 
# File 'lib/google/apis/places_v1/classes.rb', line 341

def serves_vegetarian_food
  @serves_vegetarian_food
end

#serves_wine ⇒ Boolean Also known as: serves_wine?

Specifies if the place serves wine. Corresponds to the JSON property servesWine

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/google/apis/places_v1/classes.rb', line 347

def serves_wine
  @serves_wine
end

#takeout ⇒ Boolean Also known as: takeout?

Specifies if the business supports takeout. Corresponds to the JSON property takeout

Returns:

  • (Boolean) 


353
354
355
 
# File 'lib/google/apis/places_v1/classes.rb', line 353

def takeout
  @takeout
end

#types ⇒ Array<String>

A set of type tags for this result. For example, "political" and "locality". See: https://developers.google.com/maps/documentation/places/web-service/place- types Corresponds to the JSON property types

Returns:

  • (Array<String>) 


361
362
363
 
# File 'lib/google/apis/places_v1/classes.rb', line 361

def types
  @types
end

#user_rating_count ⇒ Fixnum

The total number of reviews (with or without text) for this place. Corresponds to the JSON property userRatingCount

Returns:

  • (Fixnum) 


366
367
368
 
# File 'lib/google/apis/places_v1/classes.rb', line 366

def user_rating_count
  @user_rating_count
end

#utc_offset_minutes ⇒ Fixnum

Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes. Corresponds to the JSON property utcOffsetMinutes

Returns:

  • (Fixnum) 


373
374
375
 
# File 'lib/google/apis/places_v1/classes.rb', line 373

def utc_offset_minutes
  @utc_offset_minutes
end

#viewport ⇒ Google::Apis::PlacesV1::GoogleGeoTypeViewport

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If low = high, the viewport consists of that single point. - If low.longitude > high.longitude, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If low.longitude = -180 degrees and high.longitude = 180 degrees, the viewport includes all longitudes. - If low.longitude = 180 degrees and high. longitude = -180 degrees, the longitude range is empty. - If low.latitude > high.latitude, the latitude range is empty. Both low and high must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: "low": "latitude": 40.477398, " longitude": -74.259087 , "high": "latitude": 40.91618, "longitude": -73. 70018 Corresponds to the JSON property viewport

Returns:



393
394
395
 
# File 'lib/google/apis/places_v1/classes.rb', line 393

def viewport
  @viewport
end

#website_uri ⇒ String

The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain. Corresponds to the JSON property websiteUri

Returns:

  • (String) 


400
401
402
 
# File 'lib/google/apis/places_v1/classes.rb', line 400

def website_uri
  @website_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/google/apis/places_v1/classes.rb', line 407

def update!(**args)
  @accessibility_options = args[:accessibility_options] if args.key?(:accessibility_options)
  @address_components = args[:address_components] if args.key?(:address_components)
  @adr_format_address = args[:adr_format_address] if args.key?(:adr_format_address)
  @attributions = args[:attributions] if args.key?(:attributions)
  @business_status = args[:business_status] if args.key?(:business_status)
  @curbside_pickup = args[:curbside_pickup] if args.key?(:curbside_pickup)
  @current_opening_hours = args[:current_opening_hours] if args.key?(:current_opening_hours)
  @current_secondary_opening_hours = args[:current_secondary_opening_hours] if args.key?(:current_secondary_opening_hours)
  @delivery = args[:delivery] if args.key?(:delivery)
  @dine_in = args[:dine_in] if args.key?(:dine_in)
  @display_name = args[:display_name] if args.key?(:display_name)
  @editorial_summary = args[:editorial_summary] if args.key?(:editorial_summary)
  @formatted_address = args[:formatted_address] if args.key?(:formatted_address)
  @google_maps_uri = args[:google_maps_uri] if args.key?(:google_maps_uri)
  @icon_background_color = args[:icon_background_color] if args.key?(:icon_background_color)
  @icon_mask_base_uri = args[:icon_mask_base_uri] if args.key?(:icon_mask_base_uri)
  @id = args[:id] if args.key?(:id)
  @international_phone_number = args[:international_phone_number] if args.key?(:international_phone_number)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @national_phone_number = args[:national_phone_number] if args.key?(:national_phone_number)
  @plus_code = args[:plus_code] if args.key?(:plus_code)
  @price_level = args[:price_level] if args.key?(:price_level)
  @rating = args[:rating] if args.key?(:rating)
  @regular_opening_hours = args[:regular_opening_hours] if args.key?(:regular_opening_hours)
  @regular_secondary_opening_hours = args[:regular_secondary_opening_hours] if args.key?(:regular_secondary_opening_hours)
  @reservable = args[:reservable] if args.key?(:reservable)
  @reviews = args[:reviews] if args.key?(:reviews)
  @serves_beer = args[:serves_beer] if args.key?(:serves_beer)
  @serves_breakfast = args[:serves_breakfast] if args.key?(:serves_breakfast)
  @serves_brunch = args[:serves_brunch] if args.key?(:serves_brunch)
  @serves_dinner = args[:serves_dinner] if args.key?(:serves_dinner)
  @serves_lunch = args[:serves_lunch] if args.key?(:serves_lunch)
  @serves_vegetarian_food = args[:serves_vegetarian_food] if args.key?(:serves_vegetarian_food)
  @serves_wine = args[:serves_wine] if args.key?(:serves_wine)
  @takeout = args[:takeout] if args.key?(:takeout)
  @types = args[:types] if args.key?(:types)
  @user_rating_count = args[:user_rating_count] if args.key?(:user_rating_count)
  @utc_offset_minutes = args[:utc_offset_minutes] if args.key?(:utc_offset_minutes)
  @viewport = args[:viewport] if args.key?(:viewport)
  @website_uri = args[:website_uri] if args.key?(:website_uri)
end