@googlemaps/fleetengine-delivery

Last Mile Fleet Solution Delivery API: Node.js Client

Last Mile Fleet Solution Delivery API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Last Mile Fleet Solution Delivery API Node.js Client API Reference
• Last Mile Fleet Solution Delivery API Documentation
• github.com/googleapis/google-cloud-node/packages/google-maps-fleetengine-delivery

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Last Mile Fleet Solution Delivery API API.
4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @googlemaps/fleetengine-delivery

Using the client library

/**
 * 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.
 */
/**
 *  Optional. The standard Delivery API request header.
 */
// const header = {}
/**
 *  Required. Must be in the format `providers/{provider}`.
 *  The `provider` must be the Google Cloud Project ID.
 *  For example, `sample-cloud-project`.
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of vehicles to return. The service may return
 *  fewer than this number. If you don't specify this number, then the server
 *  determines the number of results to return.
 */
// const pageSize = 1234
/**
 *  Optional. A page token, received from a previous `ListDeliveryVehicles`
 *  call. You must provide this in order to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListDeliveryVehicles`
 *  must match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. A filter query to apply when listing delivery vehicles. See
 *  http://aip.dev/160 for examples of the filter syntax. If you don't specify
 *  a value, or if you specify an empty string for the filter, then all
 *  delivery vehicles are returned.
 *  Note that the only queries supported for `ListDeliveryVehicles` are
 *  on vehicle attributes (for example, `attributes.<key> = <value>` or
 *  `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
 *  attributes are stored as strings, so the only supported comparisons against
 *  attributes are string comparisons. In order to compare against number or
 *  boolean values, the values must be explicitly quoted to be treated as
 *  strings (for example, `attributes.<key> = "10"` or
 *  `attributes.<key> = "true"`).
 *  The maximum number of restrictions allowed in a filter query is 50. A
 *  restriction is a part of the query of the form
 *  `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
 *  is 1 restriction.
 */
// const filter = 'abc123'
/**
 *  Optional. A filter that limits the vehicles returned to those whose last
 *  known location was in the rectangular area defined by the viewport.
 */
// const viewport = {}

// Imports the Delivery library
const {DeliveryServiceClient} =
  require('@googlemaps/fleetengine-delivery').v1;

// Instantiates a client
const deliveryClient = new DeliveryServiceClient();

async function callListDeliveryVehicles() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = deliveryClient.listDeliveryVehiclesAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListDeliveryVehicles();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Delivery_service.batch_create_tasks	source code
Delivery_service.create_delivery_vehicle	source code
Delivery_service.create_task	source code
Delivery_service.get_delivery_vehicle	source code
Delivery_service.get_task	source code
Delivery_service.get_task_tracking_info	source code
Delivery_service.list_delivery_vehicles	source code
Delivery_service.list_tasks	source code
Delivery_service.search_tasks	source code
Delivery_service.update_delivery_vehicle	source code
Delivery_service.update_task	source code
Quickstart	source code

The Last Mile Fleet Solution Delivery API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @googlemaps/fleetengine-delivery@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE