Method: query.sources.list

Restituisce l'elenco delle origini che l'utente può utilizzare per le API Search e Suggest.

Nota:per l'esecuzione di questa API è necessario un account utente finale standard. Un account di servizio non può eseguire direttamente richieste API di query. Per utilizzare un account di servizio per eseguire query, configura la delega dell'autorità a livello di dominio di Google Workspace.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
requestOptions

object (RequestOptions)

Opzioni di richiesta, ad esempio l'applicazione di ricerca e il fuso orario dell'utente.
pageToken

string

Numero di origini da restituire nella risposta.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per l'elenco delle origini.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Campi
sources[]

object (QuerySource)
nextPageToken

string

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

QuerySource

Elenco delle origini che l'utente può cercare utilizzando l'API di query.

Rappresentazione JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Campi
source

object (Source)

Il nome dell'origine
shortName

string

Un nome breve o un alias per l'origine. Questo valore può essere utilizzato con l'operatore "source".
displayName

string

Nome visualizzato dell'origine dati.
operators[]

object (QueryOperator)

Elenco di tutti gli operatori applicabili a questa origine.

QueryOperator

La definizione di un operatore che può essere utilizzato in una richiesta Search/query.suggest.

Rappresentazione 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
}
Campi
operatorName

string

Il nome dell'operatore.
lessThanOperatorName

string

Indica il nome dell'operatore che può essere utilizzato per isolare la proprietà utilizzando l'operatore minore.
greaterThanOperatorName

string

Indica il nome dell'operatore che può essere utilizzato per isolare la proprietà utilizzando l'operatore maggiore di.
type

enum (QueryOperator.Type)

Il tipo di operatore.
displayName

string

Nome visualizzato dell'operatore
isSortable

boolean

Questo operatore può essere utilizzato per ordinare i risultati.
isFacetable

boolean

Questo operatore può essere utilizzato per ottenere le sfaccettature.
isReturnable

boolean

La proprietà associata a questo facet verrà restituita nei risultati di ricerca.
isRepeatable

boolean

Indica se è possibile impostare più valori per questa proprietà.
isSuggestable

boolean

Può ricevere suggerimenti per questo campo.
enumValues[]

string

Elenco potenziale di valori per il campo operatore. Questo campo viene compilato solo quando possiamo enumerare in sicurezza tutti i valori possibili di questo operatore.
objectType

string

Il nome dell'oggetto corrispondente all'operatore. Questo campo viene compilato solo per gli operatori specifici dello schema e non è impostato per gli operatori comuni.

QueryOperator.Type

Il tipo di proprietà a cui fa riferimento l'operatore.

Enum
UNKNOWN Valore non valido.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML