Method: query.sources.list

Retorna a lista de fontes que o usuário pode usar para as APIs Search e Suggest.

Observação:essa API exige uma conta de usuário final padrão para ser executada. Uma conta de serviço não pode executar solicitações de API de consulta diretamente. Para usar uma conta de serviço para executar 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

object (RequestOptions)

Opções de solicitação, como o aplicativo de pesquisa e o fuso horário do usuário.
pageToken

string

Número de origens a serem retornadas na resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta da lista de origens.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Campos
sources[]

object (QuerySource)
nextPageToken

string

Escopos de autorização

Requer um dos seguintes escopos do 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 (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Campos
source

object (Source)

O nome da origem
shortName

string

Um nome curto ou alias para a origem. Esse valor pode ser usado com o operador "source".
displayName

string

Nome de exibição da fonte de dados.
operators[]

object (QueryOperator)

Lista de todos os operadores aplicáveis a essa origem.

QueryOperator

A definição de um operador que pode ser usado em uma solicitação Search/query.suggest.

Representação JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
Campos
operatorName

string

O nome do operador.
lessThanOperatorName

string

Indica o nome do operador que pode ser usado para isolar a propriedade usando o operador menor que.
greaterThanOperatorName

string

Indica o nome do operador que pode ser usado para isolar a propriedade usando o operador "maior que".
type

enum (QueryOperator.Type)

O tipo do operador.
displayName

string

Nome de exibição do operador
isSortable

boolean

Esse operador pode ser usado para classificar os resultados?
isFacetable

boolean

Esse operador pode ser usado para receber facetas.
isReturnable

boolean

Indica se a propriedade associada a esse atributo será retornada como parte dos resultados da pesquisa.
isRepeatable

boolean

Indica se vários valores podem ser definidos para essa propriedade.
isSuggestable

boolean

Pode receber sugestões para este campo.
enumValues[]

string

Lista de valores possíveis para o campo "opeatror". Esse campo só é preenchido quando podemos enumerar com segurança todos os valores possíveis desse operador.
objectType

string

O nome do objeto correspondente ao operador. Esse campo é preenchido apenas para operadores específicos do esquema e não é 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