Cloud Search API

O Cloud Search oferece recursos de pesquisa baseados na nuvem nos dados do Google Workspace. A API Cloud Search permite a indexação de dados de outros serviços no Cloud Search.

Serviço: cloudsearch.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da 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 IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:

Endpoint de serviço

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

  • https://cloudsearch.googleapis.com

Recurso REST: v1

Métodos
initializeCustomer POST /v1:initializeCustomer
Ativa o suporte a 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 pode ser acessado pelo principal especificado.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Busca o item cujo viewUrl corresponde exatamente ao do URL fornecido na solicitação.

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

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

Recurso REST: v1.debug.identitysources.items

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

Recurso REST: v1.debug.identitysources.unmappedids

Métodos
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Lista as 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
Recebe 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 Item resource para o nome do recurso especificado.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Exclui todos os itens de uma fila.
get GET /v1/indexing/{name=datasources/*/items/*}
Encontra Item resource pelo nome do item.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Atualiza a ACL, os metadados e o conteúdo de Item.
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 na 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 da 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 qualificados para pesquisa.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Cria uma sessão de upload para fazer upload do conteúdo do item.

Recurso REST: v1.media

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

Recurso REST: v1.operations

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

Recurso REST: v1.query

Métodos
debugSearch POST /v1/query:debugSearch
Retorna informações de depuração para a API Cloud Search Query que fornece o método de pesquisa.
removeActivity POST /v1/query:removeActivity
Oferece a funcionalidade de remover a atividade registrada de um usuário.
search POST /v1/query/search
A API Cloud Search Query fornece o método de pesquisa, que retorna os resultados mais relevantes de uma consulta do usuário.
suggest POST /v1/query/suggest
Oferece sugestões para o preenchimento automático da consulta.

Recurso REST: v1.query.sources

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

Recurso REST: v1.settings

Métodos
getCustomer GET /v1/settings/customer
Receba 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/*}
Recebe uma fonte de dados.
list GET /v1/settings/datasources
Lista as origens de dados.
patch PATCH /v1/settings/{source.name=datasources/*}
Atualiza uma origem de dados.
update PUT /v1/settings/{source.name=datasources/*}
Atualiza uma origem de dados.

Recurso REST: v1.settings.searchapplications

Métodos
create POST /v1/settings/searchapplications
Cria um app de pesquisa.
delete DELETE /v1/settings/{name=searchapplications/*}
Exclui um app de pesquisa.
get GET /v1/settings/{name=searchapplications/*}
Recebe o aplicativo de pesquisa especificado.
list GET /v1/settings/searchapplications
Lista todos os aplicativos de pesquisa.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Atualiza um app 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 app de pesquisa.

Recurso REST: v1.stats

Métodos
getIndex GET /v1/stats/index
Recebe estatísticas de itens indexados agregadas em todas as fontes de dados.
getQuery GET /v1/stats/query
Confira as estatísticas de consulta do cliente.
getSearchapplication GET /v1/stats/searchapplication
Receber estatísticas de apps de pesquisa do cliente.
getSession GET /v1/stats/session
Receba o número de sessões de pesquisa e a porcentagem de sessões bem-sucedidas com estatísticas de consulta de cliques para o cliente.
getUser GET /v1/stats/user
Receba as estatísticas dos usuários do cliente.

Recurso REST: v1.stats.index.datasources

Métodos
get GET /v1/stats/index/{name=datasources/*}
Recebe 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/*}
Confira as estatísticas de consulta do aplicativo de pesquisa.

Recurso REST: v1.stats.session.searchapplications

Métodos
get GET /v1/stats/session/{name=searchapplications/*}
Receba o número de sessões de pesquisa e a porcentagem de sessões bem-sucedidas com estatísticas de consulta de cliques para o aplicativo de pesquisa.

Recurso REST: v1.stats.user.searchapplications

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