Method: query.debugSearch

Gibt Debug-Informationen für die Cloud Search-Abfrage zurück, die die Suchmethode bereitstellt.

Hinweis:Für die Ausführung dieser API ist ein Standardendnutzerkonto erforderlich. Ein Dienstkonto kann keine Abfrage-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:debugSearch

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Felder
requestOptions

object (RequestOptions)

Anfrageoptionen wie die Suchanwendung und die Zeitzone des Nutzers.
query

string

Der Rohabfragestring. Informationen zu unterstützten Suchoperatoren finden Sie unter Suche mit Operatoren eingrenzen.
pageSize

integer

Maximale Anzahl der Suchergebnisse, die auf einer Seite zurückgegeben werden sollen. Gültige Werte liegen zwischen 1 und 100. Der Standardwert ist 10. Der Mindestwert beträgt 50, wenn mehr als 2.000 Ergebnisse angefordert werden.
start

integer

Startindex der Ergebnisse.
dataSourceRestrictions[]

object (DataSourceRestriction)

Die Quellen, die für die Abfrage verwendet werden sollen. Wenn nichts angegeben ist, werden alle Datenquellen aus der aktuellen Suchanwendung verwendet.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Optionen zum Sortieren der Suchergebnisse
queryInterpretationOptions

object (QueryInterpretationOptions)

Optionen zur Interpretation der Nutzerabfrage.
contextAttributes[]

object (ContextAttribute)

Kontextattribute für die Anfrage, die zum Anpassen des Rankings der Suchergebnisse verwendet werden. Die maximale Anzahl von Elementen ist 10.

Antworttext

Fehlerbehebung bei der Antwort von query.search

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

JSON-Darstellung 
{
  "searchResponse": {
    object (SearchResponse)
  },
  "gsrRequest": string,
  "gsrResponse": string
}
Felder
searchResponse

object (SearchResponse)

Query.search-Antwort.
gsrRequest

string (bytes format)

Serialisierter String von „GenericSearchRequest“.

Ein base64-codierter String.
gsrResponse

string (bytes format)

Serialisierter String von „GenericSearchResponse“.

Ein base64-codierter String.

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.