- HTTP request
- Request body
- Response body
- RankPreference
- LocationBias
- LocationRestriction
- EVOptions
- SearchAlongRouteParameters
- Polyline
- ContextualContent
- Justification
- ReviewJustification
- HighlightedText
- HighlightedTextRange
- BusinessAvailabilityAttributesJustification
Text query based place search.
HTTP request
POST https://places.googleapis.com/v1/places:searchText
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
Fields | |
---|---|
text |
Required. The text query for textual search. |
language |
Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport. |
region |
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. |
rank |
How results will be ranked in the response. |
included |
The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. Only support one included type. |
open |
Used to restrict the search to places that are currently open. The default is false. |
min |
Filter out results whose average user rating is strictly less than this limit. A valid value must be a 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 round 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. |
maxResultCount |
Deprecated: Use The maximum number of results per page that can be returned. If the number of available results is larger than If both |
page |
Optional. The maximum number of results per page that can be returned. If the number of available results is larger than If both |
page |
Optional. A page token, received from a previous TextSearch call. Provide this to retrieve the subsequent page. When paginating, all parameters other than |
price |
Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels. |
strict |
Used to set strict type filtering for includedType. If set to true, only results of the same type will be returned. Default to false. |
location |
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. |
location |
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. |
ev |
Optional. Set the searchable EV options of a place search request. |
routing |
Optional. Additional parameters for routing to results. |
search |
Optional. Additional parameters proto for searching along a route. |
Response body
Response proto for places.searchText.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "places": [ { object ( |
Fields | |
---|---|
places[] |
A list of places that meet the user's text search criteria. |
routing |
A list of routing summaries where each entry associates to the corresponding place in the same index in the |
contextual |
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. A list of contextual contents where each entry associates to the corresponding place in the same index in the places field. The contents that are relevant to the |
next |
A token that can be sent as |
search |
A link allows the user to search with the same text query as specified in the request on Google Maps. |
RankPreference
How results will be ranked in the response.
Enums | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
For a categorical query such as "Restaurants in New York City", RELEVANCE is the default. For non-categorical queries such as "Mountain View, CA" we recommend that you leave rankPreference unset. |
DISTANCE |
Ranks results by distance. |
RELEVANCE |
Ranks results by relevance. Sort order determined by normal ranking stack. |
LocationBias
The region to search. This location serves as a bias which means results around given location might be returned.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
rectangle |
A rectangle box defined by northeast and southwest corner. |
circle |
A circle defined by center point and radius. |
LocationRestriction
The region to search. This location serves as a restriction which means results outside given location will not be returned.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
rectangle |
A rectangle box defined by northeast and southwest corner. |
EVOptions
Searchable EV options of a place search request.
JSON representation |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
Fields | |
---|---|
minimum |
Optional. Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out. |
connector |
Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out. |
SearchAlongRouteParameters
Specifies a precalculated polyline from the Routes API defining the route to search. Searching along a route is similar to using the locationBias
or locationRestriction
request option to bias the search results. However, while the locationBias
and locationRestriction
options let you specify a region to bias the search results, this option lets you bias the results along a trip route.
Results are not guaranteed to be along the route provided, but rather are ranked within the search area defined by the polyline and, optionally, by the locationBias
or locationRestriction
based on minimal detour times from origin to destination. The results might be along an alternate route, especially if the provided polyline does not define an optimal route from origin to destination.
JSON representation |
---|
{
"polyline": {
object ( |
Fields | |
---|---|
polyline |
Required. The route polyline. |
Polyline
A route polyline. Only supports an encoded polyline, which can be passed as a string and includes compression with minimal lossiness. This is the Routes API default output.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field polyline_type . Encapsulates the type of polyline. Routes API output defaults to encoded_polyline . polyline_type can be only one of the following: |
|
encoded |
An encoded polyline, as returned by the Routes API by default. See the encoder and decoder tools. |
ContextualContent
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.
Content that is contextual to the place query.
JSON representation |
---|
{ "reviews": [ { object ( |
Fields | |
---|---|
reviews[] |
List of reviews about this place, contexual to the place query. |
photos[] |
Information (including references) about photos of this place, contexual to the place query. |
justifications[] |
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place. |
Justification
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.
Justifications for the place. Justifications answers the question of why a place could interest an end user.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
review |
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. |
business |
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. |
ReviewJustification
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.
User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is "firewood pizza", the review justification highlights the text relevant to the search query.
JSON representation |
---|
{ "highlightedText": { object ( |
Fields | |
---|---|
highlighted |
|
review |
The review that the highlighted text is generated from. |
HighlightedText
The text highlighted by the justification. This is a subset of the review itself. The exact word to highlight is marked by the HighlightedTextRange. There could be several words in the text being highlighted.
JSON representation |
---|
{
"text": string,
"highlightedTextRanges": [
{
object ( |
Fields | |
---|---|
text |
|
highlighted |
The list of the ranges of the highlighted text. |
HighlightedTextRange
The range of highlighted text.
JSON representation |
---|
{ "startIndex": integer, "endIndex": integer } |
Fields | |
---|---|
start |
|
end |
|
BusinessAvailabilityAttributesJustification
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user.
JSON representation |
---|
{ "takeout": boolean, "delivery": boolean, "dineIn": boolean } |
Fields | |
---|---|
takeout |
If a place provides takeout. |
delivery |
If a place provides delivery. |
dine |
If a place provides dine-in. |