Google Maps Geocoding API Integration

Note: Customers are responsible for Google Maps API licensing.

Google Maps Geocoding API integration is supported to normalize the address. Note the following about Google Maps Geocoding API integration:

  • The address line, containing the "ADR" property, in the vCard is processed.

  • The address line, which contains none of the required Siebel fields, is validated:

    • To define the required Siebel fields, use the ValidvCardAddressLine Input Argument of the Workflow Process Step: "Normalize Address".

    • The default setting is ";;x;x;;;x" which indicates that the StreetAddress, City, or Country portion of the address data will be checked to see if it is empty. If any portion of the address is empty, then Google Maps Geocoding API is invoked to normalize the address data.

  • The address line is reconstructed based on the Google Maps Geocoding API Response and vCardAddressFormat of the "CalDAV Service" Business Service user property:

    • The default setting for vCardAddressFormat is:

      ;;street_number route;locality;administrative_area_level_1;postal_code;country:long_name

    • You can customize different address formats for each country. The following address format for Germany is available by default:

      vCardAddressFormat-DE

      ;;route street_number;locality;;postal_code;country:long_name

  • Siebel will keep the original address line unchanged if the address line data cannot be processed by Google (for example, if there is an empty response).

  • Google Maps Geocoding API does not always handle the following entities as expected: PO Box, Apt#, or Unit#. In some cases, this data is lost after being processed by Google.

  • Google Maps Geocoding API might return more than one "address_components". When this happens, all matching addresses that are returned from Google will be added to Siebel, and the address records will be cleansed later. For example, if the input address line contains only "San Jose", then the Google Maps Geocoding API might return, for example, the following matching addresses:

    "formatted_address" : "San Jose, CA, USA",
    "formatted_address" : "San Jose, NM 87565, USA",
    "formatted_address" : "San Jose, IL 62682, USA",

For more information about Google Maps Geocoding API and how to obtain the API key, see the following:

  • https://developers.google.com/maps/documentation/geocoding/start

  • https://developers.google.com/maps/documentation/geocoding/get-api-key

  • https://developers.google.com/maps/documentation/geocoding/usage-limits

Related Topic

Type Conversion Mappings