Place Stay organized with collections Save and categorize content based on your preferences.
Placeclass
google.maps.places.Place
class
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: AccessibilityOptionsoptional Accessibility options of this Place. undefined if the accessibility options data have not been called for from the server. |
addressComponents | Type: Array<AddressComponent>optional The 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: stringoptional The representation of the Place’s address in theadr microformat. |
allowsDogs | Type: booleanoptional |
attributions | Type: Array<Attribution>optional Data providers that must be shown for the Place. |
businessStatus | Type: BusinessStatusoptional The location's operational status. null if there is no known status.undefined if the status data has not been loaded from the server. |
displayName | Type: stringoptional The location's display name. null if there is no name.undefined if the name data has not been loaded from the server. |
displayNameLanguageCode | Type: stringoptional The 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: stringoptional The editorial summary for this place. null if there is no editorial summary.undefined if this field has not yet been requested. |
editorialSummaryLanguageCode | Type: stringoptional The language of the editorial summary for this place. null if there is no editorial summary.undefined if this field has not yet been requested. |
evChargeOptions | Type: EVChargeOptionsoptional EV Charge options provided by the place. undefined if the EV charge options have not been called for from the server. |
formattedAddress | Type: stringoptional The locations’s full address. |
fuelOptions | Type: FuelOptionsoptional Fuel options provided by the place. undefined if the fuel options have not been called for from the server. |
googleMapsURI | Type: stringoptional URL 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: stringoptional The default HEX color code for the place's category. |
id | Type: string The unique place id. |
internationalPhoneNumber | Type: stringoptional The 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: booleanoptional Whether 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: LatLngoptional The Place’s position. |
nationalPhoneNumber | Type: stringoptional The Place’s phone number, formatted according to thenumber's regional convention. |
parkingOptions | Type: ParkingOptionsoptional Options of parking provided by the place. undefined if the parking options data have not been called for from the server. |
paymentOptions | Type: PaymentOptionsoptional Payment 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: PriceLeveloptional The price level of the Place. This property can return any of the following values
|
priceRange | Type: PriceRangeoptional The price range for this Place. endPrice could be unset, which indicates a range without upper bound (e.g. "More than $100"). |
primaryType | Type: stringoptional The location's primary type. null if there is no type.undefined if the type data has not been loaded from the server. |
primaryTypeDisplayName | Type: stringoptional 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. |
primaryTypeDisplayNameLanguageCode | Type: stringoptional The 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: numberoptional A rating, between 1.0 to 5.0, based on user reviews of this Place. |
regularOpeningHours | Type: OpeningHoursoptional |
requestedLanguage | Type: stringoptional The requested language for this place. |
requestedRegion | Type: stringoptional The requested region for this place. |
reviews | A list of reviews for this Place. |
servesBeer | Type: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: stringoptional URI to the svg image mask resource that can be used to represent a place’s category. |
types | Type: Array<string>optional An array oftypes for this Place (for example, ["political", "locality"] or["restaurant", "establishment"] ). |
userRatingCount | Type: numberoptional The number of user ratings which contributed to this Place’s Place.rating . |
utcOffsetMinutes | Type: numberoptional The 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: LatLngBoundsoptional The preferred viewport when displaying this Place on a map. |
websiteURI | Type: stringoptional The 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.PlaceOptions
interface
Options for constructing a Place.
Properties | |
---|---|
id | Type: string The unique place id. |
requestedLanguageoptional | Type: stringoptional A language identifier for the language in which details should be returned. See thelist of supported languages. |
requestedRegionoptional | Type: stringoptional A 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.AccessibilityOptions
class
Access by callingconst {AccessibilityOptions} = await google.maps.importLibrary("places")
.
SeeLibraries in the Maps JavaScript API.
Properties | |
---|---|
hasWheelchairAccessibleEntrance | Type: booleanoptional Whether 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: booleanoptional Whether a place has wheelchair accessible parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasWheelchairAccessibleRestroom | Type: booleanoptional Whether 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: booleanoptional Whether 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.AddressComponent
class
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: stringoptional The full text of the address component. |
shortText | Type: stringoptional The 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.Attribution
class
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: stringoptional Name of the Place's data provider. |
providerURI | Type: stringoptional URI to the Place's data provider. |
AuthorAttributionclass
google.maps.places.AuthorAttribution
class
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: string Author's name for this result. |
photoURI | Type: stringoptional Author's photo URI for this result. This may not always be available. |
uri | Type: stringoptional Author's profile URI for this result. |
ConnectorAggregationclass
google.maps.places.ConnectorAggregation
class
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: Dateoptional The time when the connector availability information in this aggregation was last updated. |
availableCount | Type: numberoptional Number of connectors in this aggregation that are currently available. |
count | Type: number Number of connectors in this aggregation. |
maxChargeRateKw | Type: number The static max charging rate in kw of each connector of the aggregation. |
outOfServiceCount | Type: numberoptional Number of connectors in this aggregation that are currently out of service. |
type | Type: EVConnectorTypeoptional The connector type of this aggregation. |
EVChargeOptionsclass
google.maps.places.EVChargeOptions
class
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: number Number 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.EVConnectorType
constants
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.EVSearchOptions
interface
EV-related options that can be specified for a place search request.
Properties | |
---|---|
connectorTypesoptional | Type: Array<EVConnectorType>optional The list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out. |
minimumChargingRateKwoptional | Type: numberoptional Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out. |
FetchFieldsRequestinterface
google.maps.places.FetchFieldsRequest
interface
Options for fetching Place fields.
Properties | |
---|---|
fields | Type: Array<string> List of fields to be fetched. |
FuelOptionsclass
google.maps.places.FuelOptions
class
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.FuelPrice
class
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: Moneyoptional The price of the fuel. |
type | Type: FuelTypeoptional The type of fuel. |
updateTime | Type: Dateoptional The time the fuel price was last updated. |
FuelTypeconstants
google.maps.places.FuelType
constants
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. |
Moneyclass
google.maps.places.Money
class
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: string The three-letter currency code, defined in ISO 4217. |
nanos | Type: number Number of nano (10^-9) units of the amount. |
units | Type: number The 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: string Returns a human-readable representation of the amount of money with its currency symbol. |
OpeningHoursclass
google.maps.places.OpeningHours
class
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.OpeningHoursPeriod
class
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: OpeningHoursPointoptional The closing time for the Place. |
open | Type: OpeningHoursPoint The opening time for the Place. |
OpeningHoursPointclass
google.maps.places.OpeningHoursPoint
class
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: number The day of the week, as a number in the range [0, 6], starting on Sunday. For example, 2 means Tuesday. |
hour | Type: number The 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: number The 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.ParkingOptions
class
Access by callingconst {ParkingOptions} = await google.maps.importLibrary("places")
.
SeeLibraries in the Maps JavaScript API.
Properties | |
---|---|
hasFreeGarageParking | Type: booleanoptional Whether a place offers free garage parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasFreeParkingLot | Type: booleanoptional Whether a place offers free parking lots. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasFreeStreetParking | Type: booleanoptional Whether a place offers free street parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidGarageParking | Type: booleanoptional Whether a place offers paid garage parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidParkingLot | Type: booleanoptional Whether a place offers paid parking lots. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasPaidStreetParking | Type: booleanoptional Whether a place offers paid street parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown. |
hasValetParking | Type: booleanoptional Whether 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.PaymentOptions
class
Access by callingconst {PaymentOptions} = await google.maps.importLibrary("places")
.
SeeLibraries in the Maps JavaScript API.
Properties | |
---|---|
acceptsCashOnly | Type: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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: booleanoptional Whether 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.Photo
class
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: stringoptional A link where user can flag a problem with the photo. |
googleMapsURI | Type: stringoptional A link to show the photo on Google Maps. |
heightPx | Type: number The height of the photo in pixels. |
widthPx | Type: number The width of the photo in pixels. |
Methods | |
---|---|
getURI | getURI([options]) Parameters:
Return Value: string Returns the image URL corresponding to the specified options. |
PlusCodeclass
google.maps.places.PlusCode
class
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: stringoptional A 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: stringoptional A plus code with a 1/8000th of a degree by 1/8000th of a degree area. For example, "8FVC9G8F+5W". |
PostalAddressclass
google.maps.places.PostalAddress
class
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: stringoptional The highest administrative subdivision which is used for postal addresses of a country or region. |
languageCode | Type: stringoptional BCP-47 language code of the contents of this address. Examples: "zh-Hant", "ja", "ja-Latn", "en". |
locality | Type: stringoptional Generally refers to the city/town portion of the address. |
organization | Type: stringoptional The name of the organization at the address. |
postalCode | Type: stringoptional Postal code of the address. |
recipients | Type: Array<string> The recipient at the address. |
regionCode | Type: string CLDR 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: stringoptional Sorting code of the address. |
sublocality | Type: stringoptional Sublocality of the address such as neighborhoods, boroughs, or districts. |
PostalAddressLiteralinterface
google.maps.places.PostalAddressLiteral
interface
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.PriceLevel
constants
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.PriceRange
class
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: Moneyoptional The upper end of the price range (inclusive). Price should be lower than this amount. |
startPrice | Type: Money The low end of the price range (inclusive). Price should be at or above this amount. |
Reviewclass
google.maps.places.Review
class
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: AuthorAttributionoptional The reviewer. |
flagContentURI | Type: stringoptional A link where user can flag a problem with the review. |
googleMapsURI | Type: stringoptional A link to show the review on Google Maps. |
publishTime | Type: Dateoptional |
rating | Type: numberoptional The rating of this review, a number between 1.0 and 5.0 (inclusive). |
relativePublishTimeDescription | Type: stringoptional A 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: stringoptional The text of a review. |
textLanguageCode | Type: stringoptional An IETF language code indicating the language in which this review is written. Note that this code includes only the main language tag without any secondary tag indicating country or region. For example, all the English reviews are tagged as 'en' rather than 'en-AU' or 'en-UK'. |
SearchByTextRequestinterface
google.maps.places.SearchByTextRequest
interface
Request interface forPlace.searchByText
.
Properties | |
---|---|
evSearchOptionsoptional | Type: EVSearchOptionsoptional EV-related options that can be specified for a place search request. |
fieldsoptional | Type: Array<string>optional Required when you use this request with Place.searchByText . 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. |
includedTypeoptional | Type: stringoptional 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 |
isOpenNowoptional | Type: booleanoptional Default: false Used to restrict the search to places that are currently open. |
languageoptional | Type: stringoptional 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. |
locationBiasoptional | Type: LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|CircleLiteral|Circleoptional 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. |
locationRestrictionoptional | Type: LatLngBounds|LatLngBoundsLiteraloptional 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. |
maxResultCountoptional | Type: numberoptional Maximum number of results to return. It must be between 1 and 20, inclusively. |
minRatingoptional | Type: numberoptional 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. |
priceLevelsoptional | 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. |
| Deprecated: Please use textQuery instead Type: stringoptional |
| Deprecated: Please use rankPreference instead. Notice: Available only in thev=beta channel. Type: SearchByTextRankPreferenceoptional |
rankPreferenceoptional | Type: SearchByTextRankPreferenceoptional Default: SearchByTextRankPreference.RELEVANCE How results will be ranked in the response. |
regionoptional | Type: stringoptional 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, seehttps://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. |
textQueryoptional | Type: stringoptional Required when you do not use . The text query for textual search. |
useStrictTypeFilteringoptional | Type: booleanoptional Default: false Used 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.SearchByTextRankPreference
constants
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.SearchNearbyRequest
interface
Request interface forPlace.searchNearby
. For more information on the request, seePlaces API reference.
Properties | |
---|---|
locationRestriction | Type: Circle|CircleLiteral The region to search, specified as a circle with center and radius. Results outside given location are not returned. |
excludedPrimaryTypesoptional | Type: Array<string>optional Excluded 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>optional Excluded 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. |
fieldsoptional | Type: Array<string>optional Required when you use this request with Place.searchNearby . 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. |
includedPrimaryTypesoptional | Type: Array<string>optional Included 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>optional Included 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: stringoptional 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. |
maxResultCountoptional | Type: numberoptional Maximum number of results to return. For acceptable values and default, seePlaces API reference. |
rankPreferenceoptional | Type: SearchNearbyRankPreferenceoptional Default: SearchNearbyRankPreference.POPULARITY How results will be ranked in the response. |
regionoptional | Type: stringoptional 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, 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.SearchNearbyRankPreference
constants
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-07-18 UTC.