Go client library for Google Maps API Web Services
Go
Switch branches/tags
Nothing to show
Clone or download
domesticmouse Merge pull request #154 from Savolro/textsearch-fix
added checking of Type parameter in TextSearch
Latest commit d794ab8 Aug 10, 2018
Permalink
Failed to load latest commit information.
examples Added PlusCode struct to GeoCodingResponse Aug 1, 2018
internal Correct erroneous time.Time values returned by the library. Feb 4, 2016
.gitignore Direction tests now work as advertised Jun 19, 2015
.travis.yml FIX: optimze waypoint issue Jun 30, 2018
AUTHORS oss files Feb 25, 2015
CONTRIB.md oss files Feb 25, 2015
CONTRIBUTORS added adr microformat to PlaceDetailsResult Feb 15, 2017
LICENSE oss files Feb 25, 2015
README.md Increase default QPS from 10 to 50 Jan 9, 2018
client.go Wrapping documentation May 15, 2018
client_test.go Fix Error as Bool Jul 5, 2017
directions.go FIX: optimze waypoint issue Jun 30, 2018
directions_test.go FIX: optimze waypoint issue Jun 30, 2018
distancematrix.go go fmt May 15, 2018
distancematrix_test.go [client_options]: added WithBaseURL method; cases of baseURL using in… Sep 26, 2017
doc.go Renaming the package. Nov 19, 2015
elevation.go Wrapping documentation May 15, 2018
elevation_test.go [client_options]: added WithBaseURL method; cases of baseURL using in… Sep 26, 2017
encoding.go add duration_in_traffic in distancematrix response May 3, 2016
encoding_test.go Dropping import comments. Jul 23, 2015
geocoding.go Added PlusCode struct to GeoCodingResponse Aug 1, 2018
geocoding_test.go Add partial_math field to GeocodingResponse Jul 31, 2018
geolocation.go Wrapping documentation May 15, 2018
geolocation_test.go Cleanups and fixing test. Apr 9, 2018
latlng.go Delete the unused "fmt" import Mar 23, 2017
latlng_test.go Tests for StaticMap, LatLng. Clean up markdown warnings in README.md. ( Aug 11, 2017
places.go added checking of Type parameter in TextSearch Aug 10, 2018
places_test.go updated expected error message in TestTextSearchMissingQuery Aug 10, 2018
polyline.go Propagating polyline decoding error May 15, 2018
polyline_test.go Propagating polyline decoding error May 15, 2018
roads.go Wrapping documentation May 15, 2018
roads_test.go Add Nearest Roads API Jan 2, 2018
staticmap.go Wrapping documentation May 15, 2018
staticmap_test.go Cleanups and fixing test. Apr 9, 2018
timezone.go Wrapping documentation May 15, 2018
timezone_test.go Remove pretty dep from tests Dec 13, 2017
transport.go Wrapping documentation May 15, 2018
transport_test.go Move transport code to transport.go, remove useless comments. Aug 5, 2015
types.go Adding test coverage Jun 22, 2018

README.md

Go Client for Google Maps Services

Build Status GoDoc

Description

Use Go? Want to geocode something? Looking for directions? Maybe matrices of directions? This library brings the Google Maps API Web Services to your Go application. Analytics

The Go Client for Google Maps Services is a Go 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.

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 and protected 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.

Requirements

  • Go 1.5 or later.
  • A Google Maps API key.

API keys

Each Google Maps Web Service request requires an API key or client ID. API keys are freely available with a Google Account at Google APIs Console. The type of API key you need is a Server key.

To get an API key:

  1. Visit Google APIs Console and log in with a Google Account.
  2. Select one of your existing projects, or create a new project.
  3. Enable the API(s) you want to use. The Go Client for Google Maps Services accesses the following APIs:
    • Directions API
    • Distance Matrix API
    • Elevation API
    • Geocoding API
    • Places API
    • Roads API
    • Time Zone API
  4. Create a new Server key.
  5. If you'd like to restrict requests to a specific IP address, do so now.

For guided help, follow the instructions for the Directions API. You only need one API key, but remember to enable all the APIs you need. For even more information, see the guide to API keys.

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

Developer Documentation

View the reference documentation

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

Usage

Sample usage of the Directions API with an API key:

package main

import (
	"log"

	"github.com/kr/pretty"
	"golang.org/x/net/context"
	"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)
}

Below is the same example, using client ID and client secret (digital signature) for authentication. This code assumes you have previously loaded the clientID and clientSecret variables with appropriate values.

For a guide on how to generate the clientSecret (digital signature), see the documentation for the API you're using. For example, see the guide for the Directions API.

package main

import (
	"log"

	"github.com/kr/pretty"
	"golang.org/x/net/context"
	"googlemaps.github.io/maps"
)

func main() {
	c, err := maps.NewClient(maps.WithClientIDAndSignature("Client ID", "Client Secret"))
	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)).

Client IDs

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

Native types

Native objects for each of the API responses.