Cloud Search API

O Cloud Search oferece recursos de pesquisa baseados na nuvem sobre os 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. 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
de POST /v1:initializeCustomer Ativa o suporte a third party no Google Cloud Search.

Recurso REST: v1.debug.datasources.items

Métodos
checkAccess
de POST /v1/debug/{name=datasources/*/items/*}:checkAccess Verifica se um item pode ser acessado pelo principal especificado.
searchByViewUrl
de 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
de GET /v1/debug/{parent=datasources/*/items/*}/unmappedids Liste todas as identidades não mapeadas de um item específico.

Recurso REST: v1.debug.identitysources.items

Métodos
listForunmappedidentity
de 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
de 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
de DELETE /v1/indexing/{name=datasources/*}/schema Exclui o esquema de uma fonte de dados.
getSchema
de GET /v1/indexing/{name=datasources/*}/schema Recebe o esquema de uma fonte de dados.
updateSchema
de PUT /v1/indexing/{name=datasources/*}/schema Atualiza o esquema de uma fonte de dados.

Recurso REST: v1.indexing.datasources.items

Métodos
delete
de DELETE /v1/indexing/{name=datasources/*/items/*} Exclui Item resource do nome de recurso especificado.
deleteQueueItems
de POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems Exclui todos os itens de uma fila.
get
de GET /v1/indexing/{name=datasources/*/items/*} Recebe Item resource pelo nome do item.
index
de POST /v1/indexing/{item.name=datasources/*/items/*}:index Atualiza a ACL, os metadados e o conteúdo do Item.
list
de GET /v1/indexing/{name=datasources/*}/items Lista todos ou um subconjunto de Item resources.
poll
de 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 pelos itens que têm o carimbo de data/hora mais antigo da ItemStatus de prioridade mais alta.
push
de POST /v1/indexing/{item.name=datasources/*/items/*}:push Envia um item para uma fila para pesquisa e atualização posteriores.
unreserve
de POST /v1/indexing/{name=datasources/*}/items:unreserve Cancela a reserva de todos os itens de uma fila, tornando todos qualificados para pesquisa.
upload
de POST /v1/indexing/{name=datasources/*/items/*}:upload Cria uma sessão para fazer upload do conteúdo do item.

Recurso REST: v1.media

Métodos
upload
de POST /v1/media/{resourceName=**}
de POST /upload/v1/media/{resourceName=**} Faz upload da 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
search
de 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
de POST /v1/query/suggest Fornece sugestões para o preenchimento automático da consulta.

Recurso REST: v1.query.sources

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

Recurso REST: v1.settings

Métodos
getCustomer
de GET /v1/settings/customer Acessar configurações do cliente.
updateCustomer
de PATCH /v1/settings/customer Atualizar as configurações do cliente.

Recurso REST: v1.settings.datasources

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

Recurso REST: v1.settings.searchapplications

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

Recurso REST: v1.stats

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

Recurso REST: v1.stats.index.datasources

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

Recurso REST: v1.stats.session.searchapplications

Métodos
get
de GET /v1/stats/session/{name=searchapplications/*} Obtenha o número de sessões de pesquisa, a porcentagem 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
de GET /v1/stats/user/{name=searchapplications/*} Obter as estatísticas de usuários para o aplicativo de pesquisa.