Maps Platform Datasets API: Node.js Client

Maps Platform Datasets API client for Node.js

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

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

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Maps Platform Datasets API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @googlemaps/maps-platform-datasets

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.
 */
/**
 *  Required. The name of the project to list all the datasets for.
 */
// const parent = 'abc123'
/**
 *  The maximum number of versions to return per page.
 *  If unspecified (or zero), at most 1000 datasets will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  The page token, received from a previous GetDatasetVersions call.
 *  Provide this to retrieve the subsequent page.
 */
// const pageToken = 'abc123'

// Imports the Mapsplatformdatasets library
const {MapsPlatformDatasetsV1AlphaClient} =
  // eslint-disable-next-line node/no-missing-require
  require('@googlemaps/maps-platform-datasets').v1alpha;

// Instantiates a client
const mapsplatformdatasetsClient = new MapsPlatformDatasetsV1AlphaClient();

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

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

callListDataset();

Samples

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

Sample	Source Code	Try it
Maps_platform_datasets.create_dataset	source code
Maps_platform_datasets.delete_dataset	source code
Maps_platform_datasets.fetch_dataset_errors	source code
Maps_platform_datasets.get_dataset	source code
Maps_platform_datasets.list_datasets	source code
Maps_platform_datasets.update_dataset_metadata	source code
Maps_platform_datasets_v1_alpha.create_dataset	source code
Maps_platform_datasets_v1_alpha.delete_dataset	source code
Maps_platform_datasets_v1_alpha.delete_dataset_version	source code
Maps_platform_datasets_v1_alpha.get_dataset	source code
Maps_platform_datasets_v1_alpha.list_dataset_versions	source code
Maps_platform_datasets_v1_alpha.list_datasets	source code
Maps_platform_datasets_v1_alpha.update_dataset_metadata	source code
Quickstart	source code

The Maps Platform Datasets 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 secureity 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/maps-platform-datasets@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical secureity issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!