googleapis.com – cloudsearch

OpenAPI apis-guru analyticsmedia

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.

Homepage: https://api.apis.guru/v2/specs/googleapis.com:cloudsearch/v1.json
Provider: googleapis.com:cloudsearch / cloudsearch
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/googleapis.com/cloudsearch/v1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/googleapis.com/cloudsearch/v1/openapi.yaml

Tools (45)

Extracted live via the executor SDK.

debug.cloudsearchDebugDatasourcesItemsCheckAccess

Checks 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 admin account to execute.
debug.cloudsearchDebugDatasourcesItemsSearchByViewUrl

Fetches the item whose viewUrl exactly matches that of the URL provided in the request. Note: This API requires an admin account to execute.
debug.cloudsearchDebugIdentitysourcesItemsListForunmappedidentity

Lists names of items associated with an unmapped identity. Note: This API requires an admin account to execute.
debug.cloudsearchDebugIdentitysourcesUnmappedidsList

Lists unmapped user identities for an identity source. Note: This API requires an admin account to execute.
indexing.cloudsearchIndexingDatasourcesDeleteSchema

Deletes the schema of a data source. Note: This API requires an admin or service account to execute.
indexing.cloudsearchIndexingDatasourcesGetSchema

Gets the schema of a data source. Note: This API requires an admin or service account to execute.
indexing.cloudsearchIndexingDatasourcesItemsDelete

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 in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsDeleteQueueItems

Deletes 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 is the one whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsGet

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 data source.
indexing.cloudsearchIndexingDatasourcesItemsIndex

Updates 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 values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsList

Lists 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 corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsPoll

Polls 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 ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsPush

Pushes 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 whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsUnreserve

Unreserves 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 restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesItemsUpload

Creates 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 requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
indexing.cloudsearchIndexingDatasourcesUpdateSchema

Updates 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 entire schema. Note: This API requires an admin or service account to execute.
media.cloudsearchMediaUpload

Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be . 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 with the UploadItemRef from step 1. For additional information, see . Note: This API requires a service account to execute.
operations.cloudsearchOperationsGet

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.
operations.cloudsearchOperationsLroList

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
query.cloudsearchQuerySearch

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 .
query.cloudsearchQuerySourcesList

Returns 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 perform Query API requests directly; to use a service account to perform queries, set up .
query.cloudsearchQuerySuggest

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 .
settings.cloudsearchSettingsDatasourcesCreate

Creates a datasource. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsDatasourcesList

Lists datasources. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsGetCustomer

Get customer settings. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsCreate

Creates a search application. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsDelete

Deletes a search application. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsGet

Gets the specified search application. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsList

Lists all search applications. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsPatch

Updates a search application. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsReset

Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsSearchapplicationsUpdate

Updates a search application. Note: This API requires an admin account to execute.
settings.cloudsearchSettingsUpdateCustomer

Update customer settings. Note: This API requires an admin account to execute.
stats.cloudsearchStatsGetIndex

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.
stats.cloudsearchStatsGetQuery

Get the query statistics for customer. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsGetSearchapplication

Get search application stats for customer. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsGetSession

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.
stats.cloudsearchStatsGetUser

Get the users statistics for customer. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsIndexDatasourcesGet

Gets indexed item statistics for a single data source. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsQuerySearchapplicationsGet

Get the query statistics for search application. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsSessionSearchapplicationsGet

Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user account to execute.
stats.cloudsearchStatsUserSearchapplicationsGet

Get the users statistics for search application. Note: This API requires a standard end user account to execute.
v1.cloudsearchInitializeCustomer

Enables third party support in Google Cloud Search. Note: This API requires an admin account to execute.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools