- HTTP-Anfrage
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- Testen!
Bietet Vorschläge für die automatische Vervollständigung der Abfrage.
Hinweis:Für die Ausführung dieser API ist ein Standard-Endnutzerkonto erforderlich. Ein Dienstkonto kann Query API-Anfragen nicht direkt ausführen. Wenn Sie über ein Dienstkonto Abfragen ausführen möchten, müssen Sie die domainweite Delegierung von Befugnissen 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 ( |
Felder | |
---|---|
requestOptions |
Anfrageoptionen wie die Suchanwendung und die Zeitzone des Nutzers |
query |
Teilanfrage, für die automatisch vervollständigte Vorschläge angezeigt werden. Lautet die Abfrage beispielsweise "sea", gibt der Server möglicherweise "season", "search", "seagull" und so weiter zurück. |
dataSourceRestrictions[] |
Die Quellen, die für Vorschläge verwendet werden sollen. Wenn nichts angegeben ist, werden die Datenquellen aus der aktuellen Suchanwendung übernommen. HINWEIS: Vorschläge werden nur für die folgenden Quellen unterstützt:
|
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Antwort der Suggest API.
JSON-Darstellung |
---|
{
"suggestResults": [
{
object ( |
Felder | |
---|---|
suggestResults[] |
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 ( |
Felder | |
---|---|
suggestedQuery |
Die vorgeschlagene Suchanfrage, die für die Suche verwendet wird, wenn der Nutzer auf den Vorschlag klickt |
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. Wenn zum Beispiel PeopleSuggest vorhanden ist, bedeutet das, dasssuggested_query ein Personenvorschlag ist. Für suggestion ist nur einer der folgenden Werte zulässig: |
|
querySuggestion |
Dieses Feld ist vorhanden, wenn die vorgeschlagene Suchanfrage eine Wort- oder Wortgruppenvervollständigung ist. |
peopleSuggestion |
Diese Option ist vorhanden, wenn der Vorschlag auf eine Person hinweist. Sie enthält weitere Informationen über die Person, z. B. ihre E-Mail-ID, ihren Namen usw. |
QuerySuggestion
Dieses Feld enthält noch nichts und wird lediglich als Indikator dafür verwendet, dass das Vorschlagsergebnis ein abgeschlossener Satz ist.
PeopleSuggestion
Dieses Feld enthält Informationen zu der vorgeschlagenen Person.
JSON-Darstellung |
---|
{
"person": {
object ( |
Felder | |
---|---|
person |
Vorgeschlagene Person. Möglicherweise sind nicht alle Felder des Personenobjekts ausgefüllt. |