Cloud Search getting started tutorial

This guide explores a simple end-to-end deployment of Cloud Search and contains two sample applications: a content connector to index data and a web app for querying the index. In this tutorial, data from GitHub repositories is used for indexing.


  • Clone or download the sample app.
  • Build the app and run it on your local machine.
  • Walk through the sample code.
  • Learn how the connector indexes data.
  • Learn how the search app queries data.


This tutorial requires:

  • Administrator access to a G Suite or Cloud Identity domain with Cloud Search for Third Party Data Indexing enabled. If you're unable to view settings in the Admin control panel, either contact your domain administrator or sign-up for Cloud Search.
  • A GitHub user account.

This tutorial also requires that you are familiar with Java and JavaScript. You must have:

Getting started

To begin, create a new project and get the source code for the tutorial.

  1. In the developer console, go to the manage resources page and select or create a new project.

    Go to the Manage resources page

  2. Enable the Cloud Search API

    Enable the Cloud Search API

  3. Clone the sample repository:
    git clone

About the tutorial application

The application in the tutorial is composed of two main parts: the first is a content connector created with the Cloud Search Connector SDK. The second is a small web application that uses the search widget to provide a customized search interface.

The connector indexes a subset of information from GitHub repositories. This includes issues, pull requests, and the head content of the default branch (master).

The mix of item types demonstrates indexing of both structured and unstructured content, the use of schemas, and query features, such as faceting to allow interactive refinement of queries.