SearchResponse

Die Antwort der Search API. NÄCHSTE ID: 17

JSON-Darstellung 
{
  "queryInterpretation": {
    object (QueryInterpretation)
  },
  "results": [
    {
      object (SearchResult)
    }
  ],
  "structuredResults": [
    {
      object (StructuredResult)
    }
  ],
  "spellResults": [
    {
      object (SpellResult)
    }
  ],
  "facetResults": [
    {
      object (FacetResult)
    }
  ],
  "hasMoreResults": boolean,
  "debugInfo": {
    object (ResponseDebugInfo)
  },
  "errorInfo": {
    object (ErrorInfo)
  },
  "resultCounts": {
    object (ResultCounts)
  },

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
Felder
queryInterpretation

object (QueryInterpretation)

Ergebnis der Abfrageauswertung für die Nutzerabfrage. Leer, wenn die Abfrageauswertung deaktiviert ist.
results[]

object (SearchResult)

Ergebnisse einer Suchanfrage.
structuredResults[]

object (StructuredResult)

Strukturierte Ergebnisse für die Nutzerabfrage. Diese Ergebnisse werden nicht auf die pageSize angerechnet.
spellResults[]

object (SpellResult)

Vorgeschlagene Schreibweise für die Suchanfrage.
facetResults[]

object (FacetResult)

Wiederholte Attributergebnisse.
hasMoreResults

boolean

Gibt an, ob es weitere Suchergebnisse gibt, die der Suchanfrage entsprechen.
debugInfo

object (ResponseDebugInfo)

Informationen zur Fehlerbehebung bei der Antwort.
errorInfo

object (ErrorInfo)

Fehlerinformationen zur Antwort.
resultCounts

object (ResultCounts)

Maximierte Informationen zur Ergebnisanzahl.

Union-Feld result_count. Die Gesamtzahl der Ergebnisse aller angeforderten Datenquellen. Wird weggelassen, wenn vordefinierte Quellen in den abgefragten Datenquellen enthalten sind. In den folgenden Fällen werden die Ergebnisse möglicherweise als Schätzung statt als genaue Anzahl zurückgegeben:

  • Wenn die Suchanfrage mehr als zwei Begriffe in einer Wortgruppe enthält, z. B. „exakte Ergebnisanzahl“ in Anführungszeichen.

  • Wenn die Anzahl der zu bewertenden eindeutigen ACLs für Suchergebnisse zu groß ist, um sie innerhalb einer angemessenen Latenz zu berechnen.

Sollte das System in seltenen Fällen nicht alle Dokumente durchsuchen können, führen Sie die Abfrage noch einmal aus. Für result_count ist nur einer der folgenden Werte zulässig:
resultCountEstimate

string (int64 format)

Die geschätzte Anzahl der Ergebnisse für diese Abfrage.
resultCountExact

string (int64 format)

Die genaue Anzahl der Ergebnisse für diese Abfrage.

QueryInterpretation

JSON-Darstellung 
{
  "interpretedQuery": string,
  "interpretationType": enum (QueryInterpretation.InterpretationType),
  "reason": enum (QueryInterpretation.Reason),
  "interpretedQueryActualResultCount": integer,
  "interpretedQueryEstimatedResultCount": string
}
Felder
interpretedQuery

string

Die Interpretation der Suchanfrage. Suchanfragen mit natürlicher Sprache wie „E-Mail von Max“ werden beispielsweise als „from:max source:mail“ interpretiert. Dieses Feld wird nicht ausgefüllt, wenn der Grund NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY ist.
interpretationType

enum (QueryInterpretation.InterpretationType)
reason

enum (QueryInterpretation.Reason)

Der Grund für die Interpretation der Anfrage. Dieses Feld hat nicht den Wert „UNBESCHRIEBEN“, wenn der Interpretationstyp nicht „NONE“ ist.
interpretedQueryActualResultCount

integer

Die tatsächliche Anzahl der Ergebnisse, die von der interpretierten Abfrage zurückgegeben wurden.
interpretedQueryEstimatedResultCount

string (int64 format)

Die geschätzte Anzahl der Ergebnisse, die von der interpretierten Abfrage zurückgegeben werden.

QueryInterpretation.InterpretationType

Enums
NONE Weder die Interpretation in natürlicher Sprache noch eine allgemeinere Version der Suchanfrage werden verwendet, um die Suchergebnisse abzurufen.
BLEND Die Ergebnisse der ursprünglichen Abfrage werden mit anderen Ergebnissen kombiniert. Der Grund für die Zusammenführung dieser anderen Ergebnisse mit den Ergebnissen der ursprünglichen Abfrage wird unten im Feld „Grund“ angegeben.
REPLACE Die Ergebnisse der ursprünglichen Abfrage werden ersetzt. Der Grund für das Ersetzen der Ergebnisse aus der ursprünglichen Abfrage wird unten im Feld „Grund“ angegeben.

QueryInterpretation.Reason

Enums
UNSPECIFIED
QUERY_HAS_NATURAL_LANGUAGE_INTENT Die Suchergebnisse werden anhand der Interpretation der Suchanfrage in natürlicher Sprache abgerufen.
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY Die Ähnlichkeit von Suchanfrage und Dokumentbegriffen wird verwendet, um die Suchanfrage selektiv zu erweitern und so zusätzliche Suchergebnisse abzurufen, da für die Suchanfrage des Nutzers nicht genügend Ergebnisse gefunden wurden. Die interpretierte Abfrage ist in diesem Fall leer.

SearchResult

Ergebnisse mit indexierten Informationen für ein Dokument.

JSON-Darstellung 
{
  "title": string,
  "url": string,
  "snippet": {
    object (Snippet)
  },
  "metadata": {
    object (Metadata)
  },
  "clusteredResults": [
    {
      object (SearchResult)
    }
  ],
  "debugInfo": {
    object (ResultDebugInfo)
  }
}
Felder
title

string

Titel des Suchergebnisses.
url

string

Die URL des Suchergebnisses. Die URL enthält eine Google-Weiterleitung zum eigentlichen Artikel. Diese URL ist signiert und sollte nicht geändert werden.
snippet

object (Snippet)

Die Konkatenierung aller für dieses Ergebnis verfügbaren Snippets (Zusammenfassungen).
metadata

object (Metadata)

Metadaten des Suchergebnisses.
clusteredResults[]

object (SearchResult)

Wenn die Quelle geclustert ist, geben Sie eine Liste der geclusterten Ergebnisse an. Es gibt nur eine Ebene mit geclusterten Ergebnissen. Wenn die aktuelle Quelle nicht für das Clustern aktiviert ist, ist dieses Feld leer.
debugInfo

object (ResultDebugInfo)

Informationen zur Fehlerbehebung für dieses Suchergebnis.

Snippet

Snippet des Suchergebnisses, in dem der Inhalt der Ergebnisseite zusammengefasst wird.

JSON-Darstellung 
{
  "snippet": string,
  "matchRanges": [
    {
      object (MatchRange)
    }
  ]
}
Felder
snippet

string

Das Snippet des Dokuments. Kann maskierte HTML-Zeichen enthalten, die vor dem Rendern entkommentiert werden müssen.
matchRanges[]

object (MatchRange)

Die übereinstimmenden Bereiche im Snippet.

MatchRange

Übereinstimmender Bereich eines Snippets [start, end].

JSON-Darstellung 
{
  "start": integer,
  "end": integer
}
Felder
start

integer

Startposition der Übereinstimmung im Snippet.
end

integer

Ende der Übereinstimmung im Snippet.

Metadaten

Metadaten eines übereinstimmenden Suchergebnisses.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "mimeType": string,
  "thumbnailUrl": string,
  "owner": {
    object (Person)
  },
  "createTime": string,
  "updateTime": string,
  "fields": [
    {
      object (NamedProperty)
    }
  ],
  "displayOptions": {
    object (ResultDisplayMetadata)
  },
  "objectType": string
}
Felder
source

object (Source)

Die benannte Quelle für das Ergebnis, z. B. Gmail.
mimeType

string

MIME-Typ des Suchergebnisses.
thumbnailUrl

string

Die Thumbnail-URL des Ergebnisses.
owner

object (Person)

Eigentümer (in der Regel Ersteller) des Dokuments oder Objekts des Suchergebnisses.
createTime

string (Timestamp format)

Der Erstellungszeitpunkt dieses Dokuments oder Objekts im Suchergebnis.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Das Datum der letzten Änderung des Objekts im Suchergebnis. Wenn der Wert im Artikel nicht festgelegt ist, ist der hier zurückgegebene Wert leer. Wenn updateTime für die Berechnung der Aktualität verwendet wird und nicht festgelegt ist, wird standardmäßig der Wert „2 Jahre nach der aktuellen Zeit“ verwendet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
fields[]

object (NamedProperty)

Indexierte Felder in strukturierten Daten, die als generische benannte Property zurückgegeben werden.
displayOptions

object (ResultDisplayMetadata)

Optionen, die festlegen, wie ein Suchergebnis mit strukturierten Daten angezeigt wird.
objectType

string

Der Objekttyp des Suchergebnisses.

ResultDisplayMetadata

JSON-Darstellung 
{
  "objectTypeLabel": string,
  "metalines": [
    {
      object (ResultDisplayMetadata.ResultDisplayLine)
    }
  ]
}
Felder
objectTypeLabel

string

Das Anzeigelabel für das Objekt.
metalines[]

object (ResultDisplayMetadata.ResultDisplayLine)

Der Inhalt der Metazeilen, der mit dem Ergebnis angezeigt werden soll.

ResultDisplayMetadata.ResultDisplayLine

Die Sammlung von Feldern, aus denen eine angezeigte Zeile besteht

JSON-Darstellung 
{
  "fields": [
    {
      object (ResultDisplayMetadata.ResultDisplayField)
    }
  ]
}
Felder
fields[]

object (ResultDisplayMetadata.ResultDisplayField)

ResultDisplayMetadata.ResultDisplayField

Felder für Suchergebnisse anzeigen

JSON-Darstellung 
{
  "label": string,
  "operatorName": string,
  "property": {
    object (NamedProperty)
  }
}
Felder
label

string

Das Anzeigelabel für die Property.
operatorName

string

Der Name des Betreibers der Unterkunft.
property

object (NamedProperty)

Das Name/Wert-Paar für die Property.

ResultDebugInfo

Informationen zur Fehlerbehebung beim Ergebnis.

JSON-Darstellung 
{
  "formattedDebugInfo": string
}
Felder
formattedDebugInfo

string

Allgemeine Informationen zur Fehlerbehebung, die für die Anzeige formatiert sind.

StructuredResult

Strukturierte Ergebnisse, die im Rahmen einer Suchanfrage zurückgegeben werden.

JSON-Darstellung 
{

  // Union field structured_result can be only one of the following:
  "person": {
    object (Person)
  }
  // End of list of possible types for union field structured_result.
}
Felder

Union-Feld structured_result.

Für structured_result ist nur einer der folgenden Werte zulässig:
person

object (Person)

Darstellung einer Person

SpellResult

JSON-Darstellung 
{
  "suggestedQuery": string,
  "suggestionType": enum (SpellResult.SuggestionType),
  "suggestedQueryHtml": {
    object (SafeHtmlProto)
  }
}
Felder
suggestedQuery

string

Die vorgeschlagene Schreibweise der Suchanfrage.
suggestionType

enum (SpellResult.SuggestionType)

Vorschlag, der für die aktuelle Abfrage ausgelöst wurde.
suggestedQueryHtml

object (SafeHtmlProto)

Der bereinigte HTML-Code, der die korrigiert geschriebene Suchanfrage darstellt und in der Benutzeroberfläche verwendet werden kann. Dieser enthält in der Regel sprachspezifische Tags, um Teile der Suchanfrage zu kennzeichnen, die einer Rechtschreibprüfung unterzogen werden.

SpellResult.SuggestionType

Der Vorschlagstyp, der für die Suchanfrage ausgelöst wurde.

Enums
SUGGESTION_TYPE_UNSPECIFIED Standardtyp der Rechtschreibprüfung
NON_EMPTY_RESULTS_SPELL_SUGGESTION Rechtschreibvorschlag ohne Änderungen an den Ergebnissen Die Ergebnisse für die ursprüngliche Suchanfrage (mit einer Anzahl von Ergebnissen ungleich null) werden weiterhin angezeigt, zusammen mit einem Vorschlag für eine Schreibweise, mit der Ergebnisse erzielt werden können.
ZERO_RESULTS_FULL_PAGE_REPLACEMENT Die Rechtschreibvorschläge werden ausgelöst, wenn die ursprüngliche Suchanfrage keine Ergebnisse liefert. Wenn für die ursprüngliche Suchanfrage keine Ergebnisse gefunden werden, aber für die Rechtschreibvorschläge Ergebnisse vorliegen, werden Ergebnisse für die korrigierte Suchanfrage ausgelöst.

SafeHtmlProto

WICHTIG: Es ist unsicher, diese Nachricht von einer nicht vertrauenswürdigen Quelle anzunehmen, da es für einen Angreifer trivial ist, serialisierte Nachrichten zu fälschen, die nicht dem Sicherheitsvertrag des Typs entsprechen. Sie könnten beispielsweise ein von einem Angreifer kontrolliertes Script enthalten. Ein System, das ein SafeHtmlProto empfängt, vertraut dem Erzeuger des SafeHtmlProto implizit. Daher ist es in der Regel sicher, diese Nachricht in RPC-Antworten zurückzugeben, aber in der Regel nicht sicher, sie in RPC-Anfragen zu akzeptieren.

JSON-Darstellung 
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Felder
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

WICHTIG: Dieses Feld darf nicht festgelegt oder gelesen werden, auch nicht in Tests. Es ist privat. In der Dokumentation oben in der .proto-Datei finden Sie Informationen zu Programmiersprachenpaketen, mit denen diese Nachricht erstellt oder gelesen werden kann.

FacetResult

Quellspezifische Antwort für Facetten

JSON-Darstellung 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ]
}
Felder
sourceName

string

Name der Quelle, für die die Ergebnisse zurückgegeben werden. Dieses Feld darf nicht leer sein.
objectType

string

Der Objekttyp, für den Attributergebnisse zurückgegeben werden. Darf leer sein.
operatorName

string

Der Name des Operators, der für die Facetten ausgewählt wurde. @see cloudsearch.SchemaPropertyOptions
buckets[]

object (FacetBucket)

FacetBuckets für Werte in der Antwort, die mindestens ein Ergebnis mit dem entsprechenden Filter enthalten.

FacetBucket

Ein Bucket in einer Facette ist die grundlegende Einheit. Ein Bucket kann je nach Feldtyp entweder einen einzelnen Wert ODER einen zusammenhängenden Wertebereich enthalten. FacetBucket wird derzeit nur zum Zurückgeben des Antwortobjekts verwendet.

JSON-Darstellung 
{
  "count": integer,
  "percentage": integer,
  "filter": {
    object (Filter)
  },

  // Union field bucket_value can be only one of the following:
  "value": {
    object (Value)
  }
  // End of list of possible types for union field bucket_value.
}
Felder
count

integer

Anzahl der Ergebnisse, die mit dem Bucket-Wert übereinstimmen. Die Anzahl der Ergebnisse wird nur für Suchanfragen zurückgegeben, wenn die Genauigkeit der Anzahl gewährleistet ist. Cloud Search kann die Anzahl der Facetten für keine Abfrage garantieren. Die Anzahl der Facetten ist möglicherweise nur sporadisch verfügbar, auch bei identischen Abfragen. Legen Sie keine Abhängigkeiten von der Existenz der Facettenanzahl fest. Verwenden Sie stattdessen Prozentsätze für die Facettenanzahl, die immer zurückgegeben werden.
percentage

integer

Prozentsatz der Ergebnisse, die mit dem Bucket-Wert übereinstimmen. Der Rückgabewert liegt zwischen 0 und 100 und wird bei Dezimalwerten auf eine Ganzzahl abgerundet. Wenn der Wert nicht explizit zurückgegeben wird, entspricht er einem Prozentsatz, der auf 0 gerundet wird. Prozentsätze werden für alle Suchanfragen zurückgegeben, sind aber nur eine Schätzung. Da immer Prozentsätze zurückgegeben werden, sollten Sie Prozentsätze anstelle von Stückzahlen verwenden.
filter

object (Filter)

Filter, der in der Suchanfrage übergeben wird, wenn der entsprechende Bucket ausgewählt ist.
Union-Feld bucket_value. Der Bereich oder Wert des Buckets, der facettiert ist, kann nur einer der folgenden sein:bucket_value
value

object (Value)

ResponseDebugInfo

Informationen zur Fehlerbehebung bei der Antwort.

JSON-Darstellung 
{
  "formattedDebugInfo": string
}
Felder
formattedDebugInfo

string

Allgemeine Informationen zur Fehlerbehebung, die für die Anzeige formatiert sind.

Fehlerinformation

Fehlerinformationen zur Antwort.

JSON-Darstellung 
{
  "errorMessages": [
    {
      object (ErrorMessage)
    }
  ]
}
Felder
errorMessages[]

object (ErrorMessage)

ErrorMessage

Fehlermeldung pro Antwort der Quelle.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "errorMessage": string
}
Felder
source

object (Source)
errorMessage

string

ResultCounts

Informationen zur Ergebnisanzahl

JSON-Darstellung 
{
  "sourceResultCounts": [
    {
      object (SourceResultCount)
    }
  ]
}
Felder
sourceResultCounts[]

object (SourceResultCount)

Informationen zur Ergebnisanzahl für jede Quelle mit Ergebnissen.

SourceResultCount

Informationen zur Anzahl der Ergebnisse pro Quelle.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "hasMoreResults": boolean,

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
Felder
source

object (Source)

Die Quelle, der die Informationen zur Ergebnisanzahl zugeordnet sind.
hasMoreResults

boolean

Gibt an, ob es weitere Suchergebnisse für diese Quelle gibt.

Union-Feld result_count.

Für result_count ist nur einer der folgenden Werte zulässig:
resultCountEstimate

string (int64 format)

Die geschätzte Anzahl der Ergebnisse für diese Quelle.
resultCountExact

string (int64 format)

Die genaue Anzahl der Ergebnisse für diese Quelle.