distancematrix

README

distancematrix

Google distancematrix API.

API Documentation

Documentation

Overview

Package distancematrix computes a distance matrix between points using Google's API.

Index

• Constants
• type OptionalAvoidParam
• type OptionalDepartureTimeParam
• type OptionalKeyParam
• type OptionalLanguageParam
• type OptionalModeParam
• type OptionalUnitsParam
• type RequiredParams
• type Response
  • func DistanceMatrix(requiredParams *RequiredParams, optionalParams ...interface{}) (matrix *Response, err error)

Constants

const (
	// APIURL is the URL to the API call.
	APIURL = "https://maps.googleapis.com/maps/api/distancematrix/json"
)

Types

type OptionalAvoidParam

type OptionalAvoidParam struct {
	Avoid string `url:"avoid"`
}

OptionalAvoidParam optional param.

type OptionalDepartureTimeParam

type OptionalDepartureTimeParam struct {
	DepartureTime string `url:"departure_time"`
}

OptionalDepartureTimeParam optional param.

type OptionalKeyParam

type OptionalKeyParam struct {
	APIKey string `url:"key"`
}

OptionalKeyParam optional param.

type OptionalLanguageParam

type OptionalLanguageParam struct {
	Language string `url:"language"`
}

OptionalLanguageParam optional param.

type OptionalModeParam

type OptionalModeParam struct {
	Mode string `url:"mode"`
}

OptionalModeParam optional param.

type OptionalUnitsParam

type OptionalUnitsParam struct {
	Units string `url:"units"`
}

OptionalUnitsParam optional param.

type RequiredParams

type RequiredParams struct {
	Origins      maps.Locations `url:"origins"`
	Destinations maps.Locations `url:"destinations"`
}

RequiredParams represents params that must be given in a request.

type Response

type Response struct {
	OriginAddresses      []string `json:"origin_addresses"`
	DestinationAddresses []string `json:"destination_addresses"`
	Status               string   `json:"status"`
	Rows                 []struct {
		Elements []struct {
			Status   string `json:"status"`
			Duration struct {
				Value int    `json:"value"`
				Text  string `json:"text"`
			} `json:"duration"`
			Distance struct {
				Value int    `json:"value"`
				Text  string `json:"text"`
			} `json:"distance"`
		} `json:"elements"`
	} `json:"rows"`
}

Response object returned from API call.

func DistanceMatrix

func DistanceMatrix(requiredParams *RequiredParams, optionalParams ...interface{}) (matrix *Response, err error)

DistanceMatrix computes the distance matrix using Google's API.