Method: GoogleMapsService::Apis::Roads#nearest_roads

Defined in:
lib/google_maps_service/apis/roads.rb

#nearest_roads(points) ⇒ Array

Returns the nearest road segments for provided points. The points passed do not need to be part of a continuous path.

Examples:

Single point snap

results = client.nearest_roads([40.714728, -73.998672])

Multi points snap

points = [
    [-33.8671, 151.20714],
    [-33.86708, 151.20683000000002],
    [-33.867070000000005, 151.20674000000002],
    [-33.86703, 151.20625]
]
results = client.nearest_roads(points)

Parameters:

  • points (Array) —

    The points to be used for nearest road segment lookup. Array of latitude/longitude pairs which do not need to be a part of continuous part. Takes up to 100 independent coordinates, and returns the closest road segment for each point.

Returns:

  • (Array) —

    Array of snapped points.

[View source]

128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google_maps_service/apis/roads.rb', line 128

def nearest_roads(points)
  points = GoogleMapsService::Convert.waypoints(points)

  params = {
    points: points
  }

  return get('/v1/nearestRoads', params,
             base_url: ROADS_BASE_URL,
             accepts_client_id: false,
             custom_response_decoder: method(:extract_roads_body))[:snappedPoints]
end