Options
All
  • Public
  • Public/Protected
  • All
Menu

A Place search query to be sent to the PlacesService.

Hierarchy

  • PlaceSearchRequest

Index

Properties

Optional bounds

The bounds within which to search for Places. Both location and radius will be ignored if bounds is set.

Optional keyword

keyword?: string

A term to be matched against all available fields, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

Optional language

language?: null | string

Available only in the v=beta channel: https://goo.gle/3oAthT3. A language identifier for the language in which names and addresses should be returned, when possible. See the list of supported languages. Google often updates the supported languages, so this list may not be exhaustive.

Optional location

location?: LatLng | LatLngLiteral

The location around which to search for Places.

Optional maxPriceLevel

maxPriceLevel?: number

Restricts results to only those places at the specified price level or lower. Valid values are in the range from 0 (most affordable) to 4 (most expensive), inclusive. Must be greater than or equal to minPrice , if specified.

Optional minPriceLevel

minPriceLevel?: number

Restricts results to only those places at the specified price level or higher. Valid values are in the range from 0 (most affordable) to 4 (most expensive), inclusive. Must be less than or equal to maxPrice, if specified.

Optional name

name?: string

Equivalent to keyword. Values in this field are combined with values in the keyword field and passed as part of the same search string.

deprecated

Use keyword instead.

Optional openNow

openNow?: boolean

Restricts results to only those places that are open right now.

Optional radius

radius?: number

The distance from the given location within which to search for Places, in meters. The maximum allowed value is 50 000.

Optional rankBy

rankBy?: RankBy

Specifies the ranking method to use when returning results. Note that when rankBy is set to DISTANCE, you must specify a location but you cannot specify a radius or bounds.

defaultvalue

google.maps.places.RankBy.PROMINENCE

Optional type

type?: string

Searches for places of the given type. The type is translated to the local language of the request's target location and used as a query string. If a query is also provided, it is concatenated to the localized type string. Results of a different type are dropped from the response. Use this field to perform language and region independent categorical searches. Valid types are given here.

Generated using TypeDoc