Method: query.sources.list

Liste der Quellen zurückgeben, die Nutzer für die Suche und Vorschläge-APIs verwenden können.

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

GET https://cloudsearch.googleapis.com/v1/query/sources

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
requestOptions

object (RequestOptions)

Anfrageoptionen wie die Suchanwendung und die Zeitzone des Nutzers.
pageToken

string

Anzahl der Quellen, die in der Antwort zurückgegeben werden sollen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort der Listenquellen.

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

JSON-Darstellung 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Felder
sources[]

object (QuerySource)
nextPageToken

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.

QuerySource

Liste der Quellen, in denen der Nutzer mithilfe der Abfrage-API suchen kann.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Felder
source

object (Source)

Der Name der Quelle
shortName

string

Ein Kurzname oder Alias für die Quelle. Dieser Wert kann mit dem Operator „source“ verwendet werden.
displayName

string

Der Anzeigename der Datenquelle.
operators[]

object (QueryOperator)

Liste aller für diese Quelle geltenden Operatoren.

QueryOperator

Die Definition eines Operators, der in einer Search/query.suggest-Anfrage verwendet werden kann.

JSON-Darstellung 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
Felder
operatorName

string

Der Name des Betreibers.
lessThanOperatorName

string

Gibt den Namen des Operators an, mit dem die Property mit dem Operator „kleiner als“ isoliert werden kann.
greaterThanOperatorName

string

Gibt den Operatornamen an, mit dem die Property mit dem Operator „Größer als“ isoliert werden kann.
type

enum (QueryOperator.Type)

Der Typ des Betreibers.
displayName

string

Anzeigename des Betreibers
isSortable

boolean

Kann dieser Operator verwendet werden, um Ergebnisse zu sortieren?
isFacetable

boolean

Kann dieser Operator verwendet werden, um Facetten abzurufen?
isReturnable

boolean

Gibt an, ob die mit dieser Facette verknüpfte Property in den Suchergebnissen zurückgegeben wird.
isRepeatable

boolean

Gibt an, ob für dieses Attribut mehrere Werte festgelegt werden können.
isSuggestable

boolean

Für dieses Feld können Vorschläge abgerufen werden.
enumValues[]

string

Mögliche Werte für das Operatorfeld. Dieses Feld wird nur ausgefüllt, wenn wir alle möglichen Werte dieses Operators sicher aufzählen können.
objectType

string

Der Name des Objekts, das dem Operator entspricht. Dieses Feld ist nur für schemaspezifische Operatoren ausgefüllt und für gängige Operatoren nicht festgelegt.

QueryOperator.Type

Der vom Betreiber angegebene Unterkunftstyp.

Enums
UNKNOWN Ungültiger Wert.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML