Support Details
Google Places is supported as an Address Lookup provider in ShareDo from version 7.7+
The current version of Google Places Plugin is v1.0.3
To perform an Address Lookup in ShareDo, you must first configure a provider. Below are the instructions for configuring Google Places as an Address Lookup provider.
Install Google Places
To install Google Places Address Lookup in your ShareDo environment, contact your CSM and ShareDo will install it for you.
Configure the Service
You need to register an account on Google Cloud Console and create an API Key that has access to certain API Endpoints.
- Navigate to Admin > Integration > Manage Linked Services
- Add a new Linked Service, by clicking the ‘Add New’ button, in the top right hand corner.
- Select Shared Secret from the list of available service providers.
- Provide the Linked Service with an API Secret; get this from your Google Cloud Account. There are some additional account set up steps, such as configuring Google Cloud with a billing account, which are beyond the scope of this tutorial.
Some of these settings are specific to your organisation.
- In your new project select + Enable APIs and services.
- Search for ‘Places API’ in the search field
- From the results, select Places API (New). Here you can review pricing information, and other documentation.
- Select the Enable button. Next Link a Billing account. As mentioned previously.
- Once enabled, return to your project overview and go to the Keys & Credentials section.
- From here, choose ‘+ Create credentials’, and select API Key
- A modal displays your new API Key. Make sure you note this down somewhere to use later.
- Google then prompt you to Apply restrictions to the API Key. Restrictions are important to prevent your key being stolen, or misued.
It is recommended that at minimum we restrict the API Key to the following API's:
However you could go further and restrict the key to requests that originate from a specific Domain, or IP address:
- Once you are finished with the Google Cloud config, you are ready to move back into ShareDo.
- Configure the Linked service as follows;
| Field | Value |
|---|---|
| Name | Your Choice - we recommend - 'Google Places Linked Service' |
| Icon | Your Choice - we recommend - 'fa-google' |
| Description | Enter something to describe the service |
| Secret | The secret key you copied earlier on the Google Cloud Dashboard |
| Allow fallback to system secret? | On |
| API base URL | https://places.googleapis.com |
| HTTP Header to send token in | X-Goog-Api-Key |
| HTTP Header prefix | {Leave this blank} |
Configure the ShareDo Address Lookup for Google Places
Within Modeller > Global Features, navigate to Address Lookup, ensure it is enabled.
Click the Cog icon to configure the Settings.
| Setting | Description |
|---|---|
| Address Query Delay | When a user stops typing into the address search box for the specified duration then ShareDo calls the address provider. Every call incurs some level of charge; this setting determines how often this call is made. |
| Provider |
Select Google Places. The fields that relate to Google Places display. Click to see example. Click again to close.
|
| Linked Service | This dropdown provides a list of the available Linked Services in ShareDo, choose the one that you set up for Google Places. |
| Search Type |
Text Search / Auto Complete / Both For most use cases you will want to use TextSearch, or Both. |
| Regions | The Country in which you want to use Google Address Search for. |
Congratulations Google Places is now Installed and configured on your ShareDo environment!