Cmdlets for Google Search

Build 21.0.7930

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our GoogleSearch Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module GoogleSearchCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module GoogleSearchCmdlets;

You can then use the Connect-GoogleSearch cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-GoogleSearch -ApiKey 'MyApiKey' -CustomSearchID 'MyCustomSearchID'

Connecting to Google Search

Provide the following connection properties before adding the authentication properties.

  • CustomSearchId: Obtain this value by signing into Google Custom Search Engine and creating a new search engine.
  • APIKey: You must enable the Custom Search API in the Google API Console.

For more information on obtaining values for these properties, refer to Connecting to Google Search.

Retrieving Data

The Select-GoogleSearch cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-GoogleSearch -Connection $conn -Table "WebSearch" -Columns @("DisplayLink, Title") -Where "SearchTerms='Fantastic Four'"
The Invoke-GoogleSearch cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-GoogleSearch -Connection $conn -Table WebSearch -Where "SearchTerms = 'Fantastic Four'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myWebSearchData.csv -NoTypeInformation

You will notice that we piped the results from Select-GoogleSearch into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-GoogleSearch -ApiKey 'MyApiKey' -CustomSearchID 'MyCustomSearchID'
PS C:\> $row = Select-GoogleSearch -Connection $conn -Table "WebSearch" -Columns (DisplayLink, Title) -Where "SearchTerms = 'Fantastic Four'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "WebSearch",
  "Columns":  [

  ],
  "DisplayLink":  "MyDisplayLink",
  "Title":  "MyTitle"
} 

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930