Google

Cloud Search API

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud…

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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.

Endpoints 44

debug.datasources.items

  • POSTChecks whether an item is accessible by specified principal/v1/debug/:name:checkAccess?debugOptions.enableDebugging=trueChecks 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…
  • POSTFetches the item whose viewUrl exactly matches that of the URL provided in the request/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.

debug.identitysources.unmappedids

  • GETLists unmapped user identities for an identity source/v1/debug/:parent/unmappedids?debugOptions.enableDebugging=true&pageSize=0&pageToken=string&resolutionStatusCode=CODE_UNSPECIFIEDLists unmapped user identities for an identity source. Note: This API requires an admin account to execute.

debug.identitysources.items

  • GETLists names of items associated with an unmapped identity/v1/debug/:parent/items:forunmappedidentity?debugOptions.enableDebugging=true&groupResourceName=string&pageSize=0&pageToken=string&userResourceName=stringLists names of items associated with an unmapped identity. Note: This API requires an admin account to execute.

indexing.datasources

  • GETGets the schema of a data source/v1/indexing/:name/schema?debugOptions.enableDebugging=trueGets the schema of a data source. Note: This API requires an admin or service account to execute.
  • PUTUpdates the schema of a data source/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…
  • DELETEDeletes the schema of a data source/v1/indexing/:name/schema?debugOptions.enableDebugging=trueDeletes the schema of a data source. Note: This API requires an admin or service account to execute.

indexing.datasources.items

  • GETGets Item resource by item name/v1/indexing/:name?connectorName=string&debugOptions.enableDebugging=trueGets 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…
  • DELETEDeletes Item resource for the specified resource name/v1/indexing/:name?connectorName=string&debugOptions.enableDebugging=true&mode=UNSPECIFIED&version=stringDeletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one…
  • POSTDeletes all items in a queue/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…
  • POSTUpdates Item ACL, metadata, and content/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…
  • GETLists all or a subset of Item resources/v1/indexing/:name/items?brief=true&connectorName=string&debugOptions.enableDebugging=true&pageSize=0&pageToken=stringLists 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…
  • POSTPolls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the…/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…
  • POSTPushes an item onto a queue for later polling and updating/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…
  • POSTUnreserves all items from a queue, making them all eligible to be polled/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…
  • POSTCreates an upload session for uploading item content/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…

media

  • POSTUploads media for indexing/v1/media/:resourceNameUploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be inlined during…

operations

  • GETGets the latest state of a long-running operation/v1/:nameGets 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.

operations.lro

  • GETLists operations that match the specified filter in the request/v1/:name/lro?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

query

  • POSTProvides functionality to remove logged activity for a user/v1/query:removeActivityProvides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients Note: This API requires a standard end user account…
  • POSTThe Cloud Search Query API provides the search method, which returns the most relevant results from a user query/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…
  • POSTProvides suggestions for autocompleting the query/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…

query.sources

  • GETReturns list of sources that user can use for Search and Suggest APIs/v1/query/sources?pageToken=string&requestOptions.clientDisplayLanguageCode=string&requestOptions.countryCode=string&requestOptions.debugOptions.enableDebugging=true&requestOptions.languageCode=string&requestOptions.queryLanguageCode=string&requestOptions.searchApplicationId=string&requestOptions.timeZone=stringReturns 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't…

settings

  • GETGet customer settings/v1/settings/customerGet customer settings. Note: This API requires an admin account to execute.
  • PATCHUpdate customer settings/v1/settings/customer?updateMask=stringUpdate customer settings. Note: This API requires an admin account to execute.

settings.datasources

  • GETLists datasources/v1/settings/datasources?debugOptions.enableDebugging=true&pageSize=0&pageToken=stringLists datasources. Note: This API requires an admin account to execute.
  • POSTCreates a datasource/v1/settings/datasourcesCreates a datasource. Note: This API requires an admin account to execute.

settings.searchapplications

  • GETGets the specified search application/v1/settings/:name?debugOptions.enableDebugging=trueGets the specified search application. Note: This API requires an admin account to execute.
  • PUTUpdates a search application/v1/settings/:name?updateMask=stringUpdates a search application. Note: This API requires an admin account to execute.
  • DELETEDeletes a search application/v1/settings/:name?debugOptions.enableDebugging=trueDeletes a search application. Note: This API requires an admin account to execute.
  • PATCHUpdates a search application/v1/settings/:name?updateMask=stringUpdates a search application. Note: This API requires an admin account to execute.
  • GETLists all search applications/v1/settings/searchapplications?debugOptions.enableDebugging=true&pageSize=0&pageToken=stringLists all search applications. Note: This API requires an admin account to execute.
  • POSTCreates a search application/v1/settings/searchapplicationsCreates a search application. Note: This API requires an admin account to execute.
  • POSTResets a search application to default settings/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.

stats

  • GETGets indexed item statistics aggreggated across all data sources/v1/stats/index?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the…
  • GETGet the query statistics for customer/v1/stats/query?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the query statistics for customer. Note: This API requires a standard end user account to execute.
  • GETGet search application stats for customer/v1/stats/searchapplication?endDate.day=0&endDate.month=0&endDate.year=0&startDate.day=0&startDate.month=0&startDate.year=0Get search application stats for customer. Note: This API requires a standard end user account to execute.
  • GETGet the # of search sessions, % of successful sessions with a click query statistics for customer/v1/stats/session?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the # of search sessions, % of successful sessions with a click query statistics for customer. Note: This API requires a standard end user account to…
  • GETGet the users statistics for customer/v1/stats/user?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the users statistics for customer. Note: This API requires a standard end user account to execute.

stats.index.datasources

  • GETGets indexed item statistics for a single data source/v1/stats/index/:name?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Gets indexed item statistics for a single data source. Note: This API requires a standard end user account to execute.

stats.query.searchapplications

  • GETGet the query statistics for search application/v1/stats/query/:name?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the query statistics for search application. Note: This API requires a standard end user account to execute.

stats.session.searchapplications

  • GETGet the # of search sessions, % of successful sessions with a click query statistics for search application/v1/stats/session/:name?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user…

stats.user.searchapplications

  • GETGet the users statistics for search application/v1/stats/user/:name?fromDate.day=0&fromDate.month=0&fromDate.year=0&toDate.day=0&toDate.month=0&toDate.year=0Get the users statistics for search application. Note: This API requires a standard end user account to execute.

v1

  • POSTEnables `third party` support in Google Cloud Search/v1:initializeCustomerEnables third party support in Google Cloud Search. Note: This API requires an admin account to execute.

API details

Base URL
https://cloudsearch.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 9 scopes
An API key in the key query parameter
Operations
44 operations on 35 pathsGET 21POST 16DELETE 3PUT 2PATCH 2
Main resources
indexing.datasources.items 9settings.searchapplications 7stats 5indexing.datasources 3query 3debug.datasources.items 2settings 2settings.datasources 2debug.identitysources.items 1debug.identitysources.unmappedids 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Search API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Search API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 9 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Checks whether an item is accessible by specified principal” (POST /v1/debug/:name:checkAccess?debugOptions.enableDebugging=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Search API?

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud… It is listed under Data & analytics and has 44 endpoints.

Who publishes the Cloud Search API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Search API?

Requests go to https://cloudsearch.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Search API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 9 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Search API have?

44 operations on 35 paths (21 GET, 16 POST, 3 DELETE, 2 PUT, 2 PATCH). The largest groups are indexing.datasources.items, settings.searchapplications, stats, indexing.datasources.

Is forking the Cloud Search API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.