npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@maxim_mazurok/gapi.client.cloudsearch

v1.0.20220801

Published

TypeScript typings for Cloud Search API v1

Downloads

86

Readme

TypeScript typings for Cloud Search API v1

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search. For detailed description please check documentation.

Installing

Install typings for Cloud Search API:

npm install @types/gapi.client.cloudsearch@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('cloudsearch', 'v1', () => {
  // now we can use gapi.client.cloudsearch
  // ...
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [ 
      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.debug',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.indexing',

      // Search your organization's data in the Cloud Search index
      'https://www.googleapis.com/auth/cloud_search.query',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.settings',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.settings.indexing',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.settings.query',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.stats',

      // Index and serve your organization's data with Cloud Search
      'https://www.googleapis.com/auth/cloud_search.stats.indexing',
    ],
    immediate = true;
// ...

gapi.auth.authorize(
  { client_id: client_id, scope: scope, immediate: immediate },
  authResult => {
    if (authResult && !authResult.error) {
        /* handle successful authorization */
    } else {
        /* handle authorization error */
    }
});

After that you can use Cloud Search API resources:


/*
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
*/
await gapi.client.cloudsearch.media.upload({ resourceName: "resourceName",  });

/*
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
*/
await gapi.client.cloudsearch.operations.get({ name: "name",  });

/*
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
*/
await gapi.client.cloudsearch.query.search({  });

/*
Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
*/
await gapi.client.cloudsearch.query.suggest({  });

/*
Get customer settings. **Note:** This API requires an admin account to execute.
*/
await gapi.client.cloudsearch.settings.getCustomer({  });

/*
Update customer settings. **Note:** This API requires an admin account to execute.
*/
await gapi.client.cloudsearch.settings.updateCustomer({  });

/*
Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute.
*/
await gapi.client.cloudsearch.stats.getIndex({  });

/*
Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.
*/
await gapi.client.cloudsearch.stats.getQuery({  });

/*
Get search application stats for customer. **Note:** This API requires a standard end user account to execute.
*/
await gapi.client.cloudsearch.stats.getSearchapplication({  });

/*
Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.
*/
await gapi.client.cloudsearch.stats.getSession({  });

/*
Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.
*/
await gapi.client.cloudsearch.stats.getUser({  });

/*
Enables `third party` support in Google Cloud Search. **Note:** This API requires an admin account to execute.
*/
await gapi.client.cloudsearch.v1.initializeCustomer({  });