Third-Party Verticals | Yext Hitchhikers Platform
Overview
While most verticals in your Search experience will be powered by the Yext Knowledge Graph, you also have the option to return results not stored in the Yext platform in the form of links via a third-party vertical.
You will need to set up the search engine directly through the third party. There you’ll specify what domains should be searched to surface results (e.g., whether you want the full domain or to exclude certain sections or file types). Keep in mind that you are not able to configure how results are returned like you are with Yext verticals in the Search configuration. The Search experience sends the raw query input to the third party and then renders the results returned by the provided endpoint.
Search currently supports the following third-party verticals:
- Google Programmable Search Engine
Below you’ll find the code snippets needed to set this up in your Search configuration, which must be added via the JSON editor to the verticals object. You can use any vertical key you would like; we’ll use links in the code snippets below.
Google Programmable Search Engine
| Property | Required | Description |
|---|---|---|
name |
Yes | Display name of the vertical |
source |
Yes | "GOOGLE_CSE" |
apiKey |
Yes | The API Key for Google Programmable Search. We recommend enabling billing and increasing the quota limit to support the volume of queries. |
endpoint |
Yes | "VERTEX" |
projectId |
Yes | Found in Google Programmable Search portal. |
appId |
Yes | Found in Google Programmable Search portal. |
useSynonyms |
No | This allows you to specify which Google Programmable Search Engine synonyms should be used to surface results. |
"verticals": {
"links": {
"name": "Links",
"source": "GOOGLE_CSE",
"apiKey": "{{YOUR_API_KEY}}",
"endpoint": "VERTEX",
"projectId": "{{YOUR_PROJECT_ID}}",
"appId": "{{YOUR_APP_ID}}",
"useSynonyms": "ALL_SYNONYMS"
}
}