Method: query.suggest

Bietet Vorschläge zur automatischen Vervollständigung der Abfrage.

Hinweis:Zum Ausführen dieser API ist ein standardmäßiges Endnutzerkonto erforderlich. Ein Dienstkonto kann Query API-Anfragen nicht direkt ausführen. Wenn Sie ein Dienstkonto für Abfragen verwenden möchten, richten Sie die domainweite Delegierung von Befugnissen in Google Workspace ein.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Felder
requestOptions

object (RequestOptions)

Anfrageoptionen wie die Suchanwendung und die Zeitzone des Nutzers
query

string

Teilabfrage, für die Vorschläge zur automatischen Vervollständigung angezeigt werden. Wenn die Suchanfrage beispielsweise „sea“ lautet, gibt der Server möglicherweise „season“, „search“, „seagull“ zurück und so weiter.
dataSourceRestrictions[]

object (DataSourceRestriction)

Die Quellen, die für Vorschläge verwendet werden sollen. Wenn nicht angegeben, werden die Datenquellen aus der aktuellen Suchanwendung übernommen.

HINWEIS: Vorschläge werden nur für die folgenden Quellen unterstützt:

  • Datenquellen von Drittanbietern
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Antwort der Suggest API.

JSON-Darstellung 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Felder
suggestResults[]

object (SuggestResult)

Liste der Vorschläge.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

SuggestResult

Ein Vorschlag.

JSON-Darstellung 
{
  "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.
}
Felder
suggestedQuery

string

Die vorgeschlagene Suchanfrage, die für die Suche verwendet wird, wenn der Nutzer auf den Vorschlag klickt
source

object (Source)

Die Quelle des Vorschlags.
Union-Feld suggestion. Enthält zusätzliche Metadaten zur vorgeschlagenen Abfrage. Außerdem wird der Typ der vorgeschlagenen Abfrage angegeben. Beispiel: Wenn PeopleSuggestion vorhanden ist, bedeutet dies, dass „suggested_query“ ein Personenvorschlag ist. Für suggestion ist nur einer der folgenden Werte zulässig:
querySuggestion

object (QuerySuggestion)

Dieses Feld ist vorhanden, wenn die vorgeschlagene Suchanfrage eine Vervollständigung von Wörtern/Wortgruppen ist.
peopleSuggestion

object (PeopleSuggestion)

Dieses Element ist vorhanden, wenn der Vorschlag auf eine Person hinweist. Es enthält weitere Informationen über die Person, wie ihre E-Mail-ID, ihren Namen usw.

QuerySuggestion

Dieses Feld enthält zum jetzigen Zeitpunkt nichts und wird nur als Indikator dafür verwendet, dass das Vorschlagsergebnis eine Vervollständigung einer Wortgruppe war.

PeopleSuggestion

Dieses Feld enthält Informationen zur vorgeschlagenen Person.

JSON-Darstellung 
{
  "person": {
    object (Person)
  }
}
Felder
person

object (Person)

Vorgeschlagene Person. Möglicherweise sind nicht alle Felder des Objekts „Person“ ausgefüllt.