Class GoogleCustomSearchAction

Action that performs web search using the Google Custom Search JSON API and returns structured results.

Example

// Basic Google search
await runAction({
  ActionName: 'Google Custom Search',
  Params: [{
    Name: 'Query',
    Value: 'latest trends in renewable energy'
  }]
});

// Search with additional options
await runAction({
  ActionName: 'Google Custom Search',
  Params: [{
    Name: 'Query',
    Value: 'AI regulation whitepapers'
  }, {
    Name: 'MaxResults',
    Value: 5
  }, {
    Name: 'SafeSearch',
    Value: 'high'
  }, {
    Name: 'SiteSearch',
    Value: 'europa.eu'
  }, {
    Name: 'Verbosity',
    Value: 'minimal'  // 'minimal' | 'standard' (default) | 'detailed'
  }]
});

Hierarchy (view full)

Constructors

constructor

Methods

InternalRunAction Run addOutputParam buildResultData clamp createErrorResult extractFirstString getNumericParam getStringParam normalizeLanguageRestriction normalizeSafeSearch normalizeSearchType normalizeSiteSearchFilter normalizeVerbosity transformItemByVerbosity

Constructors

constructor

Methods

Protected InternalRunAction

Run

  • Run(params): Promise<ActionResultSimple>

  • Executes the action with the provided parameters.

    Parameters

    • params: RunActionParams<any>

      The action execution parameters including context

    Returns Promise<ActionResultSimple>

    Promise resolving to the action result

Private addOutputParam

Private buildResultData

  • buildResultData(data, items, verbosity, metadata): {
        items: unknown[];
        maxResults: number;
        query: string;
        startIndex: number;
        totalResults: number;
    } | {
        items: unknown[];
        maxResults: number;
        query: string;
        searchTime: number;
        startIndex: number;
        totalResults: number;
    } | {
        context: Record<string, unknown>;
        items: unknown[];
        maxResults: number;
        queries: Record<string, unknown>;
        query: string;
        searchInformation: {
            formattedSearchTime?: string;
            formattedTotalResults?: string;
            searchTime?: number;
            totalResults?: string;
        };
        searchTime: number;
        startIndex: number;
        totalResults: number;
    }

  • Parameters

    • data: GoogleSearchResponse
    • items: unknown[]
    • verbosity: "minimal" | "standard" | "detailed"
    • metadata: {
          maxResults: number;
          query: string;
          startIndex: number;
          totalResults: number;
      }
      • maxResults: number
      • query: string
      • startIndex: number
      • totalResults: number

    Returns {
        items: unknown[];
        maxResults: number;
        query: string;
        startIndex: number;
        totalResults: number;
    } | {
        items: unknown[];
        maxResults: number;
        query: string;
        searchTime: number;
        startIndex: number;
        totalResults: number;
    } | {
        context: Record<string, unknown>;
        items: unknown[];
        maxResults: number;
        queries: Record<string, unknown>;
        query: string;
        searchInformation: {
            formattedSearchTime?: string;
            formattedTotalResults?: string;
            searchTime?: number;
            totalResults?: string;
        };
        searchTime: number;
        startIndex: number;
        totalResults: number;
    }

Private clamp

Private createErrorResult

Private extractFirstString

Private getNumericParam

Private getStringParam

Private normalizeLanguageRestriction

Private normalizeSafeSearch

Private normalizeSearchType

Private normalizeSiteSearchFilter

Private normalizeVerbosity

Private transformItemByVerbosity

  • transformItemByVerbosity(item, verbosity): {
        displayLink?: undefined;
        fileFormat?: undefined;
        formattedUrl?: undefined;
        htmlSnippet?: undefined;
        image?: undefined;
        link: string;
        mime?: undefined;
        pagemap: undefined;
        snippet: string;
        thumbnail?: undefined;
        title: string;
    } | {
        displayLink?: undefined;
        fileFormat?: undefined;
        formattedUrl?: undefined;
        htmlSnippet?: undefined;
        image: string;
        link: string;
        mime?: undefined;
        pagemap: undefined;
        snippet: string;
        thumbnail: string;
        title: string;
    } | {
        displayLink: string;
        fileFormat: string;
        formattedUrl: string;
        htmlSnippet: string;
        image: string;
        link: string;
        mime: string;
        pagemap: Record<string, unknown>;
        snippet: string;
        thumbnail: string;
        title: string;
    }

  • Parameters

    • item: GoogleSearchItem
    • verbosity: "minimal" | "standard" | "detailed"

    Returns {
        displayLink?: undefined;
        fileFormat?: undefined;
        formattedUrl?: undefined;
        htmlSnippet?: undefined;
        image?: undefined;
        link: string;
        mime?: undefined;
        pagemap: undefined;
        snippet: string;
        thumbnail?: undefined;
        title: string;
    } | {
        displayLink?: undefined;
        fileFormat?: undefined;
        formattedUrl?: undefined;
        htmlSnippet?: undefined;
        image: string;
        link: string;
        mime?: undefined;
        pagemap: undefined;
        snippet: string;
        thumbnail: string;
        title: string;
    } | {
        displayLink: string;
        fileFormat: string;
        formattedUrl: string;
        htmlSnippet: string;
        image: string;
        link: string;
        mime: string;
        pagemap: Record<string, unknown>;
        snippet: string;
        thumbnail: string;
        title: string;
    }

Settings

Member Visibility

Theme

On This Page

constructorInternalRunActionRunaddOutputParambuildResultDataclampcreateErrorResultextractFirstStringgetNumericParamgetStringParamnormalizeLanguageRestrictionnormalizeSafeSearchnormalizeSearchTypenormalizeSiteSearchFilternormalizeVerbositytransformItemByVerbosity