- Richiesta HTTP
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- Prova!
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 le richieste API 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 ( |
Campi | |
---|---|
requestOptions |
Opzioni di richiesta, come l'applicazione di ricerca e il fuso orario dell'utente. |
query |
Query parziale per cui verranno mostrati i suggerimenti di completamento automatico. Ad esempio, se la query è "mare", il server potrebbe restituire "stagione", "ricerca", "gabbiano" e così via. |
dataSourceRestrictions[] |
Le fonti da utilizzare per i suggerimenti. Se non specificato, le origini dati vengono recuperate dall'applicazione di ricerca corrente. NOTA: i suggerimenti sono supportati solo per le seguenti fonti:
|
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Risposta dell'API di suggerimento.
Rappresentazione JSON |
---|
{
"suggestResults": [
{
object ( |
Campi | |
---|---|
suggestResults[] |
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 di suggerimento.
Rappresentazione JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
Campi | |
---|---|
suggestedQuery |
La query suggerita che verrà utilizzata per la ricerca quando l'utente fa clic sul suggerimento |
source |
L'origine del suggerimento. |
Campo unione suggestion . Contiene metadati aggiuntivi sulla query suggerita. Indica anche il tipo di query suggerita. Ad es. Se è presente PeopleSuggestion, questo indica che la query suggerita è un suggerimento di una persona. suggestion può essere solo uno dei seguenti: |
|
querySuggestion |
Questo campo sarà presente se la query suggerita è un completamento di parola/frase. |
peopleSuggestion |
È presente quando il suggerimento indica una persona. Contiene ulteriori informazioni sulla persona, come l'ID email, il nome e così via. |
QuerySuggestion
Questo campo non contiene niente al momento e viene solo utilizzato per indicare che il risultato del suggerimento è il completamento di una frase.
PeopleSuggestion
Questo campo contiene informazioni sulla persona suggerita.
Rappresentazione JSON |
---|
{
"person": {
object ( |
Campi | |
---|---|
person |
Persona suggerita. Potrebbero non essere compilati tutti i campi dell'oggetto persona. |