TypeScript typings for Custom Search API v1

Searches over a website or collection of websites For detailed description please check documentation.

Installing

Install typings for Custom Search API:

npm install @types/gapi.client.customsearch-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://customsearch.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.search
  },
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('customsearch', 'v1', () => {
  // now we can use:
  // gapi.client.search
});

After that you can use Custom Search API resources:

/*
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.
*/
await gapi.client.search.cse.list({});

For provenance information see Provenance section on NPM