The Google Search component is an application component that allows users to leverage the Google Search engine. It can carry out the following tasks:
#Release Stage
Alpha
#Configuration
The component definition and tasks are defined in the definition.json and tasks.json files respectively.
#Setup
In order to communicate with Google, the following connection details need to be
provided. You may specify them directly in a pipeline recipe as key-value pairs
within the component's setup
block, or you can create a Connection from
the Integration Settings
page and reference the whole setup
as setup: ${connection.<my-connection-id>}
.
Field | Field ID | Type | Note |
---|---|---|---|
API Key (required) | api-key | string | API Key for the Google Custom Search API. You can create one here |
Search Engine ID (required) | cse-id | string | ID of the Search Engine to use. Before using the Custom Search JSON API you will first need to create and configure your Programmable Search Engine. If you have not already created a Programmable Search Engine, you can start by visiting the Programmable Search Engine control panel. You can find this in the URL of your Search Engine. For example, if the URL of your search engine is https://cse.google.com/cse.js?cx=012345678910 , the ID value is: 012345678910 |
#Supported Tasks
#Search
Search data via Google Search Engine.
Input | ID | Type | Description |
---|---|---|---|
Task ID (required) | task | string | TASK_SEARCH |
Query (required) | query | string | The search query for Google |
Top K | top-k | integer | The number of results to return for each query |
Include Link Text | include-link-text | boolean | Indicate whether to scrape the link and include the text of the link associated with this search result in the 'link-text' field |
Include Link HTML | include-link-html | boolean | Indicate whether to scrape the link and include the raw HTML of the link associated with this search result in the 'link-html' field |
Output | ID | Type | Description |
---|---|---|---|
Results | results | array[object] | The returned search results from Google |
Output Objects in Search
Results
Field | Field ID | Type | Note |
---|---|---|---|
Link | link | string | The full URL to which the search result is pointing, e.g., http://www.example.com/foo/bar. |
Link HTML | link-html | string | The scraped raw html of the link associated with this search result |
Link Text | link-text | string | The scraped text of the link associated with this search result, in plain text |
Snippet | snippet | string | The snippet from the page associated with this search result, in plain text |
Title | title | string | The title of a search result, in plain text |