| Copyright | (c) Mike Pilgrem 2017 |
|---|---|
| Maintainer | public@pilgrem.com |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
Web.Google.Maps.Geocoding
Description
This package has no connection with Google Inc. or its affiliates.
The Google Maps Geocoding API provides a direct way to access geocoding and reverse geocoding services via an HTTP request. This library provides bindings in Haskell to that API.
NB: The use of the Google Maps Geocoding API services is subject to the Google Maps APIs Terms of Service, which terms restrict the use of content (eg no use without a Google map).
The components and optional parameters in a geocoding request are not yet
implemented. The reverse geocoding request is not yet implemented.
The code below is an example console application to test privately the use of the library with the Google Maps Geocoding API.
{-# LANGUAGE OverloadedStrings #-}
module Main (main) where
import Data.Maybe (fromJust)
import Data.Text (Text)
import Data.Text.IO as T (getLine, putStr)
import Graphics.Gloss (Display (..), display, white)
import Graphics.Gloss.Juicy (fromDynamicImage)
import Network.HTTP.Client (Manager, newManager)
import Network.HTTP.Client.TLS (tlsManagerSettings)
import Web.Google.Maps.Geocoding (Address (..), geocode, GeocodingResponse (..),
Geometry (..), Key (..), Location (..), Result (..), Status (..))
import Web.Google.Static.Maps (Center (..), Size (..), staticmap, Zoom (..))
import System.IO (hFlush, stdout)
main :: IO ()
main = do
putStrLn "A test of the Google Maps Geocoding API.\nNB: The use of the \
\API services is subject to the Google Maps APIs Terms of Serivce at \
\https://developers.google.com/maps/terms.\n"
txt <- input "Enter full address: "
mgr <- newManager tlsManagerSettings
let apiKey = Key "<REPLACE_THIS_WITH_YOUR_ACTUAL_GOOGLE_API_KEY>"
result <- geocode mgr apiKey (Address txt)
case result of
Right response -> do
let s = status response
case s of
OK -> do
let center = Center $ location $ geometry $ head $
results response
print center
displayMap mgr apiKey center
_ -> putStrLn $ "Error! Status: " ++ show s
_ -> putStrLn $ "Error! Result:\n" ++ show result
input :: Text -> IO Text
input msg = T.putStr msg >> hFlush stdout >> T.getLine
displayMap :: Manager -> Key -> Center -> IO ()
displayMap mgr apiKey center = do
let zoom = Just $ Zoom 17
w = 400
h = 400
size = Size w h
result <- staticmap mgr apiKey Nothing (Just center) zoom size Nothing
Nothing [] Nothing [] [] Nothing
case result of
Right response -> do
let picture = fromJust $ fromDynamicImage response
title = "Test Google Maps Geocoding API"
window = InWindow title (w, h) (10, 10)
display window white picture
Left err -> putStrLn $ "Error while displaying map: " ++ show err- geocode :: Manager -> Key -> Address -> IO (Either ServantError GeocodingResponse)
- type GoogleMapsGeocodingAPI = "geocode" :> ("json" :> (QueryParam "key" Key :> (QueryParam "address" Address :> Get '[JSON] GeocodingResponse)))
- api :: Proxy GoogleMapsGeocodingAPI
- newtype Key :: * = Key Text
- newtype Address = Address Text
- data GeocodingResponse = GeocodingResponse {}
- data Status
- data Result = Result {}
- data AddressType = AddressType Text
- data AddressComponent = AddressComponent {}
- newtype PostcodeLocality = PostcodeLocality Text
- data Geometry = Geometry {}
- newtype PlaceId = PlaceId Text
- data Location :: * = Location {}
- data LocationType
- data Viewport = Viewport {}
Functions
geocode :: Manager -> Key -> Address -> IO (Either ServantError GeocodingResponse) Source #
Geocode. NB: The use of the Google Maps Geocoding API services is subject to the Google Maps APIs Terms of Service.
API
type GoogleMapsGeocodingAPI = "geocode" :> ("json" :> (QueryParam "key" Key :> (QueryParam "address" Address :> Get '[JSON] GeocodingResponse))) Source #
Google Translate API
api :: Proxy GoogleMapsGeocodingAPI Source #
API type
Types
Address
Contains the status of the request and may contain debugging information to help you track down why geocoding is not working.
Constructors
| OK | Indicates that no errors occurred; the address was successfully parsed and at least one geocode was returned. |
| ZeroResults | Indicates that the geocode was successful but returned no results. This may occur if the geocoder was passed a non-existent address. |
| OverQueryLimit | |
| RequestDenied | |
| InvalidRequest | Generally indicates that the query (address, components or latlng) is missing. |
| UnknownError |
A result of the geocoder.
Constructors
| Result | |
Fields
| |
data AddressType Source #
Address (and address component) type: The list of types provided by Google (as at 4 March 2017) is incomplete.
Constructors
| AddressType Text |
Instances
data AddressComponent Source #
Address component
Constructors
| AddressComponent | |
Fields
| |
newtype PostcodeLocality Source #
Postcode locality: a locality contained in a postal code.
Constructors
| PostcodeLocality Text |
Geometry
Constructors
| Geometry | |
Fields
| |
Place id
Location: precision in latitude or longitude beyond 6 decimal places is ignored.
Constructors
| Location | |
data LocationType Source #
Location type
Constructors
| Rooftop | |
| RangeInterpolated | |
| GeometricCenter | |
| Approximate |
Instances