What does it do?

This plugin integrates the Google Places Autocomplete API directly with Gravity Forms Address fields. Best of all, you just need to provide an API key and enable one setting.

By incorporating Address Autocomplete, you can:

• Simplify the address entry experience on desktop and mobile devices
• Save your users time – autocomplete an address in seconds
• Increase your form’s conversions and reduce form abandonment

Features

Documentation

1. How do I enable this functionality?
   1. Generate and enter Google API key
   2. Enable on Address field
2. Feature Details
   1. Perk Settings
      1. API Key
      2. Countries
   2. Field Settings
   3. Map Field
      1. Map Field Filters
   4. Latitude and Longitude
3. Generating a Google API Key
   1. Select or Create Google Cloud Platform Project
   2. Enable APIs
      1. Places API
      2. Maps JavaScript API
   3. Generate Key
      1. Security Tips
4. Google’s Terms of Use and Privacy Policy
5. Translations
6. Known Limitations
7. FAQs
   1. Is the Google Places API free?
   2. Can I pass the address’s latitude and longitude to custom fields?
   3. I noticed my Google API Key is visible in the page source code. Will this cause any security issues?
   4. Can I display an autocompleted address in one line?
   5. How do I restrict autocomplete results to a specific state?
   6. How do I limit results to a specific country?
   7. How do I enable autofill for GPAA-enabled Address fields?
8. Hooks
9. Related Resources

How do I enable this functionality?

After installing and activating Gravity Forms Address Autocomplete, an Enable Google Address Autocomplete checkbox will display under the Perks section for Address fields.

The following instructions will show you how to generate a Google API key for Address Autocomplete and enable it for an Address field.

Generate and enter Google API key

Before you can use Address Autocomplete, you need to generate an API key in the Google Cloud Platform console.

	Enable Google Places API and Google Maps JavaScript API. See detailed instructions.
	Create and Restrict Google API key. See detailed instructions.
	Enter Google API Key.

Enable on Address field

	Add an Address field to your form.
	Open the field’s settings, navigate to the Perks section, and check Enable Google Address Autocomplete.

Feature Details

Perk Settings

Before Address Autocomplete can function, it needs to be configured.

You can navigate to Address Autocomplete’s setting by going to Forms » Settings » Autocomplete.

API Key

If there’s one setting to configure, this is it! This is the API key that Address Autocomplete will use to authenticate requests with Google’s Places and Maps JavaScript APIs.

See instructions below on how to generate a Google API Key.

Countries

If you need to restrict the results of all autocomplete results to specific countries, select the countries using the “Countries” setting.

Important Note: There is a limit of 5 countries that can be selected due to limits with the Google API.

Unselecting all countries will allow results to be returned from all countries.

Field Settings

After you have an API key generated and have entered it, all that is left is checking “Enable Google Address Autocomplete” on the address fields you wish to enable autocomplete on.

Map Field

Address Autocomplete also introduces a Map field to Gravity Forms. The Map field displays an interactive map and adds a marker for the entered address. When a user enters or updates the address in a field with Address Autocomplete active, the Map field automatically updates the map’s location to display the location.

	Add a Map field to your form.
	Open the field’s settings, navigate to the General section, and map the Attached Address Field to your Address Autocomplete-enabled Address field.

Once activated, any address entered into the field will automatically be displayed on the map.

Map Field Filters

The Map field comes wiht a number of filters that allow you to tweak both the map and marker settings using the gpaa_map_options and gpaa_marker_options filters and the gpaa_marker_set action. Some the things you can do with these hooks include:

• Set a default starting location.
• Modify the default zoom.
• Enable/disable various map controls.
• Enable points of interest.
• Give the marker a label.

Latitude and Longitude

Address Autocomplete automatically saves the latitude and longitude of the selected address into the entry meta. It is available for selection in feeds and the {entry} merge tag. Check out our FAQ for more information.

Generating a Google API Key

Select or Create Google Cloud Platform Project

Before enabling APIs and generating an API key, you need to either select an existing Google Cloud Platform or create a new GCP project.

If creating a new project, we recommend scoping it to the specific site you are working on in case you need to use any other Google services for that site.

Enable APIs

After you’ve selected or created a Google Cloud Platform project, navigate to APIs & Services » Services and activate the following APIs:

Places API

(Quick link)

Maps JavaScript API

(Quick link)

Generate Key

With the APIs enabled, it’s now time to generate an API key to use in the “Google API Key” setting for GF Address Autocomplete.

First, Navigate to APIs & Services » Credentials. Then, click “+ Create Credentials” followed by “API key”

You will see that an API key is immediately generated. While you can go ahead and use it in its current state, it’s incredibly important to go through the steps of restricting the key to prevent unauthorized use.

Security Tips

After clicking Restrict Key or the edit icon on an existing API key for autocomplete, it’s recommended you do the following:

1. Name the API Key
2. Check HTTP referrers (web sites) under Application restrictions
3. Add the website domain(s) that should be allowed. If you have a local or staging copy of the website, those need to be accounted for here as well.
4. Check Restrict key under API restrictions and restrict the key to only allow “Places API” and “Maps JavaScript API”

Once configured, the settings for the API key should look something like the following:

Google’s Terms of Use and Privacy Policy

GF Address Autocomplete sends data from your site to Google’s services and Google recommends that if you use Places API, then you should include their Terms of Service and Privacy Policy in your application.

Translations

You can use the free Loco Translate plugin to create translations for any of our Perks. If you’ve never used Loco translate before, here’s a tutorial written for beginners.

Known Limitations

• The Google Places API allows you to specify which countries to include (up to five) but does not provide a way to specify which countries to exclude.

FAQs

Is the Google Places API free?

When you use the Google Places API, Google automatically provides a $200 monthly credit that Google Places API requests are charged against.

As of writing, you can expect around 10,000 autocomplete sessions a month to be covered by the $200 monthly credit.

See the Google Maps Platform Pricing Table for more specific and up-to-date details.

Can I pass the address’s latitude and longitude to custom fields?

That latitude and longitude can be passed to custom fields using the Advanced Post Creation Add-On or Post Custom Field fields.

If you’re using the Advanced Post Creation Add-On, you can map the latitude and longitude to custom fields by selecting the meta values from the Value drop down.

If you’re using a Post Custom Field field, you can map the entry meta to your desired ACF field via the Content Template setting. Replace the 1 in the merge tag below with the Field ID of your Address Field.

I noticed my Google API Key is visible in the page source code. Will this cause any security issues?

Since this API is a client-side API and not a server-side API, this is how Google knows that the requests are authenticated. As long as you lock down the API key using our security tips, you will be good to go.

Can I display an autocompleted address in one line?

Yes! This handy snippet allows you to populate a single line text field with an autocompleted address. Check out our tutorial video for a step-by-step guide to using this snippet.

How do I restrict autocomplete results to a specific state?

Unfortunately, it’s not possible to limit results to a specific state, but there are a few workarounds available.

You can use this snippet to restrict which states are accepted in the Address fields. You can choose to restrict specific address fields, or restrict all address fields on the form. One important note – this snippet will not impact which states appear in the autocompleted results.

You can use this snippet to restrict autocomplete results to a circular area based on custom latitude and longitude coordinates.

For example, if we wanted to restrict the autocomplete results to be within 100 miles of the White House in Washington DC, we would set these values in the snippet:

• var centerLat = 38.897957 – the Latitude coordinates of the White House.
• var centerLng = -77.036560 – the Longitude coordinates of the White House.
• var miles = 100; – the circular area to include in the search.

This same logic can be applied for restricting the area to a certain state by adding the coordinates of the center of the state. Based on the coordinates and circular area you set, it’s possible that some portions of surrounding states will be included in the autocomplete results.

How do I limit results to a specific country?

To limit all autocomplete results to a specific country, navigate to Forms › Settings › Autocomplete, and choose which countries you’d like to restrict the results to.

More information is available in the Perk Settings details.

How do I enable autofill for GPAA-enabled Address fields?

By default, GP Address Autocomplete disables browser autofill for Address fields because it can create confusion when the user is attempting to enter an address. They may be presented with autofill and autocomplete options (in different menus) at the same time.

If you prefer to allow browser autofill, you can use the gpaa_prevent_browser_autocomplete filter to enable it.

Hooks

• gpaa_autocomplete_options (JS)
• gpaa_coords
• gpaa_fields_filled (JS)
• gpaa_init (JS)
• gpaa_init_args
• gpaa_map_options (JS)
• gpaa_marker_options (JS)
• gpaa_marker_set (JS)
• gpaa_prevent_browser_autocomplete (JS)
• gpaa_use_fixed_positioner
• gpaa_values (JS)