View Source GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Place (google_api_places v0.5.1)

All the information representing a Place.

Attributes

  • liveMusic (type: boolean(), default: nil) - Place provides live music.
  • rating (type: float(), default: nil) - A rating between 1.0 and 5.0, based on user reviews of this place.
  • delivery (type: boolean(), default: nil) - Specifies if the business supports delivery.
  • attributions (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAttribution.t), default: nil) - A set of data provider that must be shown with this result.
  • servesVegetarianFood (type: boolean(), default: nil) - Specifies if the place serves vegetarian food.
  • name (type: String.t, default: nil) - This Place's resource name, in places/{place_id} format. Can be used to look up the Place.
  • generativeSummary (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceGenerativeSummary.t, default: nil) - Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place.
  • servesBreakfast (type: boolean(), default: nil) - Specifies if the place serves breakfast.
  • currentSecondaryOpeningHours (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t), default: nil) - 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.
  • priceLevel (type: String.t, default: nil) - Price level of the place.
  • allowsDogs (type: boolean(), default: nil) - Place allows dogs.
  • userRatingCount (type: integer(), default: nil) - The total number of reviews (with or without text) for this place.
  • servesDessert (type: boolean(), default: nil) - Place serves dessert.
  • displayName (type: GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t, default: nil) - The localized name of the place, suitable as a short human-readable description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.
  • outdoorSeating (type: boolean(), default: nil) - Place provides outdoor seating.
  • servesCocktails (type: boolean(), default: nil) - Place serves cocktails.
  • takeout (type: boolean(), default: nil) - Specifies if the business supports takeout.
  • paymentOptions (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlacePaymentOptions.t, default: nil) - Payment options the place accepts. If a payment option data is not available, the payment option field will be unset.
  • regularOpeningHours (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t, default: nil) - The regular hours of operation.
  • shortFormattedAddress (type: String.t, default: nil) - A short, human-readable address for this place.
  • internationalPhoneNumber (type: String.t, default: nil) - A human-readable phone number for the place, in international format.
  • servesBeer (type: boolean(), default: nil) - Specifies if the place serves beer.
  • subDestinations (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceSubDestination.t), default: nil) - A list of sub destinations related to the place.
  • editorialSummary (type: GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t, default: nil) - Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
  • googleMapsUri (type: String.t, default: nil) - A URL providing more information about this place.
  • areaSummary (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAreaSummary.t, default: nil) - Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in.
  • currentOpeningHours (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t, default: nil) - The hours of operation for the next seven days (including today). The time period starts at midnight on the date of the request and ends at 11:59 pm six days later. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.
  • reviews (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Review.t), default: nil) - List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.
  • restroom (type: boolean(), default: nil) - Place has restroom.
  • goodForChildren (type: boolean(), default: nil) - Place is good for children.
  • goodForGroups (type: boolean(), default: nil) - Place accommodates groups.
  • addressComponents (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAddressComponent.t), default: nil) - 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.
  • dineIn (type: boolean(), default: nil) - Specifies if the business supports indoor or outdoor seating options.
  • location (type: GoogleApi.Places.V1.Model.GoogleTypeLatLng.t, default: nil) - The position of this place.
  • nationalPhoneNumber (type: String.t, default: nil) - A human-readable phone number for the place, in national format.
  • plusCode (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlacePlusCode.t, default: nil) - Plus code of the place location lat/long.
  • servesBrunch (type: boolean(), default: nil) - Specifies if the place serves brunch.
  • viewport (type: GoogleApi.Places.V1.Model.GoogleGeoTypeViewport.t, default: nil) - A viewport suitable for displaying the place on an average-sized map.
  • websiteUri (type: String.t, default: nil) - 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.
  • utcOffsetMinutes (type: integer(), default: nil) - 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.
  • businessStatus (type: String.t, default: nil) - The business status for the place.
  • menuForChildren (type: boolean(), default: nil) - Place has a children's menu.
  • regularSecondaryOpeningHours (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t), default: nil) - 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.
  • curbsidePickup (type: boolean(), default: nil) - Specifies if the business supports curbside pickup.
  • evChargeOptions (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1EVChargeOptions.t, default: nil) - Information of ev charging options.
  • servesLunch (type: boolean(), default: nil) - Specifies if the place serves lunch.
  • servesWine (type: boolean(), default: nil) - Specifies if the place serves wine.
  • goodForWatchingSports (type: boolean(), default: nil) - Place is suitable for watching sports.
  • fuelOptions (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1FuelOptions.t, default: nil) - The most recent information about fuel options in a gas station. This information is updated regularly.
  • formattedAddress (type: String.t, default: nil) - A full, human-readable address for this place.
  • photos (type: list(GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Photo.t), default: nil) - Information (including references) about photos of this place. A maximum of 10 photos can be returned.
  • reservable (type: boolean(), default: nil) - Specifies if the place supports reservations.
  • iconMaskBaseUri (type: String.t, default: nil) - A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
  • servesDinner (type: boolean(), default: nil) - Specifies if the place serves dinner.
  • primaryType (type: String.t, default: nil) - The primary type of the given result. This type must one of the Places API supported types. For example, "restaurant", "cafe", "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
  • accessibilityOptions (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAccessibilityOptions.t, default: nil) - Information about the accessibility options a place offers.
  • types (type: list(String.t), default: nil) - A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
  • servesCoffee (type: boolean(), default: nil) - Place serves coffee.
  • iconBackgroundColor (type: String.t, default: nil) - Background color for icon_mask in hex format, e.g. #909CE1.
  • primaryTypeDisplayName (type: GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t, default: nil) - The display name of the primary type, localized to the request language if applicable. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
  • parkingOptions (type: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceParkingOptions.t, default: nil) - Options of parking provided by the place.
  • adrFormatAddress (type: String.t, default: nil) - The place's address in adr microformat: http://microformats.org/wiki/adr.
  • id (type: String.t, default: nil) - The unique identifier of a place.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Place{
  accessibilityOptions:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAccessibilityOptions.t()
    | nil,
  addressComponents:
    [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAddressComponent.t()]
    | nil,
  adrFormatAddress: String.t() | nil,
  allowsDogs: boolean() | nil,
  areaSummary:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAreaSummary.t() | nil,
  attributions:
    [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceAttribution.t()] | nil,
  businessStatus: String.t() | nil,
  curbsidePickup: boolean() | nil,
  currentOpeningHours:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t() | nil,
  currentSecondaryOpeningHours:
    [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t()] | nil,
  delivery: boolean() | nil,
  dineIn: boolean() | nil,
  displayName: GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t() | nil,
  editorialSummary: GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t() | nil,
  evChargeOptions:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1EVChargeOptions.t() | nil,
  formattedAddress: String.t() | nil,
  fuelOptions:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1FuelOptions.t() | nil,
  generativeSummary:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceGenerativeSummary.t() | nil,
  goodForChildren: boolean() | nil,
  goodForGroups: boolean() | nil,
  goodForWatchingSports: boolean() | nil,
  googleMapsUri: String.t() | nil,
  iconBackgroundColor: String.t() | nil,
  iconMaskBaseUri: String.t() | nil,
  id: String.t() | nil,
  internationalPhoneNumber: String.t() | nil,
  liveMusic: boolean() | nil,
  location: GoogleApi.Places.V1.Model.GoogleTypeLatLng.t() | nil,
  menuForChildren: boolean() | nil,
  name: String.t() | nil,
  nationalPhoneNumber: String.t() | nil,
  outdoorSeating: boolean() | nil,
  parkingOptions:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceParkingOptions.t() | nil,
  paymentOptions:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlacePaymentOptions.t() | nil,
  photos: [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Photo.t()] | nil,
  plusCode: GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlacePlusCode.t() | nil,
  priceLevel: String.t() | nil,
  primaryType: String.t() | nil,
  primaryTypeDisplayName:
    GoogleApi.Places.V1.Model.GoogleTypeLocalizedText.t() | nil,
  rating: float() | nil,
  regularOpeningHours:
    GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t() | nil,
  regularSecondaryOpeningHours:
    [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceOpeningHours.t()] | nil,
  reservable: boolean() | nil,
  restroom: boolean() | nil,
  reviews: [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1Review.t()] | nil,
  servesBeer: boolean() | nil,
  servesBreakfast: boolean() | nil,
  servesBrunch: boolean() | nil,
  servesCocktails: boolean() | nil,
  servesCoffee: boolean() | nil,
  servesDessert: boolean() | nil,
  servesDinner: boolean() | nil,
  servesLunch: boolean() | nil,
  servesVegetarianFood: boolean() | nil,
  servesWine: boolean() | nil,
  shortFormattedAddress: String.t() | nil,
  subDestinations:
    [GoogleApi.Places.V1.Model.GoogleMapsPlacesV1PlaceSubDestination.t()] | nil,
  takeout: boolean() | nil,
  types: [String.t()] | nil,
  userRatingCount: integer() | nil,
  utcOffsetMinutes: integer() | nil,
  viewport: GoogleApi.Places.V1.Model.GoogleGeoTypeViewport.t() | nil,
  websiteUri: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.