Options
All
  • Public
  • Public/Protected
  • All
Menu

Request interface for google.maps.places.Place.searchByText.

Hierarchy

  • SearchByTextRequest

Index

Properties

fields: 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). For a list of fields see google.maps.places.PlaceResult. Nested fields can be specified with dot-paths (for example, "geometry.location").

includedType?: string

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 google.maps.places.SearchByTextRequest.useStrictTypeFiltering

isOpenNow?: boolean

Used to restrict the search to places that are currently open.

defaultvalue

false

language?: string

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.

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?: LatLngBounds | LatLngBoundsLiteral

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?: number

Maximum number of results to return. It must be between 1 and 20, inclusively.

minRating?: number

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?: PriceLevel[]

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.

query?: string
deprecated

Please use textQuery instead

Available only in the v=beta channel: https://goo.gle/3oAthT3.

deprecated

Please use rankPreference instead.

How results will be ranked in the response.

defaultvalue

SearchByTextRankPreference.DISTANCE

region?: string

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?: string

Required. The text query for textual search.

useStrictTypeFiltering?: boolean

Used to set strict type filtering for google.maps.places.SearchByTextRequest.includedType. If set to true, only results of the same type will be returned.

defaultvalue

false

Generated using TypeDoc