X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Google Maps

The adapter accesses Google Maps via its web service interface and retrieves the geographical information for an address. In addition, a route including waypoints can be calculated and a URL to the corresponding Google Maps map section can be generated. The adapter outputs its results as XML or JSON document.

By default, the free Google Maps API is used; To benefit from all services without limitations, you can also use the Google Maps API Premier with this adapter by specifying credentials within the parameters clientID and privateKey.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

  • Geocode: Retrieve all geographical information for an address (street, country/state, nation, coordinates etc.)

  • ReverseGeocode: Retrieve all geographical information for a decimal coordinate (street, country/state, nation, coordinates etc.)

  • GetDirections: Retrieve the route between a start point and a destination with any number of waypoints

  • CreateGoogleURL: Create a URL to a Google Maps map section image (when using the Google Maps API Premier with a signed URL)

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.integration.adapter. geo.google.Google MapsAdapter: Main class (default)

clientID

Client ID to use the Google Maps API Premier

Possible values:

  • Any valid string

  • (empty): Use free Google Maps API (default)

privateKey

Private key for the Google Maps API Premier (if parameter clientID is set)

Possible values: Any valid string

outputFormat

Define the Google Maps output format for requests

 Possible values:

  • xml: Output XML document

  • json: Output JSON document

timeout

Timeout to establish a connection in milliseconds

Possible values:

  • Any integer number

  • 0: No limitation

  • 20000: Cancel connection establishment after 20 seconds

pxHost

IP address or host name of a proxy server

Possible values: Any valid string (e.g. 192.168.1.1)

pxPort

Port number of the proxy server

Possible values: Any integer number

pxLogin

User name for the proxy server

Possible values: Any valid string

pxPwd

Password for the proxy server

Possible values: Any valid string

Status values

1 (successful)

The request has been successful and a result has been output

0 (empty)

The request has been successful, but no result has been output

-1 (failed)

The request failed because of a technical error