Google Maps enricher

The Google Maps enricher cleanses, standardizes, and enriches international postal addresses with geocoding information.

Plugin ID

Google Maps Enricher - com.semarchy.integration.rowTransformers.googleMapsEnricher

Description

This enricher takes an input address, enriches and validates this postal address using the Google Geocoding service.

This plugin must be used in compliance with the Google Maps/Google Earth APIs Terms of Service.
This enricher uses the Google Geocoding service, which must be accessible from the Semarchy xDM Application at the following URL: http://maps.googleapis.com/maps/api/geocode/json?<parameters>. Make sure to make this URL accessible through your firewalls.
This plugin is thread-safe and supports parallel execution.

Plugin parameters

The following table lists the plugin parameters.

Parameter name Mandatory Type Description

Client ID or API Key

No

String

This parameter may contain either an API key (for Standard API usage) or the client ID (for Premium Usage), both provided by Google. The client ID should begin with the gme- prefix. When providing a client ID, the signature (private key) is required.

Channel

No

String

This parameter assigns a specific channel name and allows tracking usage for this plugin in the Google Maps usage reports.

Default Language

No

String

Code of the default language used for the returned results. For example, for same address, "Rue Mathieu Misery" would appear in French and "Mathieu Misery Street" in English. This code can be overridden by the Language plugin input. See the list of supported domain languages for more information.

Private Key

No

String

Cryptographic signature key provided by Google with the client ID.

Request per Second

No

Integer

This parameter limits the number of requests per second made by the enricher to remain within the limits of the API. It defaults to 50 requests per seconds.

You can use the Google Maps service with one of the following authentication methods:

Keyless access to this API is not supported by Google.

Plugin inputs

The following table lists the plugin inputs.

Input name Mandatory Type Description

Address Line

Yes

String

Address line to process. If the address is composed of multiple lines, then these lines must be provided as a comma-separated list of address lines.

Postal Code

No

String

Postal code of the address.

City

No

String

City of the address.

Country

No

String

Country of the address.

Language

No

String

Code of the language for the returned result for this record. This language overrides the Default Language parameter. For more information, see the list of supported domain languages.
The state, region or province information can be passed in the City input, concatenated with the city name (e.g., Address.City || ' ' || Address.State).
The entire address, including the Address Line, Postal Code, City and Country values can be passed to the plugin as a single concatenated string in the Address Line input. If the source data contains the address in a single string, then you can pass this string directly in the Address Line input.

Plugin outputs

The following table lists the plugin outputs. Outputs marked with a * appear in a full and a short form in the output list.

Output name Type Description

Address Types

String

Comma-separated list of address types (for more information, see the official Google documentation).

Administrative Area Level 1*

String

First-order civil entity below the country level. Within the United States, these administrative levels are states. Not all countries exhibit these administrative levels.

Administrative Area Level 2*

String

Second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all countries exhibit these administrative levels.

Administrative Area Level 3*

String

Third-order civil entity below the country level. Not all countries exhibit these administrative levels.

Airport

String

Indicates an airport.

This output is deprecated.

Country*

String

The national political entity.

East Bound Longitude

String

Bounding box eastern limit.

Floor*

String

Indicates the floor of a building address.

Formatted Address

String

Human-readable version of the geocoded address.

Intersection

String

Major intersection, usually of two major roads.

This output is deprecated.

Latitude

String

Latitude of the address.

Locality*

String

Incorporated city or town political entity.

Longitude

String

Longitude of the address.

Natural Feature*

String

Prominent natural feature.

Neighborhood*

String

Named neighborhood.

North Bound Latitude

String

Bounding box northern limit.

Park*

String

Named park.

Point of Interest*

String

Named point of interest.

Post Box*

String

Specific postal box.

Postal Code*

String

Postal code as used to address postal mail within the country.

Premise*

String

Named location, usually a building or collection of buildings with a common name.

Quality

Integer

The value of an Address Quality element defines the granularity of the location described by an address. Should return a value that expresses this quality between 0 and 100 (100 being the best quality).

Room*

String

The room of a building address.

Route*

String

Named route (such as US 401).

South Bound Latitude

String

Bounding box southern limit.

Status

String

Status of the request. OK indicates that no error occurred and the address was geocoded. ZERO_RESULTS indicates that no error occurred but the address was not geocoded. See the API documentation for a list of status and error codes.

Street Address

String

Precise street address.

This output is deprecated.

Street Number*

String

Precise street number.

Sub-Locality*

String

First-order civil entity below a locality.

Sub-Premise*

String

First-order entity below a named location, usually a singular building within a collection of buildings with a common name.

West Bound Longitude

String

Bounding box western limit.