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.



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

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>

Output only. Repeated components for each locality level. Corresponds to the JSON property addressComponents

Returns:



142
143
144
 
# File 'lib/google/apis/places_v1/classes.rb', line 142

def address_components
  @address_components
end

#adr_format_address ⇒ String

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

Returns:

  • (String) 


148
149
150
 
# File 'lib/google/apis/places_v1/classes.rb', line 148

def adr_format_address
  @adr_format_address
end

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

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

Returns:



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

def attributions
  @attributions
end

#business_status ⇒ String

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

Returns:

  • (String) 


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

def business_status
  @business_status
end

#curbside_pickup ⇒ Boolean Also known as: curbside_pickup?

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

Returns:

  • (Boolean) 


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

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:



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

def current_opening_hours
  @current_opening_hours
end

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

Output only. 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:



181
182
183
 
# File 'lib/google/apis/places_v1/classes.rb', line 181

def current_secondary_opening_hours
  @current_secondary_opening_hours
end

#delivery ⇒ Boolean Also known as: delivery?

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

Returns:

  • (Boolean) 


186
187
188
 
# File 'lib/google/apis/places_v1/classes.rb', line 186

def delivery
  @delivery
end

#dine_in ⇒ Boolean Also known as: dine_in?

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

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/google/apis/places_v1/classes.rb', line 193

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:



199
200
201
 
# File 'lib/google/apis/places_v1/classes.rb', line 199

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:



204
205
206
 
# File 'lib/google/apis/places_v1/classes.rb', line 204

def editorial_summary
  @editorial_summary
end

#formatted_address ⇒ String

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

Returns:

  • (String) 


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

def formatted_address
  @formatted_address
end

#google_maps_uri ⇒ String

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

Returns:

  • (String) 


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

def google_maps_uri
  @google_maps_uri
end

#icon_background_color ⇒ String

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

Returns:

  • (String) 


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

def icon_background_color
  @icon_background_color
end

#icon_mask_base_uri ⇒ String

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


225
226
227
 
# File 'lib/google/apis/places_v1/classes.rb', line 225

def icon_mask_base_uri
  @icon_mask_base_uri
end

#id ⇒ String

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

Returns:

  • (String) 


230
231
232
 
# File 'lib/google/apis/places_v1/classes.rb', line 230

def id
  @id
end

#international_phone_number ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'lib/google/apis/places_v1/classes.rb', line 236

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:



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

def location
  @location
end

#name ⇒ String

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

Returns:

  • (String) 


250
251
252
 
# File 'lib/google/apis/places_v1/classes.rb', line 250

def name
  @name
end

#national_phone_number ⇒ String

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

Returns:

  • (String) 


255
256
257
 
# File 'lib/google/apis/places_v1/classes.rb', line 255

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:



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

def plus_code
  @plus_code
end

#price_level ⇒ String

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

Returns:

  • (String) 


267
268
269
 
# File 'lib/google/apis/places_v1/classes.rb', line 267

def price_level
  @price_level
end

#rating ⇒ Float

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

Returns:

  • (Float) 


272
273
274
 
# File 'lib/google/apis/places_v1/classes.rb', line 272

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:



277
278
279
 
# File 'lib/google/apis/places_v1/classes.rb', line 277

def regular_opening_hours
  @regular_opening_hours
end

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

Output only. 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:



287
288
289
 
# File 'lib/google/apis/places_v1/classes.rb', line 287

def regular_secondary_opening_hours
  @regular_secondary_opening_hours
end

#reservable ⇒ Boolean Also known as: reservable?

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

Returns:

  • (Boolean) 


292
293
294
 
# File 'lib/google/apis/places_v1/classes.rb', line 292

def reservable
  @reservable
end

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

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

Returns:



298
299
300
 
# File 'lib/google/apis/places_v1/classes.rb', line 298

def reviews
  @reviews
end

#serves_beer ⇒ Boolean Also known as: serves_beer?

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

Returns:

  • (Boolean) 


303
304
305
 
# File 'lib/google/apis/places_v1/classes.rb', line 303

def serves_beer
  @serves_beer
end

#serves_breakfast ⇒ Boolean Also known as: serves_breakfast?

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

Returns:

  • (Boolean) 


309
310
311
 
# File 'lib/google/apis/places_v1/classes.rb', line 309

def serves_breakfast
  @serves_breakfast
end

#serves_brunch ⇒ Boolean Also known as: serves_brunch?

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

Returns:

  • (Boolean) 


315
316
317
 
# File 'lib/google/apis/places_v1/classes.rb', line 315

def serves_brunch
  @serves_brunch
end

#serves_dinner ⇒ Boolean Also known as: serves_dinner?

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

Returns:

  • (Boolean) 


321
322
323
 
# File 'lib/google/apis/places_v1/classes.rb', line 321

def serves_dinner
  @serves_dinner
end

#serves_lunch ⇒ Boolean Also known as: serves_lunch?

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

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/google/apis/places_v1/classes.rb', line 327

def serves_lunch
  @serves_lunch
end

#serves_vegetarian_food ⇒ Boolean Also known as: serves_vegetarian_food?

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

Returns:

  • (Boolean) 


333
334
335
 
# File 'lib/google/apis/places_v1/classes.rb', line 333

def serves_vegetarian_food
  @serves_vegetarian_food
end

#serves_wine ⇒ Boolean Also known as: serves_wine?

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

Returns:

  • (Boolean) 


339
340
341
 
# File 'lib/google/apis/places_v1/classes.rb', line 339

def serves_wine
  @serves_wine
end

#takeout ⇒ Boolean Also known as: takeout?

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

Returns:

  • (Boolean) 


345
346
347
 
# File 'lib/google/apis/places_v1/classes.rb', line 345

def takeout
  @takeout
end

#types ⇒ Array<String>

Output only. A set of type tags for this result. For example, "political" and " locality". Corresponds to the JSON property types

Returns:

  • (Array<String>) 


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

def types
  @types
end

#user_rating_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


357
358
359
 
# File 'lib/google/apis/places_v1/classes.rb', line 357

def user_rating_count
  @user_rating_count
end

#utc_offset_minutes ⇒ Fixnum

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


364
365
366
 
# File 'lib/google/apis/places_v1/classes.rb', line 364

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:



384
385
386
 
# File 'lib/google/apis/places_v1/classes.rb', line 384

def viewport
  @viewport
end

#website_uri ⇒ String

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


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

def website_uri
  @website_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



399
400
401
402
403
404
405
406
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
 
# File 'lib/google/apis/places_v1/classes.rb', line 399

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