Method: query.sources.list

Gibt eine Liste der Quellen zurück, die der Nutzer für die Query.search API und die Suggest API verwenden kann.

Hinweis:Zum Ausführen dieser API ist ein standardmäßiges Endnutzerkonto erforderlich. Ein Dienstkonto kann Query API-Anfragen nicht direkt ausführen. Wenn Sie ein Dienstkonto für Abfragen verwenden möchten, richten Sie die domainweite Delegierung von Befugnissen in Google Workspace ein.

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

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

Antwort auf „Quellen auflisten“.

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 mit der Query 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 in Verbindung mit 'Quelle' [source] verwendet werden. .
displayName

string

Anzeigename der Datenquelle.
operators[]

object (QueryOperator)

Liste aller Operatoren, die für diese Quelle gelten.

QueryOperator

Die Definition eines Operators, der in einer query.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 Operators.
lessThanOperatorName

string

Gibt den Operatornamen an, der zum Isolieren der Eigenschaft mit dem Kleiner-als-Operator verwendet werden kann.
greaterThanOperatorName

string

Gibt den Operatornamen an, der zum Isolieren der Eigenschaft mit dem Größer-als-Operator verwendet werden kann.
type

enum (QueryOperator.Type)

Der Typ des Operators.
displayName

string

Anzeigename des Operators
isSortable

boolean

Kann dieser Operator zum Sortieren von Ergebnissen verwendet werden?
isFacetable

boolean

Kann mit diesem Operator Facetten abgerufen werden?
isReturnable

boolean

Wird die mit diesem Attribut verknüpfte Property als Teil der Suchergebnisse zurückgegeben?
isRepeatable

boolean

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

boolean

Kann Vorschläge für dieses Feld erhalten.
enumValues[]

string

Potenzielle Liste von Werten für das Feld „opeatror“. 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 wird nur für schemaspezifische Operatoren ausgefüllt und für häufig verwendete Operatoren nicht konfiguriert.

QueryOperator.Type

Der Typ der Eigenschaft, auf die der Operator verweist.

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