Places Data

Place class

class google.maps.places . Place implements PlaceOptions
library "places"

 const 
  
 { 
 Place 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Methods

fetchFields

fetchFields(options)

Parameters:

• options: FetchFieldsRequest

Return Value: Promise <{place: Place }>

getNextOpeningTime

getNextOpeningTime([date])

Parameters:

• date: Date optional

Return Value: Promise < Date optional >

Calculates the Date for the next opening time using the Place's Place.regularOpeningHours . Returns undefined if the data is insufficient to calculate the result, or this place is not operational.

isOpen

isOpen([date])

Parameters:

• date: Date optional Defaults to now.

Return Value: Promise <boolean optional >

Check if the place is open at the given Date . Resolves with undefined if the known data for the location is insufficient to calculate this, e.g. if the opening hours are unregistered.

Inherited: toJSON

PlaceOptions interface

interface google.maps.places . PlaceOptions

Options for constructing a Place.

AccessibilityOptions class

class google.maps.places . AccessibilityOptions
library "places"

 const 
  
 { 
 AccessibilityOptions 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

AddressComponent class

class google.maps.places . AddressComponent
library "places"

Address component for the Place's location.

 const 
  
 { 
 AddressComponent 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

AddressDescriptor class

class google.maps.places . AddressDescriptor
library "places"

A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location.

 const 
  
 { 
 AddressDescriptor 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Area class

class google.maps.places . Area
library "places"

Area information and the area's relationship with the target location.

 const 
  
 { 
 Area 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Attribution class

class google.maps.places . Attribution
library "places"

Information about a data provider for a Place.

 const 
  
 { 
 Attribution 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

AuthorAttribution class

class google.maps.places . AuthorAttribution
library "places"

Information about the author of user-generated content.

 const 
  
 { 
 AuthorAttribution 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ConnectorAggregation class

class google.maps.places . ConnectorAggregation
library "places"

EV charging information, aggregated for connectors of the same type and the same charge rate.

 const 
  
 { 
 ConnectorAggregation 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ConsumerAlert class

class google.maps.places . ConsumerAlert
library "places"

The consumer alert message. All text are rendered in the language specified by the languageCode field.

 const 
  
 { 
 ConsumerAlert 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ConsumerAlertDetails class

class google.maps.places . ConsumerAlertDetails
library "places"

Details of the consumer alert message.

 const 
  
 { 
 ConsumerAlertDetails 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Containment constants

constants google.maps.places . Containment
library "places"

Defines the spatial relationship between the target location and the area.

These constants are also usable as strings. In TypeScript, the string literals are defined by the ContainmentString type.

 const 
  
 { 
 Containment 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ContentBlock class

class google.maps.places . ContentBlock
library "places"

ContentBlock describes the content of a summary and where it came from.

 const 
  
 { 
 ContentBlock 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

EVChargeAmenitySummary class

class google.maps.places . EVChargeAmenitySummary
library "places"

AI-generated summary of amenities near the EV charging station. This only applies to places with type electric_vehicle_charging_station .

 const 
  
 { 
 EVChargeAmenitySummary 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

EVChargeOptions class

class google.maps.places . EVChargeOptions
library "places"

Information about the EV charging station hosted in the place.

 const 
  
 { 
 EVChargeOptions 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

EVConnectorType constants

constants google.maps.places . EVConnectorType
library "places"

EV charging connector types.

These constants are also usable as strings. In TypeScript, the string literals are defined by the EVConnectorTypeString type.

 const 
  
 { 
 EVConnectorType 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

EVSearchOptions interface

interface google.maps.places . EVSearchOptions

EV-related options that can be specified for a place search request.

FetchFieldsRequest interface

interface google.maps.places . FetchFieldsRequest

Options for fetching Place fields.

FuelOptions class

class google.maps.places . FuelOptions
library "places"

The most recent information about fuel options in a gas station. This information is updated regularly.

 const 
  
 { 
 FuelOptions 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

FuelPrice class

class google.maps.places . FuelPrice
library "places"

Fuel price information for a given type of fuel.

 const 
  
 { 
 FuelPrice 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

FuelType constants

constants google.maps.places . FuelType
library "places"

Types of fuel.

These constants are also usable as strings. In TypeScript, the string literals are defined by the FuelTypeString type.

 const 
  
 { 
 FuelType 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

GenerativeSummary class

class google.maps.places . GenerativeSummary
library "places"

AI-generated summary of the place.

 const 
  
 { 
 GenerativeSummary 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

GoogleMapsLinks class

class google.maps.places . GoogleMapsLinks
library "places"

Links to trigger different Google Maps actions.

 const 
  
 { 
 GoogleMapsLinks 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Landmark class

class google.maps.places . Landmark
library "places"

Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location.

 const 
  
 { 
 Landmark 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Money class

class google.maps.places . Money
library "places"

A representation of an amount of money with its currency type.

 const 
  
 { 
 Money 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

NeighborhoodSummary class

class google.maps.places . NeighborhoodSummary
library "places"

AI-generated summary of points of interest near the place.

 const 
  
 { 
 NeighborhoodSummary 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

OpeningHours class

class google.maps.places . OpeningHours
library "places"

Information about business hours of a Place.

 const 
  
 { 
 OpeningHours 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

OpeningHoursPeriod class

class google.maps.places . OpeningHoursPeriod
library "places"

A period where the Place is open.

 const 
  
 { 
 OpeningHoursPeriod 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

OpeningHoursPoint class

class google.maps.places . OpeningHoursPoint
library "places"

A point where the Place changes its opening status.

 const 
  
 { 
 OpeningHoursPoint 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

SecondaryOpeningHours class

class google.maps.places . SecondaryOpeningHours extends OpeningHours
library "places"

Information about secondary business hours of a Place.

 const 
  
 { 
 SecondaryOpeningHours 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ParkingOptions class

class google.maps.places . ParkingOptions
library "places"

 const 
  
 { 
 ParkingOptions 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

PaymentOptions class

class google.maps.places . PaymentOptions
library "places"

 const 
  
 { 
 PaymentOptions 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Photo class

class google.maps.places . Photo
library "places"

Information about a photo of a Place.

 const 
  
 { 
 Photo 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

PlusCode class

class google.maps.places . PlusCode
library "places"

Plus code for the Place. See https://plus.codes/ for more information.

 const 
  
 { 
 PlusCode 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

PostalAddress class

class google.maps.places . PostalAddress implements PostalAddressLiteral
library "places"

Represents a postal address (e.g. for a postal service to deliver items to). Note: PostalAddress is used by the JavaScript API to instantiate objects that represent data returned by the Web Service.

 const 
  
 { 
 PostalAddress 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

PostalAddressLiteral interface

interface google.maps.places . PostalAddressLiteral

Data for hydrating a PostalAddress.

PriceLevel constants

constants google.maps.places . PriceLevel
library "places"

Price level for a Place.

These constants are also usable as strings. In TypeScript, the string literals are defined by the PriceLevelString type.

 const 
  
 { 
 PriceLevel 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

PriceRange class

class google.maps.places . PriceRange
library "places"

The price range associated with a Place. endPrice could be unset, which indicates a range without upper bound (e.g. "More than $100").

 const 
  
 { 
 PriceRange 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

Review class

class google.maps.places . Review
library "places"

Information about a review of a Place.

 const 
  
 { 
 Review 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

ReviewSummary class

class google.maps.places . ReviewSummary
library "places"

AI-generated summary of the place user reviews.

 const 
  
 { 
 ReviewSummary 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

SearchByTextRequest interface

interface google.maps.places . SearchByTextRequest

Request interface for Place.searchByText .

Properties
fields	Type: Array <string> Fields to be included in the response, which will be billed for . If ['*'] is passed in, all available fields will be returned and billed for (this is not recommended for production deployments). You can request any property in the Place class as a field.
evSearchOptions optional	Type: EVSearchOptions optional EV-related options that can be specified for a place search request.
futureOpeningBusinessesIncluded optional	Type: boolean optional Include places that are not yet open but are expected to open in the future.
includedType optional	Type: string optional The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types . Only one included type is supported. See SearchByTextRequest.useStrictTypeFiltering
internalUsageAttributionIds optional	Type: Iterable <string> optional Identifiers used to attribute calls to specific packages or OSS libraries.
isOpenNow optional	Type: boolean optional Default: false Used to restrict the search to places that are currently open.
language optional	Type: string optional Place details will be displayed with the preferred language if available. Will default to the browser's language preference. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport .
locationBias optional	Type: LatLng | LatLngLiteral | LatLngBounds | LatLngBoundsLiteral | CircleLiteral | Circle optional The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with locationRestriction.
locationRestriction optional	Type: LatLngBounds | LatLngBoundsLiteral optional The region to search. This location serves as a restriction which means results outside given location will not be returned. Cannot be set along with locationBias.
maxResultCount optional	Type: number optional Maximum number of results to return. It must be between 1 and 20, inclusively.
minRating optional	Type: number optional 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. The input rating will be rounded 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.
priceLevels optional	Type: Array < PriceLevel > optional Used to restrict the search to places that are marked as certain price levels. Any combinations of price levels can be chosen. Defaults to all price levels.
pureServiceAreaBusinessesIncluded optional	Type: boolean optional Include pure service area businesses if the field is set to true. A pure service area business is a business that visits or delivers to customers directly but does not serve customers at their business address. For example, businesses like cleaning services or plumbers may not have a physical address or location on Google Maps. Places will not return fields including location , plusCode , and other location related fields for these businesses.
query optional	Type: string optional
rankBy optional	Type: SearchByTextRankPreference optional
rankPreference optional	Type: SearchByTextRankPreference optional Default: SearchByTextRankPreference.RELEVANCE How results will be ranked in the response.
region optional	Type: string optional 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.
textQuery optional	Type: string optional Required when you do not use SearchByTextRequest.query . The text query for textual search.
useStrictTypeFiltering optional	Type: boolean optional Default: false Used to set strict type filtering for SearchByTextRequest.includedType . If set to true, only results of the same type will be returned.

SearchByTextRankPreference constants

constants google.maps.places . SearchByTextRankPreference
library "places"

RankPreference enum for SearchByTextRequest.

These constants are also usable as strings. In TypeScript, the string literals are defined by the SearchByTextRankPreferenceString type.

 const 
  
 { 
 SearchByTextRankPreference 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

SearchNearbyRequest interface

interface google.maps.places . SearchNearbyRequest

Request interface for Place.searchNearby . For more information on the request, see Places API reference .

SearchNearbyRankPreference constants

constants google.maps.places . SearchNearbyRankPreference
library "places"

RankPreference enum for SearchNearbyRequest.

These constants are also usable as strings. In TypeScript, the string literals are defined by the SearchNearbyRankPreferenceString type.

 const 
  
 { 
 SearchNearbyRankPreference 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

SpatialRelationship constants

constants google.maps.places . SpatialRelationship
library "places"

Defines the spatial relationship between the target location and the landmark

These constants are also usable as strings. In TypeScript, the string literals are defined by the SpatialRelationshipString type.

 const 
  
 { 
 SpatialRelationship 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TimeZone class

class google.maps.places . TimeZone
library "places"

Represents a time zone from the IANA Time Zone Database https://www.iana.org/time-zones .

 const 
  
 { 
 TimeZone 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitAgency class

class google.maps.places . TransitAgency
library "places"

Represents a transit agency.

 const 
  
 { 
 TransitAgency 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitIcon class

class google.maps.places . TransitIcon
library "places"

Represents a transit icon.

 const 
  
 { 
 TransitIcon 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitLine class

class google.maps.places . TransitLine
library "places"

Represents a transit line.

 const 
  
 { 
 TransitLine 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitStation class

class google.maps.places . TransitStation
library "places"

Represents transit-specific information for a place.

 const 
  
 { 
 TransitStation 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitStop class

class google.maps.places . TransitStop
library "places"

Represents a transit stop.

 const 
  
 { 
 TransitStop 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 ); 

TransitVehicleType constants

constants google.maps.places . TransitVehicleType
library "places"

The type of a transit vehicle.

These constants are also usable as strings. In TypeScript, the string literals are defined by the TransitVehicleTypeString type.

 const 
  
 { 
 TransitVehicleType 
 } 
  
 = 
  
 await 
  
 google 
 . 
 maps 
 . 
 importLibrary 
 ( 
 "places" 
 );