Class v2.RoutesClient (0.3.1)

Stay organized with collections Save and categorize content based on your preferences.

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Array of origins, which determines the rows of the response
   *  matrix. Several size restrictions apply to the cardinality of origins and
   *  destinations:
   *  * The number of elements (origins × destinations) must be no greater than
   *  625 in any case.
   *  * The number of elements (origins × destinations) must be no greater than
   *  100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
   *  * The number of waypoints (origins + destinations) specified as `place_id`
   *  must be no greater than 50.
   */
  // const origins = 1234
  /**
   *  Required. Array of destinations, which determines the columns of the
   *  response matrix.
   */
  // const destinations = 1234
  /**
   *  Optional. Specifies the mode of transportation.
   */
  // const travelMode = {}
  /**
   *  Optional. Specifies how to compute the route. The server attempts to use
   *  the selected routing preference to compute the route. If the routing
   *  preference results in an error or an extra long latency, an error is
   *  returned. You can specify this option only when the `travel_mode` is
   *  `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
   */
  // const routingPreference = {}
  /**
   *  Optional. The departure time. If you don't set this value, this defaults to
   *  the time that you made the request. If you set this value to a time that
   *  has already occurred, the request fails.
   */
  // const departureTime = {}
  /**
   *  Optional. A list of extra computations which may be used to complete the
   *  request. Note: These extra computations may return extra fields on the
   *  response. These extra fields must also be specified in the field mask to be
   *  returned in the response.
   */
  // const extraComputations = 1234

  // Imports the Routing library
  const {RoutesClient} = require('@googlemaps/routing').v2;

  // Instantiates a client
  const routingClient = new RoutesClient();

  async function callComputeRouteMatrix() {
    // Construct request
    const request = {
      origins,
      destinations,
    };

    // Run request
    const stream = await routingClient.computeRouteMatrix(request);
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
  }

  callComputeRouteMatrix();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Origin waypoint.
   */
  // const origin = {}
  /**
   *  Required. Destination waypoint.
   */
  // const destination = {}
  /**
   *  Optional. A set of waypoints along the route (excluding terminal points),
   *  for either stopping at or passing by. Up to 25 intermediate waypoints are
   *  supported.
   */
  // const intermediates = 1234
  /**
   *  Optional. Specifies the mode of transportation.
   */
  // const travelMode = {}
  /**
   *  Optional. Specifies how to compute the route. The server
   *  attempts to use the selected routing preference to compute the route. If
   *   the routing preference results in an error or an extra long latency, then
   *  an error is returned. You can specify this option only when the
   *  `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
   */
  // const routingPreference = {}
  /**
   *  Optional. Specifies your preference for the quality of the polyline.
   */
  // const polylineQuality = {}
  /**
   *  Optional. Specifies the preferred encoding for the polyline.
   */
  // const polylineEncoding = {}
  /**
   *  Optional. The departure time. If you don't set this value, then this value
   *  defaults to the time that you made the request. If you set this value to a
   *  time that has already occurred, then the request fails.
   */
  // const departureTime = {}
  /**
   *  Optional. Specifies whether to calculate alternate routes in addition to
   *  the route.
   */
  // const computeAlternativeRoutes = true
  /**
   *  Optional. A set of conditions to satisfy that affect the way routes are
   *  calculated.
   */
  // const routeModifiers = {}
  /**
   *  Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
   *  information, see
   *  http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See
   *  Language Support (https://developers.google.com/maps/faq#languagesupport)
   *  for the list of supported languages. When you don't provide this value, the
   *  display language is inferred from the location of the route request.
   */
  // const languageCode = 'abc123'
  /**
   *  Optional. Specifies the units of measure for the display fields. This
   *  includes the `instruction` field in `NavigationInstruction`. The units of
   *  measure used for the route, leg, step distance, and duration are not
   *  affected by this value. If you don't provide this value, then the display
   *  units are inferred from the location of the request.
   */
  // const units = {}
  /**
   *  Optional. Specifies what reference routes to calculate as part of the
   *  request in addition to the default route. A reference route is a route with
   *  a different route calculation objective than the default route. For example
   *  an FUEL_EFFICIENT reference route calculation takes into account various
   *  parameters that would generate an optimal fuel efficient route.
   */
  // const requestedReferenceRoutes = 1234
  /**
   *  Optional. A list of extra computations which may be used to complete the
   *  request. Note: These extra computations may return extra fields on the
   *  response. These extra fields must also be specified in the field mask to be
   *  returned in the response.
   */
  // const extraComputations = 1234

  // Imports the Routing library
  const {RoutesClient} = require('@googlemaps/routing').v2;

  // Instantiates a client
  const routingClient = new RoutesClient();

  async function callComputeRoutes() {
    // Construct request
    const request = {
      origin,
      destination,
    };

    // Run request
    const response = await routingClient.computeRoutes(request);
    console.log(response);
  }

  callComputeRoutes();