As a prerequisite to using the Champion Movers project recipe, you need to first set up credentials for Google Search.
Google Developer Console
Step 1: Create a project
Pre-requisite: Access to a Google account
Steps:
- In a browser, go to https://console.cloud.google.com/
- Sign-in with your Google account
- Select project with the drop down at the top navigation bar
- In the pop-up that shows, click on New Project
Step 2: Enter Project Name and ID
Steps:
- Enter a project name (e.g. Openprise Google Search)
- It is optional to update the project ID
- If your account has location info, please select the appropriate value
- Select create
Step 3: Go to APIs & Services
Steps:
- Choose the newly created project from the project dropdown in the top navigation bar
- Click on APIs & Services in the Quick Access section
Step 4: Enable APIs and Services
Steps:
- Click on Enable APIs and Services
- Click on APIs & Services in the Quick access section
Step 5: Find Custom Search API
Steps:
- Search the term "custom search"
Step 6: Select and Enable Custom Search
Steps:
- Select Custom Search API
- In the resulting page, click Enable to enable usage of custom search engine
Step 7: Go to Credentials
Steps:
- Create a credential to use the API. Click on Credentials on the left most navigation section
Step 8: Create a New API Key Credential
Steps:
- Select Create Credentials
- Select API Key to create an API key credential
- Once the API key is created, copy the API key into a text editor as we will need it later on
- Select Edit API Key to add restrictions to the key’s usage
Step 9: Restrict API Key to IP Addresses
Steps:
- It is optional to rename the API key (e.g. Openprise Custom Search API Key)
- Select IP Addresses from the Application Restrictions section
- Please check with your Openprise Customer Success Manager for the IP addresses to whitelist
- Click on Add An Item in the Accept Requests From These Server IP Addresses to add in the IP addresses to whitelist
Step 10: Restrict API Key for Custom Search
Steps:
- Scroll down to the API Restrictions section
- Select Restrict Key
- Click on the dropdown to search for the API to use with the API key
- Type "custom search" and fill the Custom Search API checkbox
- Scroll to the bottom and click Save
Custom Search Engine
Step 11: Create a Custom Search Engine
Steps:
- Go to https://cse.google.com/cse/all
- If asked to sign-in again, sign in with the same account as used earlier
- Create a new search engine by clicking Add
Step 12: Configure Custom Search Engine
Steps:
- Enter a name for the search engine (e.g. Openprise Mover Project)
- Enter a website to search (e.g. *.linkedin.com for the mover identification use case. Note that the image below incorrectly shows the website as linkedin.com)
- Enable SafeSearch to further limit search results
- Click on the "I’m not a robot" reCAPTCHA and then select Create
Step 13: Find and Copy Search Engine ID
Steps:
- Upon creation of the search engine, click Customize
- In the resulting page, find the Search Engine ID in the Overview section and copy the ID into a text editor
Openprise
Step 14: Create Google Search Data Service
Steps:
- In Openprise, go to Data Data Services
- Add a new data service
- In the Select Technology dropdown, select Google Search
- When asked to authenticate to Google Search, enter the email account you used when creating the Custom Search Engine, the Search engine ID and API Key
- Click Save
Step 15: Use Get Search Results task template (optional)
Note: This step can be used to verify that Google Search is set up properly and does not require the Champion Movers recipe to be downloaded
Steps:
- Once saved, a new data service should be created and you should see the Custom Search data service on the Data Service page
- Now create a job and a new task with the task template Get Search Results
- In the Select Data Service dropdown, select the new data service
Step 16: Configure Get Search Results task template (optional)
Note: This step can be used to verify that Google Search is set up properly and does not require the Champion Movers recipe to be downloaded.
Steps:
- Once saved, a new data service should be created and you should see the Custom Search data service in the card screen
- Now, create a job and create task with the template Get search results
- In the Select data service dropdown, select the new data service
Step 17: Configure Search String (optional)
Note: This step can be used to verify that Google Search is set up properly and does not require the Champion Movers recipe to be downloaded.
Steps:
- The most important part of using Custom Search is the query attribute which represents the search string used
- An example is to use the Concatenate Attributes task template to create a search string as shown here. You will need to create your search string attribute in a separate task prior to configuring your Get Search Results task