API Reference google_api_places v0.11.0
View SourceModules
API client metadata for GoogleApi.Places.V1.
API calls for all endpoints tagged Places
.
Handle Tesla connections for GoogleApi.Places.V1.
A latitude-longitude viewport, represented as two diagonally opposite low
and high
points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If low
= high
, the viewport consists of that single point. - If low.longitude
> high.longitude
, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If low.longitude
= -180 degrees and high.longitude
= 180 degrees, the viewport includes all longitudes. - If low.longitude
= 180 degrees and high.longitude
= -180 degrees, the longitude range is empty. - If low.latitude
> high.latitude
, the latitude range is empty. Both low
and high
must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location.
Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location.
Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location.
Information about the author of the UGC data. Used in Photo, and Review.
Request proto for AutocompletePlaces.
The region to search. The results may be biased around the specified region.
The region to search. The results will be restricted to the specified region.
Response proto for AutocompletePlaces.
An Autocomplete suggestion result.
Text representing a Place or query prediction. The text may be used as is or formatted.
Prediction results for a Place Autocomplete prediction.
Prediction results for a Query Autocomplete prediction.
Identifies a substring within a given text.
Contains a breakdown of a Place or query prediction into main text and secondary text. For Place predictions, the main text contains the specific name of the Place. For query predictions, the main text contains the query. The secondary text contains additional disambiguating features (such as a city or region) to further identify the Place or refine the query.
Circle with a LatLng as center and radius.
A block of content that can be served individually.
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.
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.
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.
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.
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.
The range of highlighted text.
Information about the EV Charge Station hosted in Place. Terminology follows https://afdc.energy.gov/fuels/electricity_infrastructure.html One port could charge one car at a time. One port has one or more connectors. One station has one or more ports.
EV charging information grouped by [type, max_charge_rate_kw]. Shows EV charge aggregation of connectors that have the same type and max charge rate in kw.
The most recent information about fuel options in a gas station. This information is updated regularly.
Fuel price information for a given type.
Information about a photo of a place.
A photo media from Places API.
All the information representing a Place.
Information about the accessibility options a place offers.
The structured components that form the formatted address, if this information is available.
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in.
Information about data providers of this place.
Info about the place in which this place is located.
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place.
Links to trigger different Google Maps actions.
Information about business hour of the place.
A period the place remains in open_now status.
Status changing points.
Structured information for special days that fall within the period that the returned opening hours cover. Special days are days that could impact the business hours of a place, e.g. Christmas day.
Information about parking options for the place. A parking lot could support more than one option at the same time.
Payment options the place accepts.
Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location.
Sub-destinations are specific places associated with a main place. These provide more specific destinations for users who are searching within a large or complex place, like an airport, national park, university, or stadium. For example, sub-destinations at an airport might include associated terminals and parking lots. Sub-destinations return the place ID and place resource name, which can be used in subsequent Place Details (New) requests to fetch richer details, including the sub-destination's display name and location.
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.
The price range associated with a Place. end_price
could be unset, which indicates a range without upper bound (e.g. "More than $100").
Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Reference that the generative content is related to.
Information about a review of a place.
Encapsulates a set of optional conditions to satisfy when calculating the routes.
Parameters to configure the routing calculations to the places in the response, both along a route (where result ranking will be influenced) and for calculating travel times on results.
The duration and distance from the routing origin to a place in the response, and a second leg from that place to the destination, if requested. Note: Adding routingSummaries
in the field mask without also including either the routingParameters.origin
parameter or the searchAlongRouteParameters.polyline.encodedPolyline
parameter in the request causes an error.
A leg is a single portion of a journey from one location to another.
Request proto for Search Nearby.
The region to search.
Response proto for Search Nearby.
Request proto for SearchText.
Searchable EV options of a place search request.
The region to search. This location serves as a bias which means results around given location might be returned.
The region to search. This location serves as a restriction which means results outside given location will not be returned.
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.
Response proto for SearchText.
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
Localized variant of a text in a particular language.
Represents an amount of money with its currency type.
Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.
Represents a time zone from the IANA Time Zone Database.