Place Stay organized with collections Save and categorize content based on your preferences.
Placeclass
google.maps.places.Placeclass
This class implementsPlaceOptions.
Access by callingconst {Place} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constructor | |
|---|---|
Place | Place(options)Parameters:
|
Static Methods | |
|---|---|
searchByText | searchByText(request)Parameters:
Text query based place search. |
searchNearby | searchNearby(request)Parameters:
Search for nearby places. |
Properties | |
|---|---|
accessibilityOptions | Type: AccessibilityOptionsoptionalAccessibility options of this Place. undefined if the accessibility options data have not been called for from the server. |
addressComponents | Type: Array<AddressComponent>optionalThe collection of address components for this Place’s location. Empty object if there is no known address data. undefined if the address data has not been called for from the server. |
adrFormatAddress | Type: stringoptionalThe representation of the Place’s address in theadr microformat. |
allowsDogs | Type: booleanoptional |
attributions | Type: Array<Attribution>optionalData providers that must be shown for the Place. |
businessStatus | Type: BusinessStatusoptionalThe location's operational status. null if there is no known status.undefined if the status data has not been loaded from the server. |
consumerAlert | Type: ConsumerAlertoptionalThe consumer alert for this place. |
displayName | Type: stringoptionalThe location's display name. null if there is no name.undefined if the name data has not been loaded from the server. |
displayNameLanguageCode | Type: stringoptionalThe language of the location's display name. null if there is no name.undefined if the name data has not been loaded from the server. |
editorialSummary | Type: stringoptionalThe editorial summary for this place. null if there is no editorial summary.undefined if this field has not yet been requested. |
editorialSummaryLanguageCode | Type: stringoptionalThe language of the editorial summary for this place. null if there is no editorial summary.undefined if this field has not yet been requested. |
evChargeAmenitySummary | Type: EvChargeAmenitySummaryoptionalThe EvChargeAmenitySummary for this place. |
evChargeOptions | Type: EVChargeOptionsoptionalEV Charge options provided by the place. undefined if the EV charge options have not been called for from the server. |
formattedAddress | Type: stringoptionalThe locations’s full address. |
fuelOptions | Type: FuelOptionsoptionalFuel options provided by the place. undefined if the fuel options have not been called for from the server. |
generativeSummary | Type: GenerativeSummaryoptionalThe GenerativeSummary for this place. |
googleMapsLinks | Type: GoogleMapsLinksoptionalLinks to trigger different Google Maps actions. |
googleMapsURI | Type: stringoptionalURL of the official Google page for this place. This is the Google-owned page that contains the best available information about the Place. |
hasCurbsidePickup | Type: booleanoptionalWhether a place has curbside pickup. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
hasDelivery | Type: booleanoptionalWhether a place has delivery. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
hasDineIn | Type: booleanoptionalWhether a place has dine in. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
hasLiveMusic | Type: booleanoptional |
hasMenuForChildren | Type: booleanoptional |
hasOutdoorSeating | Type: booleanoptional |
hasRestroom | Type: booleanoptional |
hasTakeout | Type: booleanoptionalWhether a place has takeout. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
iconBackgroundColor | Type: stringoptionalThe default HEX color code for the place's category. |
id | Type: stringThe unique place id. |
internationalPhoneNumber | Type: stringoptionalThe Place’s phone number in international format. International format includes the country code, and is prefixed with the plus (+) sign. |
isGoodForChildren | Type: booleanoptional |
isGoodForGroups | Type: booleanoptional |
isGoodForWatchingSports | Type: booleanoptional |
isReservable | Type: booleanoptionalWhether a place is reservable. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
location | Type: LatLngoptionalThe Place’s position. |
nationalPhoneNumber | Type: stringoptionalThe Place’s phone number, formatted according to thenumber's regional convention. |
neighborhoodSummary | Type: NeighborhoodSummaryoptionalThe NeighborhoodSummary for this place. |
parkingOptions | Type: ParkingOptionsoptionalOptions of parking provided by the place. undefined if the parking options data have not been called for from the server. |
paymentOptions | Type: PaymentOptionsoptionalPayment options provided by the place. undefined if the payment options data have not been called for from the server. |
photos | Photos of this Place. The collection will contain up to ten Photo objects. |
plusCode | Type: PlusCodeoptional |
postalAddress | Type: PostalAddressoptional |
priceLevel | Type: PriceLeveloptionalThe price level of the Place. This property can return any of the following values
|
priceRange | Type: PriceRangeoptionalThe price range for this Place. endPrice could be unset, which indicates a range without upper bound (e.g. "More than $100"). |
primaryType | Type: stringoptionalThe location's primary type. null if there is no type.undefined if the type data has not been loaded from the server. |
primaryTypeDisplayName | Type: stringoptionalThe location's primary type display name. null if there is no type.undefined if the type data has not been loaded from the server. |
primaryTypeDisplayNameLanguageCode | Type: stringoptionalThe language of the location's primary type display name. null if there is no type.undefined if the type data has not been loaded from the server. |
rating | Type: numberoptionalA rating, between 1.0 to 5.0, based on user reviews of this Place. |
regularOpeningHours | Type: OpeningHoursoptional |
requestedLanguage | Type: stringoptionalThe requested language for this place. |
requestedRegion | Type: stringoptionalThe requested region for this place. |
reviews | A list of reviews for this Place. |
reviewSummary | Type: ReviewSummaryoptionalThe ReviewSummary for this place. |
servesBeer | Type: booleanoptionalWhether a place serves beer. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesBreakfast | Type: booleanoptionalWhether a place serves breakfast. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesBrunch | Type: booleanoptionalWhether a place serves brunch. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesCocktails | Type: booleanoptional |
servesCoffee | Type: booleanoptional |
servesDessert | Type: booleanoptional |
servesDinner | Type: booleanoptionalWhether a place serves dinner. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesLunch | Type: booleanoptionalWhether a place serves lunch. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesVegetarianFood | Type: booleanoptionalWhether a place serves vegetarian food. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
servesWine | Type: booleanoptionalWhether a place serves wine. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. Returns 'undefined' if this field has not yet been requested. |
svgIconMaskURI | Type: stringoptionalURI to the svg image mask resource that can be used to represent a place’s category. |
types | Type: Array<string>optionalAn array oftypes for this Place (for example, ["political", "locality"] or["restaurant", "establishment"]). |
userRatingCount | Type: numberoptionalThe number of user ratings which contributed to this Place’s Place.rating. |
utcOffsetMinutes | Type: numberoptionalThe offset from UTC of the Place’s current timezone, in minutes. For example, Austrialian Eastern Standard Time (GMT+10) in daylight savings is 11 hours ahead of UTC, so the utc_offset_minutes will be660. For timezones behind UTC, the offset is negative. For example, theutc_offset_minutes is-60 for Cape Verde. |
viewport | Type: LatLngBoundsoptionalThe preferred viewport when displaying this Place on a map. |
websiteURI | Type: stringoptionalThe authoritative website for this Place, such as a business' homepage. |
| Deprecated: Use Type: OpeningHoursoptional |
| Deprecated: This field was accidentally documented, but has never actually been populated. Type: booleanoptional |
PlaceOptionsinterface
google.maps.places.PlaceOptionsinterface
Options for constructing a Place.
Properties | |
|---|---|
id | Type: stringThe unique place id. |
requestedLanguageoptional | Type: stringoptionalA language identifier for the language in which details should be returned. See thelist of supported languages. |
requestedRegionoptional | Type: stringoptionalA region code of the user's region. This can affect which photos may be returned, and possibly other things. The region code accepts accTLD ("top-level domain") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is "uk" ( .co.uk) while its ISO 3166-1 code is "gb" (technically for the entity of "The United Kingdom of Great Britain and Northern Ireland"). |
AccessibilityOptionsclass
google.maps.places.AccessibilityOptionsclass
Access by callingconst {AccessibilityOptions} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
hasWheelchairAccessibleEntrance | Type: booleanoptionalWhether a place has a wheelchair accessible entrance. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasWheelchairAccessibleParking | Type: booleanoptionalWhether a place has wheelchair accessible parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasWheelchairAccessibleRestroom | Type: booleanoptionalWhether a place has a wheelchair accessible restroom. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasWheelchairAccessibleSeating | Type: booleanoptionalWhether a place offers wheelchair accessible seating. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
AddressComponentclass
google.maps.places.AddressComponentclass
Address component for the Place's location.
Access by callingconst {AddressComponent} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
longText | Type: stringoptionalThe full text of the address component. |
shortText | Type: stringoptionalThe abbreviated, short text of the given address component. |
types | Type: Array<string>An array of strings denoting the type of this address component. A list of valid types can be foundhere. |
Attributionclass
google.maps.places.Attributionclass
Information about a data provider for a Place.
Access by callingconst {Attribution} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
provider | Type: stringoptionalName of the Place's data provider. |
providerURI | Type: stringoptionalURI to the Place's data provider. |
AuthorAttributionclass
google.maps.places.AuthorAttributionclass
Information about the author of user-generated content.
Access by callingconst {AuthorAttribution} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
displayName | Type: stringAuthor's name for this result. |
photoURI | Type: stringoptionalAuthor's photo URI for this result. This may not always be available. |
uri | Type: stringoptionalAuthor's profile URI for this result. |
ConnectorAggregationclass
google.maps.places.ConnectorAggregationclass
EV charging information, aggregated for connectors of the same type and the same charge rate.
Access by callingconst {ConnectorAggregation} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
availabilityLastUpdateTime | Type: DateoptionalThe time when the connector availability information in this aggregation was last updated. |
availableCount | Type: numberoptionalNumber of connectors in this aggregation that are currently available. |
count | Type: numberNumber of connectors in this aggregation. |
maxChargeRateKw | Type: numberThe static max charging rate in kw of each connector of the aggregation. |
outOfServiceCount | Type: numberoptionalNumber of connectors in this aggregation that are currently out of service. |
type | Type: EVConnectorTypeoptionalThe connector type of this aggregation. |
ConsumerAlertclass
google.maps.places.ConsumerAlertclass
The consumer alert message. All text are rendered in the language specified by thelanguageCode field.
Access by callingconst {ConsumerAlert} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
details | Type: ConsumerAlertDetailsoptionalThe details of the consumer alert message. |
languageCode | Type: stringoptionalThe language code of the consumer alert message. |
overview | Type: stringoptionalThe overview of the consumer alert message. |
ConsumerAlertDetailsclass
google.maps.places.ConsumerAlertDetailsclass
Details of the consumer alert message.
Access by callingconst {ConsumerAlertDetails} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
aboutLinkTitle | Type: stringoptionalThe title to show for a link to provide more information. |
aboutLinkURI | Type: stringoptionalThe URI for a link to provide more information. |
description | Type: stringoptionalThe description of the consumer alert message. |
title | Type: stringoptionalThe title to show together with the detailed description. |
ContentBlockclass
google.maps.places.ContentBlockclass
ContentBlock describes the content of a summary and where it came from.
Access by callingconst {ContentBlock} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
content | Type: stringoptionalContent related to the topic. |
contentLanguageCode | Type: stringoptionalLanguage code of the content. |
referencedPlaces | A list of Places referenced. When first retrieved, each Place only contains a place ID in theid field. |
EvChargeAmenitySummaryclass
google.maps.places.EvChargeAmenitySummaryclass
AI-generated summary of amenities near the EV charging station. This only applies to places with typeelectric_vehicle_charging_station.
Access by callingconst {EvChargeAmenitySummary} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
coffee | Type: ContentBlockoptionalA summary of the nearby coffee options. |
disclosureText | Type: stringoptionalThe text for the disclosure relating to this summary. |
disclosureTextLanguageCode | Type: stringoptionalThe language code of the disclosure text. |
flagContentURI | Type: stringoptionalA URI to report a problem with the summary. |
overview | Type: ContentBlockoptionalAn overview of the available amenities. |
restaurant | Type: ContentBlockoptionalA summary of the nearby restaurants. |
store | Type: ContentBlockoptionalA summary of nearby stores. |
EVChargeOptionsclass
google.maps.places.EVChargeOptionsclass
Information about the EV charging station hosted in the place.
Access by callingconst {EVChargeOptions} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
connectorAggregations | Type: Array<ConnectorAggregation>A list of EV charging connector aggregations that contain connectors of the same type and same charge rate. |
connectorCount | Type: numberNumber of connectors at this station. Because some ports can have multiple connectors but only be able to charge one car at a time, the number of connectors may be greater than the total number of cars which can charge simultaneously. |
EVConnectorTypeconstants
google.maps.places.EVConnectorTypeconstants
EV charging connector types.
Access by callingconst {EVConnectorType} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
CCS_COMBO_1 | Combined Charging System (AC and DC). Based on SAE Type-1 J-1772 connector. |
CCS_COMBO_2 | Combined Charging System (AC and DC). Based on Type-2 Mennekes connector. |
CHADEMO | CHAdeMO type connector. |
J1772 | J1772 type 1 connector. |
NACS | The North American Charging System (NACS), standardized as SAE J3400. |
OTHER | Other connector types. |
TESLA | The generic TESLA connector. This is NACS in the North America but can be non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). This value is less representative of an actual connector type, and more represents the ability to charge a Tesla brand vehicle at a Tesla owned charging station. |
TYPE_2 | IEC 62196 type 2 connector. Often referred to as MENNEKES. |
UNSPECIFIED_GB_T | GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types. |
UNSPECIFIED_WALL_OUTLET | Unspecified wall outlet. |
EVSearchOptionsinterface
google.maps.places.EVSearchOptionsinterface
EV-related options that can be specified for a place search request.
Properties | |
|---|---|
connectorTypesoptional | Type: Array<EVConnectorType>optionalThe list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out. |
minimumChargingRateKwoptional | Type: numberoptionalMinimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out. |
FetchFieldsRequestinterface
google.maps.places.FetchFieldsRequestinterface
Options for fetching Place fields.
Properties | |
|---|---|
fields | Type: Array<string>List of fields to be fetched. |
FuelOptionsclass
google.maps.places.FuelOptionsclass
The most recent information about fuel options in a gas station. This information is updated regularly.
Access by callingconst {FuelOptions} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
fuelPrices | A list of fuel prices for each type of fuel this station has, one entry per fuel type. |
FuelPriceclass
google.maps.places.FuelPriceclass
Fuel price information for a given type of fuel.
Access by callingconst {FuelPrice} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
price | Type: MoneyoptionalThe price of the fuel. |
type | Type: FuelTypeoptionalThe type of fuel. |
updateTime | Type: DateoptionalThe time the fuel price was last updated. |
FuelTypeconstants
google.maps.places.FuelTypeconstants
Types of fuel.
Access by callingconst {FuelType} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
BIO_DIESEL | Bio-diesel. |
DIESEL | Diesel fuel. |
DIESEL_PLUS | Diesel plus fuel. |
E100 | E 100. |
E80 | E 80. |
E85 | E 85. |
LPG | LPG. |
METHANE | Methane. |
MIDGRADE | Midgrade. |
PREMIUM | Premium. |
REGULAR_UNLEADED | Regular unleaded. |
SP100 | SP 100. |
SP91 | SP 91. |
SP91_E10 | SP 91 E10. |
SP92 | SP 92. |
SP95 | SP 95. |
SP95_E10 | SP95 E10. |
SP98 | SP 98. |
SP99 | SP 99. |
TRUCK_DIESEL | Truck diesel. |
GenerativeSummaryclass
google.maps.places.GenerativeSummaryclass
AI-generated summary of the place.
Access by callingconst {GenerativeSummary} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
disclosureText | Type: stringoptionalThe text for the disclosure relating to this summary. |
disclosureTextLanguageCode | Type: stringoptionalThe language code of the disclosure text. |
flagContentURI | Type: stringoptionalA URI to report a problem with the summary. |
overview | Type: stringoptionalThe overview of the place. |
overviewLanguageCode | Type: stringoptionalThe language code of the overview. |
GoogleMapsLinksclass
google.maps.places.GoogleMapsLinksclass
Links to trigger different Google Maps actions.
Access by callingconst {GoogleMapsLinks} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
directionsURI | Type: stringoptionalA link to show the directions to the place on Google Maps. The link only populates the destination location and uses the default travel mode DRIVE. |
photosURI | Type: stringoptionalA link to show the photos for the place on Google Maps. |
placeURI | Type: stringoptionalA link to show the place on Google Maps. |
reviewsURI | Type: stringoptionalA link to show the reviews for the place on Google Maps. |
writeAReviewURI | Type: stringoptionalA link to write a review for the place on Google Maps. |
Moneyclass
google.maps.places.Moneyclass
A representation of an amount of money with its currency type.
Access by callingconst {Money} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
currencyCode | Type: stringThe three-letter currency code, defined in ISO 4217. |
nanos | Type: numberNumber of nano (10^-9) units of the amount. |
units | Type: numberThe whole units of the amount. For example, if Money.currencyCode is "USD", then 1 unit is 1 US dollar. |
Methods | |
|---|---|
toString | toString()Parameters: None Return Value: stringReturns a human-readable representation of the amount of money with its currency symbol. |
NeighborhoodSummaryclass
google.maps.places.NeighborhoodSummaryclass
AI-generated summary of points of interest near the place.
Access by callingconst {NeighborhoodSummary} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
description | Type: ContentBlockoptionalA detailed description of the neighborhood. |
disclosureText | Type: stringoptionalThe text for the disclosure relating to this summary. |
disclosureTextLanguageCode | Type: stringoptionalThe language code of the disclosure text. |
flagContentURI | Type: stringoptionalA URI to report a problem with the summary. |
overview | Type: ContentBlockoptionalAn overview of the neighborhood. |
OpeningHoursclass
google.maps.places.OpeningHoursclass
Information about business hours of a Place.
Access by callingconst {OpeningHours} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
periods | Type: Array<OpeningHoursPeriod>Opening periods covering each day of the week, starting from Sunday, in chronological order. Does not include days where the Place is not open. |
weekdayDescriptions | Type: Array<string>An array of seven strings representing the formatted opening hours for each day of the week. The Places Service will format and localize the opening hours appropriately for the current language. The ordering of the elements in this array depends on the language. Some languages start the week on Monday, while others start on Sunday. |
OpeningHoursPeriodclass
google.maps.places.OpeningHoursPeriodclass
A period where the Place is open.
Access by callingconst {OpeningHoursPeriod} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
close | Type: OpeningHoursPointoptionalThe closing time for the Place. |
open | Type: OpeningHoursPointThe opening time for the Place. |
OpeningHoursPointclass
google.maps.places.OpeningHoursPointclass
A point where the Place changes its opening status.
Access by callingconst {OpeningHoursPoint} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
day | Type: numberThe day of the week, as a number in the range [0, 6], starting on Sunday. For example, 2 means Tuesday. |
hour | Type: numberThe hour of the OpeningHoursPoint.time as a number, in the range [0, 23]. This will be reported in the Place’s time zone. |
minute | Type: numberThe minute of the OpeningHoursPoint.time as a number, in the range [0, 59]. This will be reported in the Place’s time zone. |
ParkingOptionsclass
google.maps.places.ParkingOptionsclass
Access by callingconst {ParkingOptions} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
hasFreeGarageParking | Type: booleanoptionalWhether a place offers free garage parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasFreeParkingLot | Type: booleanoptionalWhether a place offers free parking lots. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasFreeStreetParking | Type: booleanoptionalWhether a place offers free street parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidGarageParking | Type: booleanoptionalWhether a place offers paid garage parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidParkingLot | Type: booleanoptionalWhether a place offers paid parking lots. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidStreetParking | Type: booleanoptionalWhether a place offers paid street parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasValetParking | Type: booleanoptionalWhether a place offers valet parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
PaymentOptionsclass
google.maps.places.PaymentOptionsclass
Access by callingconst {PaymentOptions} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
acceptsCashOnly | Type: booleanoptionalWhether a place only accepts payment via cash. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
acceptsCreditCards | Type: booleanoptionalWhether a place accepts payment via credit card. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
acceptsDebitCards | Type: booleanoptionalWhether a place accepts payment via debit card. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
acceptsNFC | Type: booleanoptionalWhether a place accepts payment via NFC. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
Photoclass
google.maps.places.Photoclass
Information about a photo of a Place.
Access by callingconst {Photo} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
authorAttributions | Type: Array<AuthorAttribution>Attribution text to be displayed for this photo. |
flagContentURI | Type: stringoptionalA link where user can flag a problem with the photo. |
googleMapsURI | Type: stringoptionalA link to show the photo on Google Maps. |
heightPx | Type: numberThe height of the photo in pixels. |
widthPx | Type: numberThe width of the photo in pixels. |
Methods | |
|---|---|
getURI | getURI([options])Parameters:
Return Value: stringReturns the image URL corresponding to the specified options. |
PlusCodeclass
google.maps.places.PlusCodeclass
Plus code for the Place. Seehttps://plus.codes/ for more information.
Access by callingconst {PlusCode} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
compoundCode | Type: stringoptionalA plus code with a 1/8000th of a degree by 1/8000th of a degree area where the first four characters (the area code) are dropped and replaced with a locality description. For example, "9G8F+5W Zurich, Switzerland". |
globalCode | Type: stringoptionalA plus code with a 1/8000th of a degree by 1/8000th of a degree area. For example, "8FVC9G8F+5W". |
PostalAddressclass
google.maps.places.PostalAddressclass
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.
This class implementsPostalAddressLiteral.
Access by callingconst {PostalAddress} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
addressLines | Type: Array<string>Unstructured address lines describing the lower levels of an address. |
administrativeArea | Type: stringoptionalThe highest administrative subdivision which is used for postal addresses of a country or region. |
languageCode | Type: stringoptionalBCP-47 language code of the contents of this address. Examples: "zh-Hant", "ja", "ja-Latn", "en". |
locality | Type: stringoptionalGenerally refers to the city/town portion of the address. |
organization | Type: stringoptionalThe name of the organization at the address. |
postalCode | Type: stringoptionalPostal code of the address. |
recipients | Type: Array<string>The recipient at the address. |
regionCode | Type: stringCLDR region code of the country/region of the address. Example: "CH" for Switzerland. Seehttps://cldr.unicode.org/ andhttps://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. |
sortingCode | Type: stringoptionalSorting code of the address. |
sublocality | Type: stringoptionalSublocality of the address such as neighborhoods, boroughs, or districts. |
PostalAddressLiteralinterface
google.maps.places.PostalAddressLiteralinterface
Data for hydrating a PostalAddress.
Properties | |
|---|---|
regionCode | Type: string |
addressLinesoptional | Type: Iterable<string>optional |
administrativeAreaoptional | Type: stringoptional |
languageCodeoptional | Type: stringoptional |
localityoptional | Type: stringoptional |
organizationoptional | Type: stringoptional |
postalCodeoptional | Type: stringoptional |
recipientsoptional | Type: Iterable<string>optional |
sortingCodeoptional | Type: stringoptional |
sublocalityoptional | Type: stringoptional |
PriceLevelconstants
google.maps.places.PriceLevelconstants
Price level for a Place.
Access by callingconst {PriceLevel} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
EXPENSIVE | |
FREE | |
INEXPENSIVE | |
MODERATE | |
VERY_EXPENSIVE | |
PriceRangeclass
google.maps.places.PriceRangeclass
The price range associated with a Place.endPrice could be unset, which indicates a range without upper bound (e.g. "More than $100").
Access by callingconst {PriceRange} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
endPrice | Type: MoneyoptionalThe upper end of the price range (inclusive). Price should be lower than this amount. |
startPrice | Type: MoneyThe low end of the price range (inclusive). Price should be at or above this amount. |
Reviewclass
google.maps.places.Reviewclass
Information about a review of a Place.
Access by callingconst {Review} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
authorAttribution | Type: AuthorAttributionoptionalThe reviewer. |
flagContentURI | Type: stringoptionalA link where user can flag a problem with the review. |
googleMapsURI | Type: stringoptionalA link to show the review on Google Maps. |
originalText | Type: stringoptionalThe review text in its original language. |
originalTextLanguageCode | Type: stringoptionalAn IETF language code indicating the original language of the review. |
publishTime | Type: Dateoptional |
rating | Type: numberoptionalThe rating of this review, a number between 1.0 and 5.0 (inclusive). |
relativePublishTimeDescription | Type: stringoptionalA string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. For example `"a month ago"'. |
text | Type: stringoptionalThe localized text of the review. |
textLanguageCode | Type: stringoptionalAn IETF language code indicating the localized language of the review. |
visitDateMonth | Type: numberoptionalThe month of the date when the review author visited the place. This field is 0-based; 0 is January, and 11 is December. |
visitDateYear | Type: numberoptionalThe year of the date when the review author visited the place. |
ReviewSummaryclass
google.maps.places.ReviewSummaryclass
AI-generated summary of the place user reviews.
Access by callingconst {ReviewSummary} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
disclosureText | Type: stringoptionalThe text for the disclosure relating to this summary. |
disclosureTextLanguageCode | Type: stringoptionalThe language code of the disclosure text. |
flagContentURI | Type: stringoptionalA URI to report a problem with the summary. |
reviewsURI | Type: stringoptionalA URI to show reviews of this place on Google Maps. |
text | Type: stringoptionalThe summary of user reviews. |
textLanguageCode | Type: stringoptionalThe language code of the summary of user reviews. |
SearchByTextRequestinterface
google.maps.places.SearchByTextRequestinterface
Request interface forPlace.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 thePlace class as a field. |
evSearchOptionsoptional | Type: EVSearchOptionsoptionalEV-related options that can be specified for a place search request. |
includedTypeoptional | Type: stringoptionalThe 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 |
isOpenNowoptional | Type: booleanoptionalDefault: falseUsed to restrict the search to places that are currently open. |
languageoptional | Type: stringoptionalPlace 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. |
locationBiasoptional | Type: LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|CircleLiteral|CircleoptionalThe region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with locationRestriction. |
locationRestrictionoptional | Type: LatLngBounds|LatLngBoundsLiteraloptionalThe 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. |
maxResultCountoptional | Type: numberoptionalMaximum number of results to return. It must be between 1 and 20, inclusively. |
minRatingoptional | Type: numberoptionalFilter 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. |
priceLevelsoptional | Type: Array<PriceLevel>optionalUsed 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. |
| Deprecated: Please use textQuery instead Type: stringoptional |
| Deprecated: Please use rankPreference instead. Notice: Available only in thev=beta channel. Type: SearchByTextRankPreferenceoptional |
rankPreferenceoptional | Type: SearchByTextRankPreferenceoptionalDefault: SearchByTextRankPreference.RELEVANCEHow results will be ranked in the response. |
regionoptional | Type: stringoptionalThe 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, seehttps://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. |
textQueryoptional | Type: stringoptionalRequired when you do not use . The text query for textual search. |
useStrictTypeFilteringoptional | Type: booleanoptionalDefault: falseUsed to set strict type filtering for SearchByTextRequest.includedType. If set to true, only results of the same type will be returned. |
SearchByTextRankPreferenceconstants
google.maps.places.SearchByTextRankPreferenceconstants
RankPreference enum for SearchByTextRequest.
Access by callingconst {SearchByTextRankPreference} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
DISTANCE | Ranks results by distance. |
RELEVANCE | Ranks results by relevance. |
SearchNearbyRequestinterface
google.maps.places.SearchNearbyRequestinterface
Request interface forPlace.searchNearby. For more information on the request, seePlaces API reference.
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 thePlace class as a field. |
locationRestriction | Type: Circle|CircleLiteralThe region to search, specified as a circle with center and radius. Results outside given location are not returned. |
excludedPrimaryTypesoptional | Type: Array<string>optionalExcluded primary place types. See thefull list of types supported. A place can only have a single primary type. Up to 50 types may be specified. If you specify the same type in both included andexcluded lists, an INVALID_ARGUMENT error is returned. |
excludedTypesoptional | Type: Array<string>optionalExcluded place types. See thefull list of types supported. A place can have many different place types. Up to 50 types may be specified. If you specify the same type in both included andexcluded lists, an INVALID_ARGUMENT error is returned. |
includedPrimaryTypesoptional | Type: Array<string>optionalIncluded primary place types. See thefull list of types supported. A place can only have a single primary type. Up to 50 types may be specified. If you specify the same type in both included andexcluded lists, an INVALID_ARGUMENT error is returned. |
includedTypesoptional | Type: Array<string>optionalIncluded place types. See thefull list of types supported. A place can have many different place types. Up to 50 types may be specified. If you specify the same type in both included andexcluded lists, an INVALID_ARGUMENT error is returned. |
languageoptional | Type: stringoptionalPlace 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. |
maxResultCountoptional | Type: numberoptionalMaximum number of results to return. For acceptable values and default, seePlaces API reference. |
rankPreferenceoptional | Type: SearchNearbyRankPreferenceoptionalDefault: SearchNearbyRankPreference.POPULARITYHow results will be ranked in the response. |
regionoptional | Type: stringoptionalThe 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, seehttps://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. |
SearchNearbyRankPreferenceconstants
google.maps.places.SearchNearbyRankPreferenceconstants
RankPreference enum for SearchNearbyRequest.
Access by callingconst {SearchNearbyRankPreference} = await google.maps.importLibrary("places").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
DISTANCE | Ranks results by distance. |
POPULARITY | Ranks results by popularity. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-21 UTC.