@google/maps

中文文档
1.1.3发布于 2020/04/30Apache-2.0CommonJS近 30 天下载 32.8万

Node.js client library for Google Maps API Web Services

此软件包已被标记为弃用

Please use @googlemaps/google-maps-services-js instead.

原始使用文档
文档目录9 节
  1. Attention!
  2. Features
  3. Quick Start
  4. API keys
  5. Client IDs
  6. Typescript
  7. Developing
  8. Support
  9. Command-line Interface

Node.js Client for Google Maps Services

Build Status npm codecov GitHub contributors

This library has been deprecated in favor of @googlemaps/google-maps-services-js. Bug fixes will continue, however all new feature development will be on the master branch and published to the new library.

Use Node.js? Want to geocode something? Looking for directions? This library brings the Google Maps API Web Services to your Node.js application. Analytics

The Node.js Client for Google Maps Services is a Node.js Client library for the following Google Maps APIs:

Keep in mind that the same terms and conditions apply to usage of the APIs when they're accessed through this library.

Attention!

This library is designed for server-side Node.js applications. Attempting to use it client-side, in either the browser or any other environment like React Native, may in some cases work, but mostly will not. Please refrain from reporting issues with these environments when attempting to use them, since server-side Node.js applications is the only supported environment for this library. For other environments, try the Maps JavaScript API, which contains a comparable feature set, and is explicitly intended for use with client-side JavaScript.

Features

  • Retry on Failure Automatically retry when intermittent failures occur. That is, when any of the retryable 5xx errors are returned from the API.

  • Rate-limiting Requests are rate-limited by the client, which helps prevent reaching the server-enforced rate limit.

Quick Start

$ npm install @google/maps

Note: You'll need to have npm 2.7.0 or greater installed, since this library is hosted as a scoped package.

Create a new client object by calling createClient()

const googleMapsClient = require('@google/maps').createClient({
  key: 'your API key here'
});

Make requests to the Google Maps APIs by calling methods on the client object.

// Geocode an address.
googleMapsClient.geocode({
  address: '1600 Amphitheatre Parkway, Mountain View, CA'
}, function(err, response) {
  if (!err) {
    console.log(response.json.results);
  }
});

You may use promise-based solution also.

const googleMapsClient = require('@google/maps').createClient({
  key: 'your API key here',
  Promise: Promise
});

googleMapsClient.geocode({address: '1600 Amphitheatre Parkway, Mountain View, CA'})
  .asPromise()
  .then((response) => {
    console.log(response.json.results);
  })
  .catch((err) => {
    console.log(err);
  });

For more usage examples, check out the tests.

View the reference documentation

Additional documentation for the included web services is available at https://developers.google.com/maps/.

API keys

Each Google Maps Web Service request requires an API key. To get an API key, follow the Get API Key instructions in our Maps JS API docs.

When you have an API key, you can create a client object:

var googleMapsClient = require('@google/maps').createClient({
  key: 'your API key here'
});

Client IDs

Google Maps APIs Premium Plan customers can use their client ID and secret to authenticate, instead of an API key.

var googleMapsClient = require('@google/maps').createClient({
  clientId: 'Add your client ID here',
  clientSecret: 'Add your client secret here',
});

Important: This key should be kept secret on your server.

Typescript

Community-built typings for this library are available in @types/google__maps (note the double underscore).

npm install @types/google__maps

Developing

In order to run the end-to-end tests, you'll need to supply your API key via an environment variable.

$ export GOOGLE_MAPS_API_KEY=AIza-your-api-key
$ npm test

Support

This library is community supported. We're comfortable enough with the stability and features of the library that we want you to build real production applications on it. We will try to support, through Stack Overflow, the public surface of the library and maintain backwards compatibility in the future; however, while the library is in version 0.x, we reserve the right to make backwards-incompatible changes. If we do remove some functionality (typically because better functionality exists or if the feature proved infeasible), our intention is to deprecate and give developers a year to update their code.

If you find a bug, or have a feature suggestion, please log an issue. If you'd like to contribute, please read How to Contribute.

Command-line Interface

Installing via npm also provides the googlemaps command-line utility, which can then be used to pipe JSON results to other command-line programs:

$ googlemaps directions --origin 'Sydney Town Hall' --destination 'Parramatta, NSW'

版本与发布记录

@google/maps 共发布 24 个版本,首次发布于 2016/08/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.3latest2020/04/306 年前
1.1.22020/04/306 年前
1.1.02020/01/226 年前
1.0.22019/10/227 年前
1.0.12019/09/217 年前
1.0.02019/09/137 年前

关于 @google/maps 的常见问题

@google/maps 是什么?

Node.js client library for Google Maps API Web Services注意:该包已被作者标记为弃用——Please use @googlemaps/google-maps-services-js instead.

如何安装 @google/maps?

在项目目录运行 npm install @google/maps,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 googlemaps,可以用 npx googlemaps 直接运行。

@google/maps 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/google__maps 是否存在。

@google/maps 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google/maps 可以商用吗?

@google/maps 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google/maps 的下载量有多少?

根据 npm 官方下载统计,@google/maps 在 2026/10/17 – 2026/11/15 这 30 天内被下载 327,877 次,日均约 10,929 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google/maps 还在维护吗?

最新版本 1.1.3 发布于 2020/04/30(6 年前);至今共发布 24 个版本,其中过去 12 个月发布了 0 个;首次发布于 2016/08/16。作者已将其标记为弃用,新项目建议寻找替代方案。