Show / Hide Table of Contents

Namespace Google.Maps.Places.V1

Classes

AddressDescriptor

A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location.

AddressDescriptor.Types

Container for nested types declared in the AddressDescriptor message type.

AddressDescriptor.Types.Area

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.

AddressDescriptor.Types.Area.Types

Container for nested types declared in the Area message type.

AddressDescriptor.Types.Landmark

Basic landmark information and the landmark's relationship with the target location.

Landmarks are prominent places that can be used to describe a location.

AddressDescriptor.Types.Landmark.Types

Container for nested types declared in the Landmark message type.

AuthorAttribution

Information about the author of the UGC data. Used in [Photo][google.maps.places.v1.Photo], and [Review][google.maps.places.v1.Review].

AutocompletePlacesRequest

Request proto for AutocompletePlaces.

AutocompletePlacesRequest.Types

Container for nested types declared in the AutocompletePlacesRequest message type.

AutocompletePlacesRequest.Types.LocationBias

The region to search. The results may be biased around the specified region.

AutocompletePlacesRequest.Types.LocationRestriction

The region to search. The results will be restricted to the specified region.

AutocompletePlacesResponse

Response proto for AutocompletePlaces.

AutocompletePlacesResponse.Types

Container for nested types declared in the AutocompletePlacesResponse message type.

AutocompletePlacesResponse.Types.Suggestion

An Autocomplete suggestion result.

AutocompletePlacesResponse.Types.Suggestion.Types

Container for nested types declared in the Suggestion message type.

AutocompletePlacesResponse.Types.Suggestion.Types.FormattableText

Text representing a Place or query prediction. The text may be used as is or formatted.

AutocompletePlacesResponse.Types.Suggestion.Types.PlacePrediction

Prediction results for a Place Autocomplete prediction.

AutocompletePlacesResponse.Types.Suggestion.Types.QueryPrediction

Prediction results for a Query Autocomplete prediction.

AutocompletePlacesResponse.Types.Suggestion.Types.StringRange

Identifies a substring within a given text.

AutocompletePlacesResponse.Types.Suggestion.Types.StructuredFormat

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

Circle with a LatLng as center and radius.

ContentBlock

A block of content that can be served individually.

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.

ContextualContent.Types

Container for nested types declared in the ContextualContent message type.

ContextualContent.Types.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.

ContextualContent.Types.Justification.Types

Container for nested types declared in the Justification message type.

ContextualContent.Types.Justification.Types.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.

ContextualContent.Types.Justification.Types.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.

ContextualContent.Types.Justification.Types.ReviewJustification.Types

Container for nested types declared in the ReviewJustification message type.

ContextualContent.Types.Justification.Types.ReviewJustification.Types.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.

ContextualContent.Types.Justification.Types.ReviewJustification.Types.HighlightedText.Types

Container for nested types declared in the HighlightedText message type.

ContextualContent.Types.Justification.Types.ReviewJustification.Types.HighlightedText.Types.HighlightedTextRange

The range of highlighted text.

EVChargeOptions

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.

EVChargeOptions.Types

Container for nested types declared in the EVChargeOptions message type.

EVChargeOptions.Types.ConnectorAggregation

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.

FuelOptions

The most recent information about fuel options in a gas station. This information is updated regularly.

FuelOptions.Types

Container for nested types declared in the FuelOptions message type.

FuelOptions.Types.FuelPrice

Fuel price information for a given type.

FuelOptions.Types.FuelPrice.Types

Container for nested types declared in the FuelPrice message type.

GetPhotoMediaRequest

Request for fetching a photo of a place using a photo resource name.

GetPlaceRequest

Request for fetching a Place based on its resource name, which is a string in the places/{place_id} format.

Photo

Information about a photo of a place.

PhotoMedia

A photo media from Places API.

PhotoMediaName

Resource name for the PhotoMedia resource.

PhotoName

Resource name for the Photo resource.

Place

All the information representing a Place.

Place.Types

Container for nested types declared in the Place message type.

Place.Types.AccessibilityOptions

Information about the accessibility options a place offers.

Place.Types.AddressComponent

The structured components that form the formatted address, if this information is available.

Place.Types.Attribution

Information about data providers of this place.

Place.Types.ContainingPlace

Info about the place in which this place is located.

Place.Types.EvChargeAmenitySummary

The summary of amenities near the EV charging station. This only applies to places with type electric_vehicle_charging_station. The overview field is guaranteed to be provided while the other fields are optional.

Place.Types.GenerativeSummary

AI-generated summary of the place.

Place.Types.NeighborhoodSummary

A summary of points of interest near the place.

Place.Types.OpeningHours

Information about business hour of the place.

Place.Types.OpeningHours.Types

Container for nested types declared in the OpeningHours message type.

Place.Types.OpeningHours.Types.Period

A period the place remains in open_now status.

Place.Types.OpeningHours.Types.Period.Types

Container for nested types declared in the Period message type.

Place.Types.OpeningHours.Types.Period.Types.Point

Status changing points.

Place.Types.OpeningHours.Types.SpecialDay

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.

Place.Types.ParkingOptions

Information about parking options for the place. A parking lot could support more than one option at the same time.

Place.Types.PaymentOptions

Payment options the place accepts.

Place.Types.PlusCode

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.

Place.Types.ReviewSummary

AI-generated summary of the place using user reviews.

Place.Types.SubDestination

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.

PlaceName

Resource name for the Place resource.

Places

Service definition for the Places API. Note: every request (except for Autocomplete requests) requires a field mask set outside of the request proto (all/*, is not assumed). The field mask can be set via the HTTP header X-Goog-FieldMask. See: https://developers.google.com/maps/documentation/places/web-service/choose-fields

Places.PlacesBase

Base class for server-side implementations of Places

Places.PlacesClient

Client for Places

PlacesClient

Places client wrapper, for convenient use.

PlacesClientBuilder

Builder class for PlacesClient to provide simple configuration of credentials, endpoint etc.

PlacesClientImpl

Places client wrapper implementation, for convenient use.

PlacesSettings

Settings for PlacesClient instances.

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.

PriceRange

The price range associated with a Place. end_price could be unset, which indicates a range without upper bound (e.g. "More than $100").

References

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.

Review

Information about a review of a place.

ReviewName

Resource name for the Review resource.

RouteModifiers

Encapsulates a set of optional conditions to satisfy when calculating the routes.

RoutingParameters

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.

RoutingSummary

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.

RoutingSummary.Types

Container for nested types declared in the RoutingSummary message type.

RoutingSummary.Types.Leg

A leg is a single portion of a journey from one location to another.

SearchNearbyRequest

Request proto for Search Nearby.

SearchNearbyRequest.Types

Container for nested types declared in the SearchNearbyRequest message type.

SearchNearbyRequest.Types.LocationRestriction

The region to search.

SearchNearbyResponse

Response proto for Search Nearby.

SearchTextRequest

Request proto for SearchText.

SearchTextRequest.Types

Container for nested types declared in the SearchTextRequest message type.

SearchTextRequest.Types.EVOptions

Searchable EV options of a place search request.

SearchTextRequest.Types.LocationBias

The region to search. This location serves as a bias which means results around given location might be returned.

SearchTextRequest.Types.LocationRestriction

The region to search. This location serves as a restriction which means results outside given location will not be returned.

SearchTextRequest.Types.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.

SearchTextResponse

Response proto for SearchText.

Enums

AddressDescriptor.Types.Area.Types.Containment

Defines the spatial relationship between the target location and the area.

AddressDescriptor.Types.Landmark.Types.SpatialRelationship

Defines the spatial relationship between the target location and the landmark.

AutocompletePlacesRequest.Types.LocationBias.TypeOneofCase

Enum of possible cases for the "type" oneof.

AutocompletePlacesRequest.Types.LocationRestriction.TypeOneofCase

Enum of possible cases for the "type" oneof.

AutocompletePlacesResponse.Types.Suggestion.KindOneofCase

Enum of possible cases for the "kind" oneof.

ContextualContent.Types.Justification.JustificationOneofCase

Enum of possible cases for the "justification" oneof.

EVConnectorType

See http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107 for additional information/context on EV charging connector types.

FuelOptions.Types.FuelPrice.Types.FuelType

Types of fuel.

PhotoMediaName.ResourceNameType

The possible contents of PhotoMediaName.

PhotoName.ResourceNameType

The possible contents of PhotoName.

Place.Types.BusinessStatus

Business status for the place.

Place.Types.OpeningHours.Types.SecondaryHoursType

A type used to identify the type of secondary hours.

PlaceName.ResourceNameType

The possible contents of PlaceName.

Polyline.PolylineTypeOneofCase

Enum of possible cases for the "polyline_type" oneof.

PriceLevel

Price level of the place.

ReviewName.ResourceNameType

The possible contents of ReviewName.

RoutingPreference

A set of values that specify factors to take into consideration when calculating the route.

SearchNearbyRequest.Types.LocationRestriction.TypeOneofCase

Enum of possible cases for the "type" oneof.

SearchNearbyRequest.Types.RankPreference

How results will be ranked in the response.

SearchTextRequest.Types.LocationBias.TypeOneofCase

Enum of possible cases for the "type" oneof.

SearchTextRequest.Types.LocationRestriction.TypeOneofCase

Enum of possible cases for the "type" oneof.

SearchTextRequest.Types.RankPreference

How results will be ranked in the response.

TravelMode

Travel mode options. These options map to what Routes API offers.

In this article
Back to top Generated by DocFX