Method: findPickupPointsForPlace

Deprecated: Use Location Selection v1.findPickupPointsForPlace instead.

HTTP request

POST https://fleetengine.googleapis.com/v1:findPickupPointsForPlace

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "header": {
    object (RequestHeader)
  },
  "tripId": string,
  "placeId": string,
  "searchLocation": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "orderBy": enum (PickupPointOrder),
  "count": integer,
  "travelModes": [
    enum (TerminalPointTravelMode)
  ],
  "computeWalkingEta": boolean,
  "computeDrivingEta": boolean
}
Fields
header

object (RequestHeader)

Required. The standard Fleet Engine request header.
tripId

string

Trip ID used in other Local Rides and Deliveries APIs.
placeId

string

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

object (LatLng)

Required. Location to use for calculating distances for matching pick-up points.
destination

object (LatLng)

Customer's intended destination location. Required when requesting pickup points sorted by destination ETA.
orderBy

enum (PickupPointOrder)

Required. Ordering to use when returning results.
count

integer (uint32 format)

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

enum (TerminalPointTravelMode)

Required. Only terminal points that allow the specified travel mode are returned. At least one mode must be present.
computeWalkingEta

boolean

If true, the walkingEtaFromOrigin in PickupPointResponse is computed. Must be set to true when requesting pickup points sorted by walking ETA.
computeDrivingEta

boolean

If true, and if the destination is specified, then the PickupPointResponse.driving_eta_matches (from pickup point to destination) are computed. Must be set to true when requesting pickup points sorted by destination ETA.

Response body

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

Deprecated:

JSON representation 
{
  "pickupPointResponses": [
    {
      object (PickupPointResponse)
    }
  ]
}
Fields
pickupPointResponses[]

object (PickupPointResponse)

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

PickupPointOrder

A set of values that specify the sorting order of matching pickup points.

Enums
PICKUP_POINT_ORDER_UNSPECIFIED Pickup point order unspecified. Default to DISTANCE_FROM_ORIGIN.
DISTANCE_FROM_ORIGIN Ascending order of straight-line distance from the origin to the returned pickup point.
WALKING_ETA_FROM_ORIGIN Ascending order by the consumer's walking time from origin to 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 computeDrivingEta is true. When multiple travelModes are specified in the request, the ordering is based on the first travelMode in the request.

PickupPointResponse

Deprecated:

JSON representation 
{
  "pickupPoint": {
    object (TerminalPoint)
  },
  "distanceMeters": number,
  "walkingEtaFromOrigin": string,
  "drivingEtaMatches": [
    {
      object (DrivingEtaMatch)
    }
  ],
  "travelModes": [
    enum (TerminalPointTravelMode)
  ],
  "travelModeDetails": [
    {
      object (TravelModeDetails)
    }
  ]
}
Fields
pickupPoint

object (TerminalPoint)

The actual pickup point that matches the request. The pickup point type is PICKUP_WAYPOINT_TYPE.
distanceMeters

number

The straight-line distance from this point to the searchLocation specified in the request.
walkingEtaFromOrigin

string (Timestamp format)

The consumer's walking ETA from request location to this pickup point. This field is set when requesting computeWalkingEta in the request. May be empty if walking ETA was not requested.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
drivingEtaMatches[]

object (DrivingEtaMatch)

The driving ETA from the pickup point to the destination with the given travel mode with traffic, and NOT subject to congestion restrictions. Only present if computeDrivingEta is enabled, and a destination is specified in the request. May be empty if driving ETA was not requested.
travelModes[]
(deprecated)

enum (TerminalPointTravelMode)

The travel modes that this pickup point supports.
travelModeDetails[]

object (TravelModeDetails)

The travel modes that this pickup point supports along with details. Generally, this should not be empty and typically will have one or two entries.