- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- QuerySource
- QueryOperator
- QueryOperator.Type
- Faça um teste
Retorna a lista de origens que o usuário pode usar para as APIs query.search e Suggest.
Observação:para executar essa API, é preciso ter uma conta de usuário final padrão. Uma conta de serviço não pode fazer solicitações da API Query diretamente. Se você quiser usar uma conta de serviço para fazer consultas, configure a delegação de autoridade em todo o domínio do Google Workspace.
Solicitação HTTP
GET https://cloudsearch.googleapis.com/v1/query/sources
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros | |
---|---|
requestOptions |
Opções de solicitação, como o app de pesquisa e o fuso horário do usuário. |
pageToken |
Número de origens a serem retornadas na resposta. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Resposta da lista de origens.
Representação JSON |
---|
{
"sources": [
{
object ( |
Campos | |
---|---|
sources[] |
|
nextPageToken |
|
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
Para mais informações, consulte o Guia de autorização.
QuerySource
Lista de origens que o usuário pode pesquisar usando a API de consulta.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source |
O nome da origem |
shortName |
Um nome curto ou alias para a origem. Esse valor pode ser usado com o operador "source". |
displayName |
Nome de exibição da fonte de dados. |
operators[] |
Lista de todos os operadores aplicáveis a essa fonte. |
QueryOperator
A definição de um operador que pode ser usado em uma solicitação query.search/query.suggest.
Representação JSON |
---|
{
"operatorName": string,
"lessThanOperatorName": string,
"greaterThanOperatorName": string,
"type": enum ( |
Campos | |
---|---|
operatorName |
O nome do operador. |
lessThanOperatorName |
Indica o nome do operador que pode ser usado para isolar a propriedade usando o operador "menor que". |
greaterThanOperatorName |
Indica o nome do operador que pode ser usado para isolar a propriedade usando o operador "maior que". |
type |
O tipo do operador. |
displayName |
Nome de exibição do operador |
isSortable |
Esse operador pode ser usado para classificar resultados? |
isFacetable |
Esse operador pode ser usado para receber atributos? |
isReturnable |
A propriedade associada a este atributo será retornada como parte dos resultados da pesquisa? |
isRepeatable |
Indica se é possível definir vários valores para essa propriedade. |
isSuggestable |
Pode receber sugestões para este campo. |
enumValues[] |
Lista potencial de valores para o campo "Opeatror". Esse campo só é preenchido quando podemos enumerar com segurança todos os valores possíveis desse operador. |
objectType |
O nome do objeto correspondente ao operador. Este campo é preenchido apenas para operadores específicos do esquema e não está definido para operadores comuns. |
QueryOperator.Type
O tipo da propriedade indicada pelo operador.
Enums | |
---|---|
UNKNOWN |
Valor inválido. |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |