Package google.maps.locationselection.v1beta

Index

LocationSelectionBeta

The service for getting nearby places and associated pickup and drop off points.

FindNearbyPlaces

rpc FindNearbyPlaces(FindNearbyPlacesRequest) returns (FindNearbyPlacesResponse)

Find nearby places for a given location.
FindPickupPointsForLocation

rpc FindPickupPointsForLocation(FindPickupPointsForLocationRequest) returns (FindPickupPointsForLocationResponse)

Find pickup points for a given location.
FindPickupPointsForPlace

rpc FindPickupPointsForPlace(FindPickupPointsForPlaceRequest) returns (FindPickupPointsForPlaceResponse)

Find pickup points for a given place.

Address

Address of a place.

Fields
formatted_address

FormattedAddress

A full, human-readable address for this place.
address_components[]

AddressComponent

A list of address components.

AddressComponent

An address component that describes one part of the address.

Fields
component_text

string

The name of this component describing part of the address. Examples include "California", "Amphitheatre Parkway".
component_text_short_form

string

The short form of the component text. Examples include "CA" for "California", and "US" for "United States".
types[]

string

The types of this component describing part of the address. For a list of supported types, see https://developers.google.com/places/web-service/supported_types#table2

Compound

Compound associated with a place.

Fields
type

CompoundType

Type of compound.
geometry

Geometry

The geometry associated with the compound.
entrances[]

Entrance

List of entrances associated with the compound.

CompoundTypeEnums

The types of compounds

CompoundType

Value of the compound type.

Enums
COMPOUND_TYPE_UNSPECIFIED Compound Type unknown.
SECTION Compound section. https://support.google.com/mapskb/answer/7054299
BUILDING Compound building. https://support.google.com/mapskb/answer/7013011
GROUNDS Compound grounds. https://support.google.com/mapskb/answer/7046859

Entrance

Entrance of a place.

Fields
location

LatLng

The location of the entrance.

FindNearbyPlacesRequest

Find nearby places request message.

Fields
localization_preferences

LocalizationPreferences

Required. Preferences used for localizing the texts in response, for example, name and address.
search_location

LatLng

Required. Location where places need to be found.
max_results

int32

Required. Maximum number of results to be returned. Must be greater than 0.
wifi_access_points[]

WiFiAccessPoint

WiFi Access points around the request location. Used to provide higher quality search results.

FindNearbyPlacesResponse

Find nearby places for a given location response message.

Fields
place_results[]

PlaceResult

Ordered list of places found. May be empty if no places were found around the request location. Ordering is based on a combination of likelihood and distance.

FindPickupPointsForLocationRequest

FindPickupPointsForLocation request message.

Fields
localization_preferences

LocalizationPreferences

Required. Preferences used for localizing the texts in response, for example, name and address.
search_location

LatLng

Required. Location to use for searching pickup points and calculating distances and ETAs to pickup points.
order_by

PickupPointOrder

Required. Ordering to use when returning results.
destination

LatLng

Customer's intended destination location. Set when requesting pickup points sorted by destination ETA.
max_results

int32

Required. Maximum number of results to be returned. Must be greater than 0.
travel_modes[]

TravelMode

Required. Only pickup points that allow at least one of the specified travel mode are returned. Supported travel modes: DRIVING and TWO_WHEELER. At least one mode must be specified.
compute_walking_eta

bool

If true, the walking ETA from the search location to the pickup point is computed.
compute_driving_eta

bool

If true and destination is specified, the driving ETA from the pickup point to the destination is computed.
wifi_access_points[]

WiFiAccessPoint

WiFi Access points around the search location. Used to provide higher quality search results.

FindPickupPointsForLocationResponse

Find pickup points for location response message.

Fields
place_pickup_point_results[]

PlacePickupPointResult

Nearby pickup points with associated place id. Results in this list are ordered as per criteria given in the request. Number of results in 'place_pickup_point_results' may exceed number of results in 'place_results'.
place_results[]

PlaceResult

Details about the places associated with nearby pickup points. Results in this list are not ordered.

FindPickupPointsForPlaceRequest

FindPickupPointsForPlace request message.

Fields
place_id

string

Required. Place ID of the place for which pick-up points are requested.
localization_preferences

LocalizationPreferences

Required. Preferences used for localizing the texts in response, for example, name and address.
search_location

LatLng

Location to use for searching pickup points and calculating distances and ETAs to pickup points. If not set, the location of the place associated with the given place id is used.
order_by

PickupPointOrder

Required. Ordering to use when returning results.
destination

LatLng

Customer's intended destination location. Set if requesting pickup points to be ordered by destination ETA.
max_results

int32

Required. Maximum number of results to be returned. Must be greater than 0.
travel_modes[]

TravelMode

Required. Only pickup points that allow at least one of the specified travel mode are returned. Supported travel modes: DRIVING and TWO_WHEELER. At least one mode must be specified.
compute_walking_eta

bool

If true, the walking ETA from the search location to the pickup point is computed.
compute_driving_eta

bool

If true and destination is specified, the driving ETA from the pickup point to the destination is computed.

FindPickupPointsForPlaceResponse

Find pickup points for place response message.

Fields
pickup_point_results[]

PickupPointResult

Pick-up points that match the request criteria. May be empty if no pickup points match the request criteria.
place_result

PlaceResult

Place associated with given place id in request.

FormattedAddress

A full, human-readable address for the entity containing this message.

Fields
lines[]

string

The lines of text that describe the address. At least one line must be present.

Geometry

Geometry of a place.

Fields
location

LatLng

Central point of the entity containing this message.
viewport

Viewport

A viewport suitable for displaying the place on an average-sized map.
display_boundary

Struct

Specifies a polygon using the using the GeoJSON Polygon format

LocalizationPreferences

A full, human-readable address for the entity containing this message.

Fields
language_code

string

Required. The BCP-47 language tag used for localizing the texts. Examples of language tag include, "en-US", "hi-IN", "fr-CA", etc.
region_code

string

Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419".

For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.

PickupPoint

Details about a pickup or dropoff point.

Fields
id

string

A unique ID for the pickup point. Must be present.
display_name

string

Short, human-readable name of the pickup point. Localized as per preference provided in request.
address

Address

Address of the pickup point.
description

string

A longer description of the pickup point, which may include how to get to the location.
location

LatLng

Location of the pickup point; where a rider or receiver meets the driver. Must be present.

PickupPointOrderEnums

Set of values that specify the sorting order of matching pickup points.

PickupPointOrder

Value of the pickup point order.

Enums
PICKUP_POINT_ORDER_UNSPECIFIED Pickup point order unspecified. Default to DISTANCE_FROM_ORIGIN.
DISTANCE_FROM_SEARCH_LOCATION Ascending order of straight-line distance from the search location to the returned pickup point.
WALKING_ETA_FROM_SEARCH_LOCATION Ascending order by the consumer's walking time from the search location to the pickup point.
DRIVING_ETA_FROM_PICKUP_POINT_TO_DESTINATION Ascending order by driving ETA from pickup point to the consumer's destination. This mode can only be used when a destination is set and compute_driving_eta is true. When multiple travel_modes are give in request, the ordering is based on the first travel_mode in the request.

PickupPointResult

Details about a pickup point search result.

Fields
pickup_point

PickupPoint

The actual pickup point that matches the request.
distance_meters

float

The straight-line distance from this pickup point to the search_location specified in the request.
travel_details[]

TravelDetail

The details associated with travel to and from this pickup point for each requested travel mode.

Place

Details about a place.

Fields
place_id

string

Place ID of the place. A place ID is text that uniquely identifies a place. https://developers.google.com/places/web-service/place-id
display_name

string

Name of the place localized. Localized as per preference provided in request.
language_code

string

Language code of the text fields associated with the place. For example, "name" and "address".
address

Address

Address of the place.
geometry

Geometry

Geometry of the place.
types[]

string

A set of type tags for this result. For example, "political" and "locality". https://developers.google.com/places/web-service/supported_types
associated_compounds[]

Compound

The compounds associated with the place.

PlacePickupPointResult

Pickup points with associated place ID.

Fields
pickup_point_result

PickupPointResult

Details about the pickup point. Must be present.
associated_place_id

string

Place ID of the associated place.

PlaceResult

Details about a place search result.

Fields
place

Place

Details about a place.
distance_meters

float

The straight-line distance from the search location to the place geometry or center.

TrafficRestrictionEnums

Traffic restriction types for a location.

TrafficRestriction

Value of the traffic restriction.

Enums
TRAFFIC_RESTRICTION_UNSPECIFIED The restriction is not unspecified.
NO_RESTRICTION No traffic restrictions are applied.
OTHER_RESTRICTION Some traffic restrictions may apply, such as the road is private or there is a fee to access associated location.

TravelDetail

The details associated with the travel.

Fields
travel_mode

TravelMode

The travel mode under which the ETA is computed.
estimated_arrival_time

Timestamp

The estimated time of arrival. Walking ETA is calculated from search location to pickup point location when compute_walking_eta is set in the request. Driving ETA is calculated from pickup point location to the destination for each non-pedestrian requested travel mode when compute_driving_eta and destination is set in the request. Driving ETA is calculated with traffic, and is NOT subject to congestion restrictions.
traffic_restriction

TrafficRestriction

The restriction that applies to the travel mode.

TravelModeEnums

The list of travel modes available for travel to a location.

TravelMode

Value of the travel mode.

Enums
TRAVEL_MODE_UNSPECIFIED The travel mode is not specified.
WALKING Walking, used for pedestrians.
DRIVING Driving, used for passenger cars.
TWO_WHEELER Motored two-wheeler (such as a motorcycle or moped).

WiFiAccessPoint

WiFi access point information.

Fields
mac_address

int64

The MAC address of the access point.
strength_dbm

sint32

The signal strength of the access point, in dBm.