Cloud Search API

Cloud Search proporciona funciones de búsqueda basadas en la nube sobre los datos de Google Workspace. La API de Cloud Search permite indexar datos que no son de Google Workspace en Cloud Search.

Servicio: cloudsearch.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información siguiente cuando realices las solicitudes a la API.

Documento de descubrimiento

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona el documento de descubrimiento siguiente:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://cloudsearch.googleapis.com

Recurso de REST: v1

Métodos
initializeCustomer POST /v1:initializeCustomer
Habilita la compatibilidad con third party en Google Cloud Search.

Recurso de REST: v1.debug.datasources.items

Métodos
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Comprueba si un elemento es accesible para la principal especificada.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Recupera el elemento cuya URL de vista coincide exactamente con la URL proporcionada en la solicitud.

Recurso de REST: v1.debug.datasources.items.unmappedids

Métodos
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Enumera todas las identidades no asignadas para un artículo específico.

Recurso de REST: v1.debug.identitysources.items

Métodos
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Enumera los nombres de los elementos asociados con una identidad no asignada.

Recurso de REST: v1.debug.identitysources.unmappedids

Métodos
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Enumera las identidades de usuario no asignadas para una fuente de identidad.

Recurso de REST: v1.indexing.datasources

Métodos
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
Borra el esquema de una fuente de datos.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Obtiene el esquema de una fuente de datos.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Actualiza el esquema de una fuente de datos.

Recurso de REST: v1.indexing.datasources.items

Métodos
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Borra Item resource para el nombre del recurso especificado.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Borra todos los elementos de una cola.
get GET /v1/indexing/{name=datasources/*/items/*}
Obtiene Item resource por nombre de elemento.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Actualiza la Item LCA, los metadatos y el contenido.
list GET /v1/indexing/{name=datasources/*}/items
Enumera todos los elementos de Item resources o un subconjunto de ellos.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Sondea los elementos sin reservar de la cola de indexación y marca un conjunto como reservado, comenzando con los elementos que tienen la marca de tiempo más antigua del ItemStatus de mayor prioridad.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Envía un elemento a una cola para su posterior consulta y actualización.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Quita la reserva de todos los elementos de una cola, lo que los hace aptos para ser consultados.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Crea una sesión de carga para subir contenido de elementos.

Recurso de REST: v1.media

Métodos
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Sube contenido multimedia para la indexación.

Recurso de REST: v1.operations

Métodos
get GET /v1/{name=operations/**}
Obtiene el último estado de una operación de larga duración.

Recurso de REST: v1.query

Métodos
removeActivity POST /v1/query:removeActivity
Proporciona la funcionalidad para quitar la actividad registrada de un usuario.
search POST /v1/query/search
La API de Cloud Search Query proporciona el método de búsqueda, que devuelve los resultados más relevantes de una consulta del usuario.
suggest POST /v1/query/suggest
Proporciona sugerencias para autocompletar la búsqueda.

Recurso de REST: v1.query.sources

Métodos
list GET /v1/query/sources
Devuelve una lista de fuentes que el usuario puede usar para las APIs de Search y Suggest.

Recurso de REST: v1.settings

Métodos
getCustomer GET /v1/settings/customer
Obtiene la configuración del cliente.
updateCustomer PATCH /v1/settings/customer
Actualiza la configuración del cliente.

Recurso de REST: v1.settings.datasources

Métodos
create POST /v1/settings/datasources
Crea una fuente de datos.
delete DELETE /v1/settings/{name=datasources/*}
Borra una fuente de datos.
get GET /v1/settings/{name=datasources/*}
Obtiene una fuente de datos.
list GET /v1/settings/datasources
Enumera las fuentes de datos.
patch PATCH /v1/settings/{source.name=datasources/*}
Actualiza una fuente de datos.
update PUT /v1/settings/{source.name=datasources/*}
Actualiza una fuente de datos.

Recurso de REST: v1.settings.searchapplications

Métodos
create POST /v1/settings/searchapplications
Crea una aplicación de búsqueda.
delete DELETE /v1/settings/{name=searchapplications/*}
Borra una aplicación de búsqueda.
get GET /v1/settings/{name=searchapplications/*}
Obtiene la aplicación de búsqueda especificada.
list GET /v1/settings/searchapplications
Enumera todas las aplicaciones de búsqueda.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Actualiza una aplicación de búsqueda.
reset POST /v1/settings/{name=searchapplications/*}:reset
Restablece la configuración predeterminada de una aplicación de búsqueda.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Actualiza una aplicación de búsqueda.

Recurso de REST: v1.stats

Métodos
getIndex GET /v1/stats/index
Obtiene estadísticas de elementos indexados agregadas en todas las fuentes de datos.
getQuery GET /v1/stats/query
Obtén las estadísticas de la búsqueda para el cliente.
getSearchapplication GET /v1/stats/searchapplication
Obtiene estadísticas de la aplicación de búsqueda para el cliente.
getSession GET /v1/stats/session
Obtén la cantidad de sesiones de búsqueda y el porcentaje de sesiones exitosas con estadísticas de consultas con clics para el cliente.
getUser GET /v1/stats/user
Obtén las estadísticas de los usuarios del cliente.

Recurso de REST: v1.stats.index.datasources

Métodos
get GET /v1/stats/index/{name=datasources/*}
Obtiene las estadísticas de los elementos indexados para una sola fuente de datos.

Recurso de REST: v1.stats.query.searchapplications

Métodos
get GET /v1/stats/query/{name=searchapplications/*}
Obtén las estadísticas de búsqueda de la aplicación de búsqueda.

Recurso de REST: v1.stats.session.searchapplications

Métodos
get GET /v1/stats/session/{name=searchapplications/*}
Obtén la cantidad de sesiones de búsqueda y el porcentaje de sesiones exitosas con estadísticas de consultas con clics para la aplicación de búsqueda.

Recurso de REST: v1.stats.user.searchapplications

Métodos
get GET /v1/stats/user/{name=searchapplications/*}
Obtén las estadísticas de los usuarios para la aplicación de búsqueda.