Method: findPickupPointsForLocation

  • The Find Pickup Points For Location API allows you to retrieve pickup points for a given location using a POST request.

  • The request body requires specifying preferences, search location, ordering, destination (optional), maximum results, travel modes, and optionally, ETA calculation preferences and WiFi access points.

  • The response body provides a list of pickup points (placePickupPointResults) ordered as per the request criteria, and details about associated places (placeResults).

  • Each placePickupPointResult includes details about the pickup point itself and the associated place ID.

Find pickup points for a given location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

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

object (LocalizationPreferences)

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

object (LatLng)

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

enum (PickupPointOrder)

Required. Ordering to use when returning results.
destination

object (LatLng)

Customer's intended destination location. Set when requesting pickup points sorted 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.
wifiAccessPoints[]

object (WiFiAccessPoint)

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

Response body

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

Find pickup points for location response message.

JSON representation 
{
  "placePickupPointResults": [
    {
      object (PlacePickupPointResult)
    }
  ],
  "placeResults": [
    {
      object (PlaceResult)
    }
  ]
}
Fields
placePickupPointResults[]

object (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 'placePickupPointResults' may exceed number of results in 'placeResults'.
placeResults[]

object (PlaceResult)

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

PlacePickupPointResult

Pickup points with associated place ID.

JSON representation 
{
  "pickupPointResult": {
    object (PickupPointResult)
  },
  "associatedPlaceId": string
}
Fields
pickupPointResult

object (PickupPointResult)

Details about the pickup point. Must be present.
associatedPlaceId

string

Place ID of the associated place.