Method: findPickupPointsForPlace

Find pickup points for a given place.

HTTP request

POST https://locationselection.googleapis.com/v1beta:findPickupPointsForPlace

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "placeId": string,
  "localizationPreferences": {
    object (LocalizationPreferences)
  },
  "searchLocation": {
    object (LatLng)
  },
  "orderBy": enum (PickupPointOrder),
  "destination": {
    object (LatLng)
  },
  "maxResults": integer,
  "travelModes": [
    enum (TravelMode)
  ],
  "computeWalkingEta": boolean,
  "computeDrivingEta": boolean
}
Fields
placeId

string

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

localizationPreferences

object (LocalizationPreferences)

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

searchLocation

object (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.

orderBy

enum (PickupPointOrder)

Required. Ordering to use when returning results.

destination

object (LatLng)

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

maxResults

integer

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

travelModes[]

enum (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.

computeWalkingEta

boolean

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

computeDrivingEta

boolean

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

Response body

If successful, the response body contains data with the following structure:

Find pickup points for place response message.

JSON representation
{
  "pickupPointResults": [
    {
      object (PickupPointResult)
    }
  ],
  "placeResult": {
    object (PlaceResult)
  }
}
Fields
pickupPointResults[]

object (PickupPointResult)

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

placeResult

object (PlaceResult)

Place associated with given place id in request.