Method: query.suggest

Bietet Vorschläge für die automatische Vervollständigung der Abfrage.

Hinweis:Für die Ausführung dieser API ist ein Standardendnutzerkonto erforderlich. Ein Dienstkonto kann keine Query API-Anfragen direkt ausführen. Wenn Sie ein Dienstkonto für Abfragen verwenden möchten, müssen Sie die domainweite Delegierung von Berechtigungen in Google Workspace einrichten.

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 automatisch vervollständigte Vorschläge angezeigt werden. Wenn die Suchanfrage beispielsweise „Meer“ lautet, gibt der Server möglicherweise „Saison“, „Suche“ oder „Möwe“ zurück.
dataSourceRestrictions[]

object (DataSourceRestriction)

Die Quellen, die für Vorschläge verwendet werden sollen. Wenn keine Angabe erfolgt, 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 Vorschlagsergebnis.

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 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 Suchanfrage. Außerdem wird der Typ der vorgeschlagenen Abfrage angegeben. Wenn beispielsweise „Personenvorschlag“ vorhanden ist, gibt das an, dass es sich bei „suggested_query“ um einen Personenvorschlag handelt. Für suggestion ist nur einer der folgenden Werte zulässig:
querySuggestion

object (QuerySuggestion)

Dieses Feld ist vorhanden, wenn es sich bei der vorgeschlagenen Suchanfrage um einen Wort-/Phrasen-Ergänzungsvorschlag handelt.
peopleSuggestion

object (PeopleSuggestion)

Dieser Hinweis wird angezeigt, wenn der Vorschlag eine Person betrifft. Es enthält weitere Informationen zur Person, z. B. ihre E-Mail-ID und ihren Namen.

QuerySuggestion

Dieses Feld enthält derzeit nichts und dient nur als Indikator dafür, dass das Vorschlagsergebnis eine Wortvervollständigung 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 Personenobjekts ausgefüllt.