Skip to content
OpenParablePublic APIs

Cloud Search API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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.

Cloud Search API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 43 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://cloudsearch.googleapis.com/
Version
v1
Endpoints
43
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://cloudsearch.googleapis.com/v1/query/sources" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://cloudsearch.googleapis.com/v1/query/sources", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://cloudsearch.googleapis.com/v1/query/sources",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1/debug/{name}/items:searchByViewUrlFetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.
POST/v1/debug/{name}:checkAccessChecks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported. **Note:** This API requires an
GET/v1/debug/{parent}/items:forunmappedidentityLists names of items associated with an unmapped identity. **Note:** This API requires an admin account to execute.
GET/v1/debug/{parent}/unmappedidsLists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.
GET/v1/indexing/{name}Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding
DELETE/v1/indexing/{name}Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted
GET/v1/indexing/{name}/itemsLists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corres
POST/v1/indexing/{name}/items:deleteQueueItemsDeletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used
POST/v1/indexing/{name}/items:pollPolls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority Ite
POST/v1/indexing/{name}/items:unreserveUnreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been rest
GET/v1/indexing/{name}/schemaGets the schema of a data source. **Note:** This API requires an admin or service account to execute.
PUT/v1/indexing/{name}/schemaUpdates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the
DELETE/v1/indexing/{name}/schemaDeletes the schema of a data source. **Note:** This API requires an admin or service account to execute.
POST/v1/indexing/{name}:indexUpdates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided val
POST/v1/indexing/{name}:pushPushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitel
POST/v1/indexing/{name}:uploadCreates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API r
POST/v1/media/{resourceName}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 i
POST/v1/query/searchThe 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 app
GET/v1/query/sourcesReturns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can
POST/v1/query/suggestProvides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API
GET/v1/settings/customerGet customer settings. **Note:** This API requires an admin account to execute.
PATCH/v1/settings/customerUpdate customer settings. **Note:** This API requires an admin account to execute.
GET/v1/settings/datasourcesLists datasources. **Note:** This API requires an admin account to execute.
POST/v1/settings/datasourcesCreates a datasource. **Note:** This API requires an admin account to execute.
GET/v1/settings/searchapplicationsLists all search applications. **Note:** This API requires an admin account to execute.
POST/v1/settings/searchapplicationsCreates a search application. **Note:** This API requires an admin account to execute.
GET/v1/settings/{name}Gets the specified search application. **Note:** This API requires an admin account to execute.
PUT/v1/settings/{name}Updates a search application. **Note:** This API requires an admin account to execute.
PATCH/v1/settings/{name}Updates a search application. **Note:** This API requires an admin account to execute.
DELETE/v1/settings/{name}Deletes a search application. **Note:** This API requires an admin account to execute.
POST/v1/settings/{name}:resetResets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.
GET/v1/stats/indexGets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the curr
GET/v1/stats/index/{name}Gets indexed item statistics for a single data source. **Note:** This API requires a standard end user account to execute.
GET/v1/stats/queryGet the query statistics for customer. **Note:** This API requires a standard end user account to execute.
GET/v1/stats/query/{name}Get the query statistics for search application. **Note:** This API requires a standard end user account to execute.
GET/v1/stats/searchapplicationGet search application stats for customer. **Note:** This API requires a standard end user account to execute.
GET/v1/stats/sessionGet the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to ex
GET/v1/stats/session/{name}Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user acc
GET/v1/stats/userGet the users statistics for customer. **Note:** This API requires a standard end user account to execute.
GET/v1/stats/user/{name}Get the users statistics for search application. **Note:** This API requires a standard end user account to execute.
GET/v1/{name}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.
GET/v1/{name}/lroLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v1:initializeCustomerEnables `third party` support in Google Cloud Search. **Note:** This API requires an admin account to execute.

Questions

Does the Cloud Search API API need an API key?

Yes. The Cloud Search API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Search API API support HTTPS?

Yes, the Cloud Search API API is served over HTTPS.

How many endpoints does the Cloud Search API API have?

Its OpenAPI description lists 43 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Cloud Search API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).