Method: query.suggest

Fornisce suggerimenti per il completamento automatico della query.

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

POST https://cloudsearch.googleapis.com/v1/query/suggest

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Campi
requestOptions

object (RequestOptions)

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

string

Query parziale per la quale verranno visualizzati i suggerimenti di completamento automatico. Ad esempio, se la query è "mare", il server potrebbe restituire "stagione", "ricerca", "gabbiano" e così via.
dataSourceRestrictions[]

object (DataSourceRestriction)

Le origini da utilizzare per i suggerimenti. Se non specificato, le origini dati vengono prese dall'applicazione di ricerca corrente.

NOTA: i suggerimenti sono supportati solo per le seguenti origini:

  • Origini dati di terze parti
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Corpo della risposta

Risposta dell'API suggest.

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

Rappresentazione JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Campi
suggestResults[]

object (SuggestResult)

Elenco di suggerimenti.

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.

SuggestResult

Un risultato del suggerimento.

Rappresentazione JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
Campi
suggestedQuery

string

La query suggerita che verrà utilizzata per la ricerca quando l'utente fa clic sul suggerimento
source

object (Source)

La fonte del suggerimento.
Campo unione suggestion. Contiene metadati aggiuntivi sulla query suggerita. Indica anche il tipo di query suggerita. Ad esempio, se è presente PeopleSuggestion, indica che suggested_query è un suggerimento di persona. suggestion può essere solo uno dei seguenti:
querySuggestion

object (QuerySuggestion)

Questo campo sarà presente se la query suggerita è un completamento di parole/frasi.
peopleSuggestion

object (PeopleSuggestion)

Viene visualizzato quando il suggerimento indica una persona. Contiene ulteriori informazioni sulla persona, ad esempio l'ID indirizzo email, il nome e così via.

QuerySuggestion

Questo tipo non contiene campi.

Al momento questo campo non contiene nulla e viene utilizzato solo come indicatore del fatto che il risultato del suggerimento è stato un completamento di frase.

PeopleSuggestion

Questo campo contiene informazioni sulla persona suggerita.

Rappresentazione JSON 
{
  "person": {
    object (Person)
  }
}
Campi
person

object (Person)

Persona suggerita. Tutti i campi dell'oggetto persona potrebbero non essere compilati.