Cloud Search API

O Cloud Search fornece recursos de pesquisa baseados em nuvem sobre dados do Google Workspace. A API Cloud Search permite a indexação de dados que não são do Google Workspace no Cloud Search.

Serviço: cloudsearch.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google . Se seu aplicativo precisar usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir ao fazer as solicitações de API.

Documento de descoberta

Um Documento de Descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins de IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço fornece o seguinte documento de descoberta:

Ponto de extremidade de serviço

Um endpoint de serviço é uma URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários terminais de serviço. Este serviço tem o seguinte endpoint de serviço e todos os URIs abaixo são relativos a este endpoint de serviço:

  • https://cloudsearch.googleapis.com

Recurso REST: v1

Métodos
initializeCustomer POST /v1:initializeCustomer
Ativa o suporte de third party no Google Cloud Search.

Recurso REST: v1.debug.datasources.items

Métodos
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Verifica se um item é acessível pelo principal especificado.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Busca o item cujo viewUrl corresponde exatamente ao URL fornecido na solicitação.

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

Métodos
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Liste todas as identidades não mapeadas para um item específico.

Recurso REST: v1.debug.identitysources.items

Métodos
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Lista nomes de itens associados a uma identidade não mapeada.

Recurso REST: v1.debug.identitysources.unmappedids

Métodos
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Lista identidades de usuário não mapeadas para uma origem de identidade.

Recurso REST: v1.indexing.datasources

Métodos
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
Exclui o esquema de uma fonte de dados.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Obtém o esquema de uma fonte de dados.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Atualiza o esquema de uma fonte de dados.

Recurso REST: v1.indexing.datasources.items

Métodos
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Exclui o Item resource para o nome do recurso especificado.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Exclui todos os itens em uma fila.
get GET /v1/indexing/{name=datasources/*/items/*}
Obtém Item resource por nome do item.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Atualiza a ACL do Item , metadados e conteúdo.
list GET /v1/indexing/{name=datasources/*}/items
Lista todos ou um subconjunto de Item resources .
poll POST /v1/indexing/{name=datasources/*}/items:poll
Pesquisa itens não reservados da fila de indexação e marca um conjunto como reservado, começando com os itens que têm o carimbo de data/hora mais antigo do ItemStatus de prioridade mais alta.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Envia um item para uma fila para pesquisa e atualização posteriores.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Cancela a reserva de todos os itens de uma fila, tornando-os todos elegíveis para pesquisa.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Cria uma sessão de upload para carregar o conteúdo do item.

Recurso REST: v1.media

Métodos
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Carrega mídia para indexação.

Recurso REST: v1.operations

Métodos
get GET /v1/{name=operations/**}
Obtém o estado mais recente de uma operação de longa duração.

Recurso REST: v1.query

Métodos
search POST /v1/query/search
A API de consulta do Cloud Search fornece o método de pesquisa, que retorna os resultados mais relevantes de uma consulta do usuário.
suggest POST /v1/query/suggest
Fornece sugestões para o preenchimento automático da consulta.

Recurso REST: v1.query.sources

Métodos
list GET /v1/query/sources
Retorna uma lista de fontes que o usuário pode usar para APIs de pesquisa e sugestão.

Recurso REST: v1.settings

Métodos
getCustomer GET /v1/settings/customer
Obtenha as configurações do cliente.
updateCustomer PATCH /v1/settings/customer
Atualize as configurações do cliente.

Recurso REST: v1.settings.datasources

Métodos
create POST /v1/settings/datasources
Cria uma fonte de dados.
delete DELETE /v1/settings/{name=datasources/*}
Exclui uma fonte de dados.
get GET /v1/settings/{name=datasources/*}
Obtém uma fonte de dados.
list GET /v1/settings/datasources
Lista fontes de dados.
update PUT /v1/settings/{source.name=datasources/*}
Atualiza uma fonte de dados.

Recurso REST: v1.settings.searchapplications

Métodos
create POST /v1/settings/searchapplications
Cria um aplicativo de pesquisa.
delete DELETE /v1/settings/{name=searchapplications/*}
Exclui um aplicativo de pesquisa.
get GET /v1/settings/{name=searchapplications/*}
Obtém o aplicativo de pesquisa especificado.
list GET /v1/settings/searchapplications
Lista todos os aplicativos de pesquisa.
reset POST /v1/settings/{name=searchapplications/*}:reset
Redefine um aplicativo de pesquisa para as configurações padrão.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Atualiza um aplicativo de pesquisa.

Recurso REST: v1.stats

Métodos
getIndex GET /v1/stats/index
Obtém estatísticas de itens indexados agregadas em todas as fontes de dados.
getQuery GET /v1/stats/query
Obtenha as estatísticas de consulta para o cliente.
getSearchapplication GET /v1/stats/searchapplication
Obtenha estatísticas do aplicativo de pesquisa para o cliente.
getSession GET /v1/stats/session
Obtenha o número de sessões de pesquisa, % de sessões bem-sucedidas com estatísticas de consulta de cliques para o cliente.
getUser GET /v1/stats/user
Obtenha as estatísticas dos usuários para o cliente.

Recurso REST: v1.stats.index.datasources

Métodos
get GET /v1/stats/index/{name=datasources/*}
Obtém estatísticas de itens indexados para uma única fonte de dados.

Recurso REST: v1.stats.query.searchapplications

Métodos
get GET /v1/stats/query/{name=searchapplications/*}
Obtenha as estatísticas de consulta para o aplicativo de pesquisa.

Recurso REST: v1.stats.session.searchapplications

Métodos
get GET /v1/stats/session/{name=searchapplications/*}
Obtenha o número de sessões de pesquisa, % de sessões bem-sucedidas com estatísticas de consulta de clique para o aplicativo de pesquisa.

Recurso REST: v1.stats.user.searchapplications

Métodos
get GET /v1/stats/user/{name=searchapplications/*}
Obtenha as estatísticas dos usuários para o aplicativo de pesquisa.