Cloud Search API

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

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

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

Документ об обнаружении

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

конечная точка сервиса

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

  • https://cloudsearch.googleapis.com

REST-ресурс: версия 1

Методы
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
Обновляет списки контроля доступа (ACL), метаданные и содержимое 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

Методы
removeActivity POST /v1/query:removeActivity
Предоставляет функциональность для удаления зарегистрированных действий пользователя.
search POST /v1/query/search
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/*}
Получите статистику пользователей для поискового приложения.