Options
All
  • Public
  • Public/Protected
  • All
Menu

A text search request to be sent to the PlacesService.

Hierarchy

  • TextSearchRequest

Index

Properties

Bounds used to bias results when searching for Places (optional). Both location and radius will be ignored if bounds is set. Results will not be restricted to those inside these bounds; but, results inside it will rank higher.

language?: null | string

A language identifier for the language in which names and addresses should be returned, when possible. See the list of supported languages.

location?: LatLng | LatLngLiteral

The center of the area used to bias results when searching for Places.

query?: string

The request's query term. For example, the name of a place ('Eiffel Tower'), a category followed by the name of a location ('pizza in New York'), or the name of a place followed by a location disambiguator ('Starbucks in Sydney').

radius?: number

The radius of the area used to bias results when searching for Places, in meters.

region?: null | string

A region code to bias results towards. 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").

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