- HTTP-Anfrage
- Suchparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- QuerySource
- QueryOperator
- QueryOperator.Type
- Testen!
Gibt eine Liste der Quellen zurück, die Nutzer für die query.search- und Suggest-APIs verwenden können.
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
GET https://cloudsearch.googleapis.com/v1/query/sources
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
requestOptions |
Anfrageoptionen wie die Suchanwendung und die Zeitzone des Nutzers |
pageToken |
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 die Liste der Quellen.
JSON-Darstellung |
---|
{
"sources": [
{
object ( |
Felder | |
---|---|
sources[] |
|
nextPageToken |
|
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 ( |
Felder | |
---|---|
source |
Der Name der Quelle |
shortName |
Ein Kurzname oder Alias für die Quelle. Dieser Wert kann mit dem Operator "source" verwendet werden. |
displayName |
Anzeigename der Datenquelle. |
operators[] |
Liste aller Operatoren, die für diese Quelle anwendbar sind. |
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 ( |
Felder | |
---|---|
operatorName |
Der Name des Operators. |
lessThanOperatorName |
Gibt den Operatornamen an, mit dem die Eigenschaft mithilfe des Kleiner-als-Operators isoliert werden kann. |
greaterThanOperatorName |
Gibt den Operatornamen an, mit dem die Eigenschaft mit dem Größer-als-Operator isoliert werden kann. |
type |
Der Typ des Operators. |
displayName |
Anzeigename des Operators |
isSortable |
Kann dieser Operator zum Sortieren von Ergebnissen verwendet werden. |
isFacetable |
Kann dieser Operator verwendet werden, um Attribute abzurufen. |
isReturnable |
Wird die mit diesem Attribut verknüpfte Property als Teil der Suchergebnisse zurückgegeben? |
isRepeatable |
Gibt an, ob für dieses Attribut mehrere Werte festgelegt werden können. |
isSuggestable |
Vorschläge für dieses Feld können abgerufen werden. |
enumValues[] |
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 |
Der Name des Objekts, das dem Operator entspricht. Dieses Feld wird nur für schemaspezifische Operatoren ausgefüllt und ist für gängige Operatoren nicht festgelegt. |
QueryOperator.Type
Der Typ der Eigenschaft, auf die der Operator verweist.
Enums | |
---|---|
UNKNOWN |
Ungültiger Wert. |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |