Method: query.sources.list

Muestra una lista de las fuentes que el usuario puede usar para las APIs de query.search y Sugerir.

Nota: Para ejecutarse esta API, se requiere una cuenta de usuario final estándar. Una cuenta de servicio no puede realizar solicitudes a la API de Query directamente. Si quieres usar una cuenta de servicio para realizar consultas, debes configurar la delegación de autoridad de todo el dominio de Google Workspace.

Solicitud HTTP

GET https://cloudsearch.googleapis.com/v1/query/sources

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
requestOptions

object (RequestOptions)

Opciones de solicitud, como la aplicación de búsqueda y la zona horaria del usuario
pageToken

string

Cantidad de fuentes que se muestran en la respuesta.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Respuesta de la fuente de la lista.

Representación JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Campos
sources[]

object (QuerySource)
nextPageToken

string

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Para obtener más información, consulta la guía de autorización.

QuerySource

Lista de fuentes que el usuario puede buscar con la API de consulta.

Representación JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Campos
source

object (Source)

El nombre de la fuente
shortName

string

Es un nombre corto o alias para la fuente. Este valor se puede usar con el operador "source".
displayName

string

Es el nombre visible de la fuente de datos.
operators[]

object (QueryOperator)

Es la lista de todos los operadores aplicables a esta fuente.

QueryOperator

La definición de un operador que se puede usar en una solicitud query.search/query.suggest.

Representación 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

Es el nombre del operador.
lessThanOperatorName

string

Indica el nombre del operador que se puede usar para aislar la propiedad con el operador menor que.
greaterThanOperatorName

string

Indica el nombre del operador que se puede usar para aislar la propiedad con el operador mayor que.
type

enum (QueryOperator.Type)

Es el tipo del operador.
displayName

string

Nombre visible del operador
isSortable

boolean

¿Se puede usar este operador para ordenar los resultados?
isFacetable

boolean

¿Se puede usar este operador para obtener facetas?
isReturnable

boolean

¿Se mostrará la propiedad asociada con esta faceta como parte de los resultados de la búsqueda?
isRepeatable

boolean

Indica si se pueden configurar varios valores para esta propiedad.
isSuggestable

boolean

Puede obtener sugerencias para este campo.
enumValues[]

string

Lista potencial de valores para el campo opeatror. Este campo solo se completa cuando podemos enumerar de manera segura todos los valores posibles de este operador.
objectType

string

El nombre del objeto que corresponde al operador. Este campo solo se completa para los operadores específicos de esquema y no se establece para los operadores comunes.

QueryOperator.Type

Es el tipo de propiedad al que hace referencia el operador.

Enumeradores
UNKNOWN El valor no es válido.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML