Go Client for Google Maps Services
![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
Description
Use Go? This library brings many Google Maps Platform Web Services APIs to your Go application.
The Go Client for Google Maps Services is a Go Client library for the following Google Maps Platform
APIs:
[!TIP]
See the Google Maps Platform Cloud Client Library for Go for our newer APIs
including Address Validation API, Datasets API, Fleet Engine, new Places API, and Routes API.
Requirements
- Go 1.7 or later.
- A Google Maps Platform API key from a project with the APIs below enabled.
[!IMPORTANT]
This key should be kept secret on your server.
Installation
To install the Go Client for Google Maps Services, please execute the following go get
command.
go get googlemaps.github.io/maps
Documentation
View the reference documentation.
Additional documentation about the APIs is available at:
Usage
Sample usage of the Directions API with an API key:
package main
import (
"context"
"log"
"github.com/kr/pretty"
"googlemaps.github.io/maps"
)
func main() {
c, err := maps.NewClient(maps.WithAPIKey("Insert-API-Key-Here"))
if err != nil {
log.Fatalf("fatal error: %s", err)
}
r := &maps.DirectionsRequest{
Origin: "Sydney",
Destination: "Perth",
}
route, _, err := c.Directions(context.Background(), r)
if err != nil {
log.Fatalf("fatal error: %s", err)
}
pretty.Println(route)
}
Features
Rate limiting
Never sleep between requests again! By default, requests are sent at the expected rate limits for
each web service, typically 50 queries per second for free users. If you want to speed up or slow
down requests, you can do that too, using maps.NewClient(maps.WithAPIKey(apiKey), maps.WithRateLimit(qps))
.
Native types
Native objects for each of the API responses.
Monitoring
It's possible to get metrics for status counts and latency histograms for monitoring.
Use maps.WithMetricReporter(metrics.OpenCensusReporter{})
to log metrics to OpenCensus,
and metrics.RegisterViews()
to make the metrics available to be exported.
OpenCensus can export these metrics to a variety of monitoring services.
You can also implement your own metric reporter instead of using the provided one.
Terms of Service
This library uses Google Maps Platform services, and any use of Google Maps Platform is subject to the Terms of Service.
For clarity, this library, and each underlying component, is not a Google Maps Platform Core Service.
Support
This library is offered via an open source license. It is not governed by the Google Maps Platform Support Technical Support Services Guidelines, the SLA, or the Deprecation Policy (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
This library adheres to semantic versioning to indicate when backwards-incompatible changes are introduced.
If you find a bug, or have a feature request, please file an issue on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our developer community channels. If you'd like to contribute, please check the Contributing guide.
You can also discuss this library on our Discord server.