Cloud Search API

Cloud Search предоставляет возможности облачного поиска по данным Google Workspace. Cloud Search API позволяет индексировать данные, не относящиеся к Google Workspace, в Cloud Search.

Сервис: Cloudsearch.googleapis.com.

Для вызова этой службы мы рекомендуем использовать клиентские библиотеки Google. Если вашему приложению необходимо использовать собственные библиотеки для вызова этой службы, используйте следующую информацию при отправке запросов API.

Документ открытия

Документ обнаружения — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов IDE и других инструментов, взаимодействующих с API Google. Одна служба может предоставлять несколько документов обнаружения. Эта служба предоставляет следующий документ обнаружения:

Конечная точка службы

Конечная точка службы — это базовый URL-адрес, указывающий сетевой адрес службы API. Одна служба может иметь несколько конечных точек службы. Эта служба имеет следующую конечную точку службы, и все приведенные ниже URI относятся к этой конечной точке службы:

  • https://cloudsearch.googleapis.com

Ресурс REST: v1

Методы
initializeCustomer POST /v1:initializeCustomer
Включает third party поддержку в Google Cloud Search.

Ресурс REST: v1.debug.datasources.items

Методы
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Проверяет, доступен ли элемент указанному субъекту.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Извлекает элемент, viewUrl которого точно соответствует URL-адресу, указанному в запросе.

Ресурс REST: v1.debug.datasources.items.unmappedids

Методы
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Перечислите все несопоставленные идентификаторы для определенного элемента.

Ресурс REST: v1.debug.identitysources.items

Методы
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Перечисляет имена элементов, связанных с несопоставленным идентификатором.

Ресурс REST: v1.debug.identitysources.unmappedids

Методы
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Перечисляет несопоставленные удостоверения пользователей для источника удостоверений.

Ресурс REST: v1.indexing.datasources

Методы
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
Удаляет схему источника данных.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Получает схему источника данных.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Обновляет схему источника данных.

Ресурс REST: v1.indexing.datasources.items

Методы
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Удаляет Item resource для указанного имени ресурса.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Удаляет все элементы в очереди.
get GET /v1/indexing/{name=datasources/*/items/*}
Получает Item resource по имени элемента.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Обновляет список управления доступом к Item , метаданные и содержимое.
list GET /v1/indexing/{name=datasources/*}/items
Перечисляет все или часть Item resources .
poll POST /v1/indexing/{name=datasources/*}/items:poll
Опрашивает незарезервированные элементы из очереди индексирования и помечает набор как зарезервированный, начиная с элементов, имеющих самую старую временную метку из ItemStatus с наивысшим приоритетом.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Помещает элемент в очередь для последующего опроса и обновления.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Отменяет резервирование всех элементов из очереди, делая их доступными для опроса.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Создает сеанс загрузки для загрузки содержимого элемента.

Ресурс REST: v1.media

Методы
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Загружает медиафайлы для индексации.

Ресурс REST: v1.operations

Методы
get GET /v1/{name=operations/**}
Получает последнее состояние длительной операции.

Ресурс REST: v1.query

Методы
debugSearch POST /v1/query:debugSearch
Возвращает отладочную информацию для Cloud Search Query API предоставляет метод поиска.
removeActivity POST /v1/query:removeActivity
Предоставляет функциональные возможности для удаления зарегистрированных действий пользователя.
search POST /v1/query/search
Cloud Search Query API предоставляет метод поиска, который возвращает наиболее релевантные результаты по пользовательскому запросу.
suggest POST /v1/query/suggest
Предоставляет предложения по автозаполнению запроса.

Ресурс REST: v1.query.sources

Методы
list GET /v1/query/sources
Возвращает список источников, которые пользователь может использовать для API поиска и предложения.

Ресурс REST: v1.settings

Методы
getCustomer GET /v1/settings/customer
Получить настройки клиента.
updateCustomer PATCH /v1/settings/customer
Обновите настройки клиента.

Ресурс REST: v1.settings.datasources

Методы
create POST /v1/settings/datasources
Создает источник данных.
delete DELETE /v1/settings/{name=datasources/*}
Удаляет источник данных.
get GET /v1/settings/{name=datasources/*}
Получает источник данных.
list GET /v1/settings/datasources
Перечисляет источники данных.
patch PATCH /v1/settings/{source.name=datasources/*}
Обновляет источник данных.
update PUT /v1/settings/{source.name=datasources/*}
Обновляет источник данных.

Ресурс REST: v1.settings.searchapplications

Методы
create POST /v1/settings/searchapplications
Создает поисковое приложение.
delete DELETE /v1/settings/{name=searchapplications/*}
Удаляет приложение поиска.
get GET /v1/settings/{name=searchapplications/*}
Получает указанное приложение поиска.
list GET /v1/settings/searchapplications
Перечисляет все поисковые приложения.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Обновляет приложение поиска.
reset POST /v1/settings/{name=searchapplications/*}:reset
Сбрасывает приложение поиска к настройкам по умолчанию.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Обновляет приложение поиска.

Ресурс REST: v1.stats

Методы
getIndex GET /v1/stats/index
Получает статистику индексированных элементов, агрегированную по всем источникам данных.
getQuery GET /v1/stats/query
Получите статистику запросов для клиента.
getSearchapplication GET /v1/stats/searchapplication
Получите статистику поискового приложения для клиента.
getSession GET /v1/stats/session
Получите количество сеансов поиска, % успешных сеансов со статистикой запросов по кликам для клиента.
getUser GET /v1/stats/user
Получите статистику пользователей для клиента.

Ресурс REST: v1.stats.index.datasources

Методы
get GET /v1/stats/index/{name=datasources/*}
Получает статистику индексированных элементов для одного источника данных.

Ресурс REST: v1.stats.query.searchapplications

Методы
get GET /v1/stats/query/{name=searchapplications/*}
Получите статистику запросов для поискового приложения.

Ресурс REST: v1.stats.session.searchapplications

Методы
get GET /v1/stats/session/{name=searchapplications/*}
Получите количество сеансов поиска, % успешных сеансов со статистикой запросов по кликам для поискового приложения.

Ресурс REST: v1.stats.user.searchapplications

Методы
get GET /v1/stats/user/{name=searchapplications/*}
Получите статистику пользователей для поискового приложения.