The Google Search Engine Info action is used to retrieve configuration information for Google Custom Search API integration. It is particularly preferred for verifying integration settings (API key, search engine ID – CX) and ensuring that the search function is working correctly.

Technical Specifications

• Function: Checks Google Custom Search settings, verifies that the integration is configured correctly.
• Parameters:
  
  • settings (Object – required): Contains Google Search API settings (API key and search engine ID).
• Result: Single (One) → Returns an object containing search engine settings or verification output.

Value Binding

• Fixed Value.
• Dynamic value (e.g., API settings obtained from the user or stored in the system).

Google Search Engine Info Application Steps

1. Adding an Action

• Go to the screen in the project where the search function will be used.
• Select UI Design → + ADD ACTION → Google → Google Search Engine Info.

2. Configuring Parameters

• settings: Select settings containing the Google API key and Custom Search Engine (CX) information.

3. Execution
   
   • When the action is executed, the integration settings are tested for validity.
   • The result returns information about the settings or an error output.

Usage Scenario: “Google Search Integration Test”

When an application developer adds Google search integration to a project:

• The Google API Key and CX ID are defined in the settings.
• The Google Search Engine Info action is executed.
• If the integration is valid, the output “settings verified” is received.
• If there is an error, an error message such as “API key invalid” or “CX not found” is returned.

Google Search Engine Info Advanced Customizations

• Debugging Purpose: Used to determine whether the issue lies on the settings side or the query side when search results are not returned.
• Displaying Information to the User: Can be used on an information screen showing the user which Custom Search Engine (CX) is being used for the search.
• Environment-Based Settings: Different settings can be used in the test environment and live environment.

Technical Risks and Controls

• If settings is left blank, the action will not work.
• If an incorrect API key or CX ID is entered, an error will be returned.
• This action does not perform a search, it only checks the integration settings.
• API quota limitations must be taken into account.