Place class
google.maps.places
. Place
class
This class implements PlaceOptions
.
Access by calling const {Place} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Constructor
Place(options)
-
options
:PlaceOptions
Static Methods
Properties
AccessibilityOptions
optional
undefined
if the accessibility options data have not been called for from the server. Array
< AddressComponent
> optional
undefined
if the address data has not been called for from the server.string optional
boolean optional
Array
< Attribution
> optional
BusinessStatus
optional
null
if there is no known status. undefined
if the status data has not been loaded from the server.string optional
null
if there is no name. undefined
if the name data has not been loaded from the server.string optional
null
if there is no name. undefined
if the name data has not been loaded from the server.string optional
null
if there is no editorial summary. undefined
if this field has not yet been requested.string optional
null
if there is no editorial summary. undefined
if this field has not yet been requested. EVChargeOptions
optional
undefined
if the EV charge options have not been called for from the server.string optional
FuelOptions
optional
undefined
if the fuel options have not been called for from the server. GoogleMapsLinks
optional
string optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
string optional
string
string optional
boolean optional
boolean optional
boolean optional
boolean optional
string optional
ParkingOptions
optional
undefined
if the parking options data have not been called for from the server. PaymentOptions
optional
undefined
if the payment options data have not been called for from the server. PostalAddress
optional
PriceLevel
optional
-
Free
-
Inexpensive
-
Moderate
-
Expensive
-
Very Expensive
PriceRange
optional
endPrice
could be unset, which indicates a range without upper bound (e.g. "More than $100").string optional
null
if there is no type. undefined
if the type data has not been loaded from the server.string optional
null
if there is no type. undefined
if the type data has not been loaded from the server.string optional
null
if there is no type. undefined
if the type data has not been loaded from the server. OpeningHours
optional
string optional
string optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
boolean optional
string optional
Array
<string> optional
["political", "locality"]
or ["restaurant", "establishment"]
).number optional
number optional
utc_offset_minutes
will be 660
. For timezones behind UTC, the offset is negative. For example, the utc_offset_minutes
is -60
for Cape Verde.string optional
OpeningHours
optional
boolean optional
Methods
PlaceOptions interface
google.maps.places
. PlaceOptions
interface
Options for constructing a Place.
Properties |
|
---|---|
id
|
Type:
string
The unique place id.
|
requestedLanguage
optional
|
Type:
string optional
A language identifier for the language in which details should be returned. See the list of supported languages
.
|
requestedRegion
optional
|
Type:
string optional
A region code of the user's region. This can affect which photos may be returned, and possibly other things. The region code accepts a ccTLD ("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"). |
AccessibilityOptions class
google.maps.places
. AccessibilityOptions
class
Access by calling const {AccessibilityOptions} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
hasWheelchairAccessibleEntrance
|
Type:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
Whether a place offers wheelchair accessible seating. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown.
|
AddressComponent class
google.maps.places
. AddressComponent
class
Address component for the Place's location.
Access by calling const {AddressComponent} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
longText
|
Type:
string optional
The full text of the address component.
|
shortText
|
Type:
string optional
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 found here
.
|
Attribution class
google.maps.places
. Attribution
class
Information about a data provider for a Place.
Access by calling const {Attribution} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
provider
|
Type:
string optional
Name of the Place's data provider.
|
providerURI
|
Type:
string optional
URI to the Place's data provider.
|
AuthorAttribution class
google.maps.places
. AuthorAttribution
class
Information about the author of user-generated content.
Access by calling const {AuthorAttribution} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
displayName
|
Type:
string
Author's name for this result.
|
photoURI
|
Type:
string optional
Author's photo URI for this result. This may not always be available.
|
uri
|
Type:
string optional
Author's profile URI for this result.
|
ConnectorAggregation class
google.maps.places
. ConnectorAggregation
class
EV charging information, aggregated for connectors of the same type and the same charge rate.
Access by calling const {ConnectorAggregation} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
availabilityLastUpdateTime
|
Type:
Date
optional
The time when the connector availability information in this aggregation was last updated.
|
availableCount
|
Type:
number optional
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:
number optional
Number of connectors in this aggregation that are currently out of service.
|
type
|
Type:
EVConnectorType
optional
The connector type of this aggregation.
|
EVChargeOptions class
google.maps.places
. EVChargeOptions
class
Information about the EV charging station hosted in the place.
Access by calling const {EVChargeOptions} = await google.maps.importLibrary("places")
.See Libraries 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.
|
EVConnectorType constants
google.maps.places
. EVConnectorType
constants
EV charging connector types.
Access by calling const {EVConnectorType} = await google.maps.importLibrary("places")
.See Libraries 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. |
EVSearchOptions interface
google.maps.places
. EVSearchOptions
interface
EV-related options that can be specified for a place search request.
Properties |
|
---|---|
connectorTypes
optional
|
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.
|
minimumChargingRateKw
optional
|
Type:
number optional
Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out.
|
FetchFieldsRequest interface
google.maps.places
. FetchFieldsRequest
interface
Options for fetching Place fields.
Properties |
|
---|---|
fields
|
Type:
Array
<string>
List of fields to be fetched.
|
FuelOptions class
google.maps.places
. FuelOptions
class
The most recent information about fuel options in a gas station. This information is updated regularly.
Access by calling const {FuelOptions} = await google.maps.importLibrary("places")
.See Libraries 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.
|
FuelPrice class
google.maps.places
. FuelPrice
class
Fuel price information for a given type of fuel.
Access by calling const {FuelPrice} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
price
|
Type:
Money
optional
The price of the fuel.
|
type
|
Type:
FuelType
optional
The type of fuel.
|
updateTime
|
Type:
Date
optional
The time the fuel price was last updated.
|
FuelType constants
google.maps.places
. FuelType
constants
Types of fuel.
Access by calling const {FuelType} = await google.maps.importLibrary("places")
.See Libraries 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. |
GoogleMapsLinks class
google.maps.places
. GoogleMapsLinks
class
Links to trigger different Google Maps actions.
Access by calling const {GoogleMapsLinks} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
directionsURI
|
Type:
string optional
A 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:
string optional
A link to show the photos for the place on Google Maps.
|
placeURI
|
Type:
string optional
A link to show the place on Google Maps.
|
reviewsURI
|
Type:
string optional
A link to show the reviews for the place on Google Maps.
|
writeAReviewURI
|
Type:
string optional
A link to write a review for the place on Google Maps.
|
Money class
google.maps.places
. Money
class
A representation of an amount of money with its currency type.
Access by calling const {Money} = await google.maps.importLibrary("places")
.See Libraries 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.
|
OpeningHours class
google.maps.places
. OpeningHours
class
Information about business hours of a Place.
Access by calling const {OpeningHours} = await google.maps.importLibrary("places")
.See Libraries 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.
|
OpeningHoursPeriod class
google.maps.places
. OpeningHoursPeriod
class
A period where the Place is open.
Access by calling const {OpeningHoursPeriod} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
close
|
Type:
OpeningHoursPoint
optional
The closing time for the Place.
|
open
|
Type:
OpeningHoursPoint
The opening time for the Place.
|
OpeningHoursPoint class
google.maps.places
. OpeningHoursPoint
class
A point where the Place changes its opening status.
Access by calling const {OpeningHoursPoint} = await google.maps.importLibrary("places")
.See Libraries 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.
|
ParkingOptions class
google.maps.places
. ParkingOptions
class
Access by calling const {ParkingOptions} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
hasFreeGarageParking
|
Type:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
Whether a place offers valet parking. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown.
|
PaymentOptions class
google.maps.places
. PaymentOptions
class
Access by calling const {PaymentOptions} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
acceptsCashOnly
|
Type:
boolean optional
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:
boolean optional
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:
boolean optional
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:
boolean optional
Whether a place accepts payment via NFC. Returns 'true' or 'false' if the value is known. Returns 'null' if the value is unknown.
|
Photo class
google.maps.places
. Photo
class
Information about a photo of a Place.
Access by calling const {Photo} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
authorAttributions
|
Type:
Array
< AuthorAttribution
>
Attribution text to be displayed for this photo.
|
flagContentURI
|
Type:
string optional
A link where user can flag a problem with the photo.
|
googleMapsURI
|
Type:
string optional
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([options])
-
options
:PhotoOptions optional
string
PlusCode class
google.maps.places
. PlusCode
class
Plus code for the Place. See https://plus.codes/ for more information.
Access by calling const {PlusCode} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
compoundCode
|
Type:
string optional
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:
string optional
A plus code with a 1/8000th of a degree by 1/8000th of a degree area. For example, "8FVC9G8F+5W".
|
PostalAddress class
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 implements PostalAddressLiteral
.
Access by calling const {PostalAddress} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
addressLines
|
Type:
Array
<string>
Unstructured address lines describing the lower levels of an address.
|
administrativeArea
|
Type:
string optional
The highest administrative subdivision which is used for postal addresses of a country or region.
|
languageCode
|
Type:
string optional
BCP-47 language code of the contents of this address. Examples: "zh-Hant", "ja", "ja-Latn", "en".
|
locality
|
Type:
string optional
Generally refers to the city/town portion of the address.
|
organization
|
Type:
string optional
The name of the organization at the address.
|
postalCode
|
Type:
string optional
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. See https://cldr.unicode.org/
and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
for details.
|
sortingCode
|
Type:
string optional
Sorting code of the address.
|
sublocality
|
Type:
string optional
Sublocality of the address such as neighborhoods, boroughs, or districts.
|
PostalAddressLiteral interface
google.maps.places
. PostalAddressLiteral
interface
Data for hydrating a PostalAddress.
Properties |
|
---|---|
regionCode
|
Type:
string
|
addressLines
optional
|
Type:
Iterable
<string> optional
|
administrativeArea
optional
|
Type:
string optional
|
languageCode
optional
|
Type:
string optional
|
locality
optional
|
Type:
string optional
|
organization
optional
|
Type:
string optional
|
postalCode
optional
|
Type:
string optional
|
recipients
optional
|
Type:
Iterable
<string> optional
|
sortingCode
optional
|
Type:
string optional
|
sublocality
optional
|
Type:
string optional
|
PriceLevel constants
google.maps.places
. PriceLevel
constants
Price level for a Place.
Access by calling const {PriceLevel} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Constants |
|
---|---|
EXPENSIVE
|
|
FREE
|
|
INEXPENSIVE
|
|
MODERATE
|
|
VERY_EXPENSIVE
|
PriceRange class
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 calling const {PriceRange} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
endPrice
|
Type:
Money
optional
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.
|
Review class
google.maps.places
. Review
class
Information about a review of a Place.
Access by calling const {Review} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Properties |
|
---|---|
authorAttribution
|
Type:
AuthorAttribution
optional
The reviewer.
|
flagContentURI
|
Type:
string optional
A link where user can flag a problem with the review.
|
googleMapsURI
|
Type:
string optional
A link to show the review on Google Maps.
|
originalText
|
Type:
string optional
The review text in its original language.
|
originalTextLanguageCode
|
Type:
string optional
An IETF language code indicating the original language of the review.
|
publishTime
|
Type:
Date
optional
|
rating
|
Type:
number optional
The rating of this review, a number between 1.0 and 5.0 (inclusive).
|
relativePublishTimeDescription
|
Type:
string optional
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:
string optional
The localized text of the review.
|
textLanguageCode
|
Type:
string optional
An IETF language code indicating the localized language of the review.
|
SearchByTextRequest interface
google.maps.places
. SearchByTextRequest
interface
Request interface for Place.searchByText
.
Properties |
|
---|---|
evSearchOptions
optional
|
Type:
EVSearchOptions
optional
EV-related options that can be specified for a place search request.
|
fields
optional
|
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 the Place
class as a field. |
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
|
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.
|
|
Type:
string 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
|
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
google.maps.places
. SearchByTextRankPreference
constants
RankPreference enum for SearchByTextRequest.
Access by calling const {SearchByTextRankPreference} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Constants |
|
---|---|
DISTANCE
|
Ranks results by distance. |
RELEVANCE
|
Ranks results by relevance. |
SearchNearbyRequest interface
google.maps.places
. SearchNearbyRequest
interface
Request interface for Place.searchNearby
. For more information on the request, see Places 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.
|
excludedPrimaryTypes
optional
|
Type:
Array
<string> optional
Excluded primary place types. See the full 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
and excluded
lists, an INVALID_ARGUMENT error is returned. |
excludedTypes
optional
|
Type:
Array
<string> optional
Excluded place types. See the full 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
and excluded
lists, an INVALID_ARGUMENT error is returned. |
fields
optional
|
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 the Place
class as a field. |
includedPrimaryTypes
optional
|
Type:
Array
<string> optional
Included primary place types. See the full 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
and excluded
lists, an INVALID_ARGUMENT error is returned. |
includedTypes
optional
|
Type:
Array
<string> optional
Included place types. See the full 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
and excluded
lists, an INVALID_ARGUMENT error is returned. |
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
.
|
maxResultCount
optional
|
Type:
number optional
|
rankPreference
optional
|
Type:
SearchNearbyRankPreference
optional
Default:
SearchNearbyRankPreference.POPULARITY
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.
|
SearchNearbyRankPreference constants
google.maps.places
. SearchNearbyRankPreference
constants
RankPreference enum for SearchNearbyRequest.
Access by calling const {SearchNearbyRankPreference} = await google.maps.importLibrary("places")
.See Libraries in the Maps JavaScript API
.
Constants |
|
---|---|
DISTANCE
|
Ranks results by distance. |
POPULARITY
|
Ranks results by popularity. |