GoogleMapsPlacesV1SearchTextRequest

import type { GoogleMapsPlacesV1SearchTextRequest } from "https://googleapis.deno.dev/v1/places:v1.ts";

Request proto for SearchText.

interface GoogleMapsPlacesV1SearchTextRequest {

evOptions?: GoogleMapsPlacesV1SearchTextRequestEVOptions;

includedType?: string;

languageCode?: string;

locationBias?: GoogleMapsPlacesV1SearchTextRequestLocationBias;

locationRestriction?: GoogleMapsPlacesV1SearchTextRequestLocationRestriction;

maxResultCount?: number;

minRating?: number;

openNow?: boolean;

pageSize?: number;

pageToken?: string;

priceLevels?:

| "PRICE_LEVEL_UNSPECIFIED"

| "PRICE_LEVEL_FREE"

| "PRICE_LEVEL_INEXPENSIVE"

| "PRICE_LEVEL_MODERATE"

| "PRICE_LEVEL_EXPENSIVE"

| "PRICE_LEVEL_VERY_EXPENSIVE"[];

rankPreference?: "RANK_PREFERENCE_UNSPECIFIED" | "DISTANCE" | "RELEVANCE";

regionCode?: string;

strictTypeFiltering?: boolean;

textQuery?: string;

}

§Properties

evOptions?: GoogleMapsPlacesV1SearchTextRequestEVOptions

[src]

Optional. Set the searchable EV options of a place search request.

includedType?: string

[src]

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.

languageCode?: string

[src]

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.

locationBias?: GoogleMapsPlacesV1SearchTextRequestLocationBias

[src]

The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction.

locationRestriction?: GoogleMapsPlacesV1SearchTextRequestLocationRestriction

[src]

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 location_bias.

maxResultCount?: number

[src]

Deprecated: Use page_size instead. The maximum number of results per page that can be returned. If the number of available results is larger than max_result_count, a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be coerced to 20. Negative values will return an INVALID_ARGUMENT error. If both max_result_count and page_size are specified, max_result_count will be ignored.

minRating?: number

[src]

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.

openNow?: boolean

[src]

Used to restrict the search to places that are currently open. The default is false.

pageSize?: number

[src]

Optional. The maximum number of results per page that can be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be set to 20. Negative values will return an INVALID_ARGUMENT error. If both max_result_count and page_size are specified, max_result_count will be ignored.

pageToken?: string

[src]

Optional. A page token, received from a previous TextSearch call. Provide this to retrieve the subsequent page. When paginating, all parameters other than page_token, page_size, and max_result_count provided to TextSearch must match the initial call that provided the page token. Otherwise an INVALID_ARGUMENT error is returned.

[src]

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.

rankPreference?: "RANK_PREFERENCE_UNSPECIFIED" | "DISTANCE" | "RELEVANCE"

[src]

How results will be ranked in the response.

regionCode?: string

[src]

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.

strictTypeFiltering?: boolean

[src]

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.

textQuery?: string

[src]

Required. The text query for textual search.