Schema

Die Schemadefinition für eine Datenquelle.

JSON-Darstellung 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Felder
objectDefinitions[]

object (ObjectDefinition)

Die Liste der Objekte auf oberster Ebene für die Datenquelle. Die maximale Anzahl von Elementen ist 10.
operationIds[]

string

IDs der derzeit für dieses Schema ausgeführten lang andauernden Vorgänge. Warten Sie nach dem Ändern des Schemas, bis die Vorgänge abgeschlossen sind, bevor Sie weitere Inhalte indexieren.

ObjectDefinition

Die Definition eines Objekts in einer Datenquelle.

JSON-Darstellung 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Felder
name

string

Der Name des Objekts, der seinen Typ definiert. Bei Anfragen zur Artikelindexierung sollte das Feld objectType auf diesen Wert gesetzt werden. Wenn name beispielsweise Document ist, sollte objectType in Indexierungsanfragen für Elemente vom Typ „Dokument“ auf Document gesetzt werden. Jede Objektdefinition muss innerhalb eines Schemas einen eindeutigen Namen haben. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Ziffern (0–9) enthalten. Die maximale Länge beträgt 256 Zeichen.
options

object (ObjectOptions)

Die optionalen objektspezifischen Optionen.
propertyDefinitions[]

object (PropertyDefinition)

Die Property-Definitionen für das Objekt. Die maximale Anzahl von Elementen ist 1.000.

ObjectOptions

Die Optionen für ein Objekt.

JSON-Darstellung 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Felder
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Die Aktualitätsoptionen für ein Objekt.
displayOptions

object (ObjectDisplayOptions)

Mit diesen Optionen wird festgelegt, wie das Objekt auf der Cloud Search-Ergebnisseite angezeigt wird.
suggestionFilteringOperators[]

string

Operatoren, mit denen Vorschläge gefiltert werden können. Bei der query.suggest API werden nur die hier genannten Betreiber in der FilterOptions berücksichtigt. Es werden nur die Operatoren TEXT und ENUM unterstützt.

HINWEIS: „objecttype“, „type“ und „mimetype“ werden bereits unterstützt. Mit dieser Property werden schemaspezifische Operatoren konfiguriert.

Auch wenn es sich um ein Array handelt, kann nur ein Operator angegeben werden. Dies ist ein Array für zukünftige Erweiterungen.

Operatoren, die mehreren Properties innerhalb desselben Objekts zugeordnet sind, werden nicht unterstützt. Wenn der Operator verschiedene Objekttypen umfasst, muss diese Option einmal für jede Objektdefinition festgelegt werden.

ObjectOptions.FreshnessOptions

Gibt an, welche Aktualitätseigenschaft beim Anpassen des Suchrankings für ein Element verwendet werden soll. Je aktueller die Daten sind, desto höher ist die Qualität. Verwenden Sie die Option für die Datenaktualität, die am besten zu Ihren Daten passt. Bei Dokumenten in einer Dateifreigabe ist der Zeitpunkt der letzten Änderung am relevantesten. Bei Kalenderereignisdaten ist der Zeitpunkt des Ereignisses ein relevanterer Aktualitätshinweis. So werden Kalendertermine, die näher am Zeitpunkt der Suchanfrage liegen, als qualitativ höherwertig eingestuft und entsprechend bewertet.

JSON-Darstellung 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Felder
freshnessProperty

string

Diese Eigenschaft gibt den Aktualitätsgrad des Objekts im Index an. Wenn diese Property festgelegt ist, muss sie eine Property auf oberster Ebene innerhalb der property definitions sein und timestamp type oder date type sein. Andernfalls verwendet die Indexing API updateTime als Frischeindikator. Die maximale Länge beträgt 256 Zeichen.

Wenn eine Property zur Berechnung der Aktualität verwendet wird, wird standardmäßig der Wert „2 Jahre ab der aktuellen Zeit“ verwendet.
freshnessDuration

string (Duration format)

Die Dauer, nach der ein Objekt als veraltet betrachtet werden soll. Der Standardwert beträgt 180 Tage (in Sekunden).

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

ObjectDisplayOptions

Die Anzeigeoptionen für ein Objekt.

JSON-Darstellung 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Felder
objectDisplayLabel

string

Das nutzerfreundliche Label, das im Suchergebnis angezeigt wird, um den Typ des Artikels anzugeben. Optional. Wenn Sie kein Objektlabel angeben, wird in der Kontextzeile der Suchergebnisse kein Objektlabel angezeigt. Die maximale Länge beträgt 64 Zeichen.
metalines[]

object (ObjectDisplayOptions.Metaline)

Hiermit werden die Eigenschaften definiert, die in den Metazeilen der Suchergebnisse angezeigt werden. Die Attributwerte werden in der hier angegebenen Reihenfolge angezeigt. Wenn eine Property mehrere Werte enthält, werden alle Werte vor den nächsten Properties angezeigt. Aus diesem Grund sollten Sie in dieser Liste einzelne Properties vor wiederholten Properties angeben. Bei allen Properties muss isReturnable auf „true“ gesetzt sein. Es sind maximal 3 Metazeilen zulässig.

ObjectDisplayOptions.Metaline

Eine Metazeile ist eine Liste von Unterkünften, die zusammen mit dem Suchergebnis angezeigt werden, um Kontext zu bieten.

JSON-Darstellung 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Felder
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Die Liste der angezeigten Eigenschaften für das Metametall. Es sind maximal 5 Unterkünfte zulässig.

ObjectDisplayOptions.DisplayedProperty

Ein Verweis auf eine Property auf oberster Ebene innerhalb des Objekts, die in den Suchergebnissen angezeigt werden soll. Die Werte der ausgewählten Unterkünfte werden in den Suchergebnissen zusammen mit dem display label für die jeweilige Unterkunft angezeigt, sofern angegeben. Wenn kein Anzeigelabel angegeben ist, werden nur die Werte angezeigt.

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

string

Der Name der Property auf oberster Ebene, wie in einer Property-Definition für das Objekt angegeben. Wenn der Name keine definierte Eigenschaft im Schema ist, wird beim Aktualisieren des Schemas ein Fehler ausgegeben.

PropertyDefinition

Die Definition einer Property innerhalb eines Objekts.

JSON-Darstellung 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
Felder
name

string

Der Name der Unterkunft. Bei Anfragen zur Artikelindexierung, die an die Indexing API gesendet werden, sollte property name auf diesen Wert festgelegt sein. Wenn der Name beispielsweise subject_line lautet, sollte in Indexierungsanfragen für Dokumentelemente mit Betrefffeldern name für dieses Feld auf subject_line festgelegt werden. Verwenden Sie den Namen als Kennung für die Objekteigenschaft. Nachdem ein Name als Property für ein Objekt registriert wurde, kann er nicht mehr für eine andere Property innerhalb dieses Objekts verwendet werden. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Ziffern (0–9) enthalten. Die maximale Länge beträgt 256 Zeichen.
isReturnable

boolean

Gibt an, dass mit dem jeweiligen Attribut Daten identifiziert werden, die in Suchergebnissen über die Query API zurückgegeben werden sollten. Wenn diese Option auf true gesetzt ist, können Nutzer der Query API übereinstimmende Property-Felder in den Ergebnissen verwenden. Das Speichern von Feldern erfordert jedoch mehr Speicherplatz und nutzt mehr Bandbreite für Suchanfragen, was sich auf die Leistung bei großen Datenmengen auswirkt. Legen Sie hier nur dann true fest, wenn das Feld für Suchergebnisse erforderlich ist. Kann nicht für Attribute des Typs „Objekt“ festgelegt werden.
isRepeatable

boolean

Gibt an, dass für die Property mehrere Werte zulässig sind. Ein Dokument hat beispielsweise nur eine Beschreibung, kann aber mehrere Kommentare enthalten. Kann nicht für Attribute des Typs „Boolescher Wert“ verwendet werden. Wenn dieser Parameter auf „false“ gesetzt ist, werden Indexierungsanfragen für Elemente mit mehr als einem Wert abgelehnt.
isSortable

boolean

Gibt an, dass das Attribut als Kriterium für die Sortierung verwenden kann. Dies kann nicht für Attribute gelten, die wiederholbar sind. Kann nicht für Attribute des Typs „Objekt“ festgelegt werden. „IsReturnable“ muss auf „true“ festgelegt sein, damit diese Option verwendet werden kann. Nur für boolesche, Datums-, Doppel-, Ganzzahl- und Zeitstempeleigenschaften unterstützt.
isFacetable

boolean

Gibt an, dass das Attribut zum Generieren von Facetten verwendet werden kann. Kann nicht für Attribute des Typs „Objekt“ festgelegt werden. „IsReturnable“ muss auf „true“ festgelegt sein, damit diese Option verwendet werden kann. Nur für boolesche, enum-, Ganzzahl- und Texteigenschaften unterstützt.
isSuggestable

boolean

Gibt an, dass das Attribut verwendet werden kann, um Suchanfragevorschläge zu generieren.
isWildcardSearchable

boolean

Gibt an, dass Nutzer eine Platzhaltersuche für diese Property durchführen können. Nur für Texteigenschaften unterstützt. „IsReturnable“ muss auf „true“ festgelegt sein, damit diese Option verwendet werden kann. In einer bestimmten Datenquelle können maximal fünf Properties als „istWildcardSearchable“ gekennzeichnet werden. Weitere Informationen finden Sie unter Objekteigenschaften definieren.
displayOptions

object (PropertyDisplayOptions)

Mit diesen Optionen wird festgelegt, wie das Attribut in den Cloud Search-Ergebnisseiten angezeigt wird, wenn es im display options des Objekts angezeigt werden soll.
Union-Feld property_options. Die typspezifischen Optionen, die festlegen, wie die Property indexiert und verwendet wird. Auch wenn die Optionen die Standardoptionen für einen Typ sein sollen, muss dieses Feld auf einen der Typen festgelegt sein. Wenn dieses Feld nicht festgelegt ist, werden Schemaupdates abgelehnt. Für property_options ist nur einer der folgenden Werte zulässig:
integerPropertyOptions

object (IntegerPropertyOptions)
doublePropertyOptions

object (DoublePropertyOptions)
timestampPropertyOptions

object (TimestampPropertyOptions)
booleanPropertyOptions

object (BooleanPropertyOptions)
objectPropertyOptions

object (ObjectPropertyOptions)
enumPropertyOptions

object (EnumPropertyOptions)
datePropertyOptions

object (DatePropertyOptions)
textPropertyOptions

object (TextPropertyOptions)
htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

Die Optionen für Ganzzahleigenschaften.

JSON-Darstellung 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Felder
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Hiermit wird das Ranking für die Ganzzahl angegeben. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
minimumValue

string (Int64Value format)

Der Mindestwert der Property. Anhand der Mindest- und Höchstwerte für das Attribut werden die Ergebnisse nach dem ordered ranking sortiert. Indexierungsanfragen mit Werten unter dem Mindestwert werden akzeptiert und mit demselben Gewicht wie Elemente bewertet, die mit dem Mindestwert indexiert wurden.
maximumValue

string (Int64Value format)

Der Maximalwert der Property. Anhand der Mindest- und Höchstwerte für das Attribut werden die Ergebnisse nach dem ordered ranking sortiert. Indexierungsanfragen mit Werten, die über dem Maximum liegen, werden akzeptiert und mit demselben Gewicht wie Elemente bewertet, die mit dem Höchstwert indexiert wurden.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Wenn festgelegt, wird beschrieben, wie die Ganzzahl als Suchoperator verwendet werden soll.
integerFacetingOptions

object (IntegerFacetingOptions)

Wenn festgelegt, werden Optionen für die Ganzzahlfacettierung für die angegebene Ganzzahleigenschaft beschrieben. Die entsprechende Ganzzahleigenschaft sollte als „ist facettierbar“ gekennzeichnet sein.

IntegerPropertyOptions.OrderedRanking

Hiermit wird angegeben, wie ein Ganzzahlwert im Vergleich zu anderen Werten eingestuft werden soll. Eine Ganzzahl mit einem höheren Rang weist auf eine größere Wichtigkeit hin. In einigen Datenquellen bedeutet eine niedrigere Priorität beispielsweise eine höhere Wichtigkeit, während in anderen eine höhere Priorität eine höhere Wichtigkeit bedeutet.

Enums
NO_ORDER Es gibt keine Rangfolge für die Unterkunft. Die Ergebnisse werden nicht anhand des Werts dieser Property angepasst.
ASCENDING Diese Property wird in aufsteigender Reihenfolge sortiert. Je niedriger der Wert, desto niedriger das Ranking.
DESCENDING Diese Property wird in absteigender Reihenfolge sortiert. Je niedriger der Wert, desto höher das Ranking.

IntegerPropertyOptions.IntegerOperatorOptions

Wird verwendet, um einen Suchoperator für Ganzzahleigenschaften anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

JSON-Darstellung 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Felder
operatorName

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die Ganzzahleigenschaft zu isolieren. Wenn beispielsweise „operatorName“ priority und der Name der Property priorityVal ist, werden bei Suchanfragen wie priority:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property priorityVal mit <value> übereinstimmt. Bei einer Suche, bei der derselbe <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger String-Properties oder Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
lessThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Ganzzahleigenschaft mit dem Operator „kleiner als“ zu isolieren. Wenn beispielsweise „lessThanOperatorName“ prioritybelow und der Name der Property priorityVal ist, werden bei Suchanfragen wie prioritybelow:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property priorityVal kleiner als <value> ist. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
greaterThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Ganzzahleigenschaft mit dem Operator „Größer als“ zu isolieren. Wenn beispielsweise „greaterThanOperatorName“ priorityabove und der Name der Property priorityVal ist, werden bei Suchanfragen wie priorityabove:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property priorityVal größer als <value> ist. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

DoublePropertyOptions

Die Optionen für doppelte Unterkünfte.

JSON-Darstellung 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Felder
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Wenn festgelegt, wird beschrieben, wie das Doppelte als Suchoperator verwendet werden soll.

DoublePropertyOptions.DoubleOperatorOptions

Wird verwendet, um einen Suchoperator für doppelte Unterkünfte anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

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

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die Doppeleigenschaft bei der Sortierung oder als Facette zu verwenden. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

TimestampPropertyOptions

Die Optionen für Zeitstempelattribute.

JSON-Darstellung 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Felder
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Wenn festgelegt, wird beschrieben, wie der Zeitstempel als Suchoperator verwendet werden soll.

TimestampPropertyOptions.TimestampOperatorOptions

Wird verwendet, um einen Suchoperator für Zeitstempeleigenschaften anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

JSON-Darstellung 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Felder
operatorName

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um das Zeitstempelattribut zu isolieren. Wenn der OperatorName beispielsweise closedon und der Name der Property closeDate ist, werden bei Suchanfragen wie closedon:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property closeDate mit <value> übereinstimmt. Bei einer Suche, bei der derselbe Wert <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger String-Properties oder Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
lessThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Zeitstempeleigenschaft mit dem Operator „kleiner als“ zu isolieren. Wenn der Name des „lessThanOperator“ beispielsweise closedbefore und der Name der Property closeDate ist, werden bei Suchanfragen wie closedbefore:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property closeDate vor <value> liegt. Der Name des Operators darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
greaterThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Zeitstempeleigenschaft mit dem Operator „Größer als“ zu isolieren. Wenn beispielsweise „greaterThanOperatorName“ closedafter und der Name der Property closeDate ist, werden bei Suchanfragen wie closedafter:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property closeDate nach <value> liegt. Der Name des Operators darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

BooleanPropertyOptions

Die Optionen für boolesche Properties.

JSON-Darstellung 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Felder
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Wenn festgelegt, wird beschrieben, wie der boolesche Wert als Suchoperator verwendet werden soll.

BooleanPropertyOptions.BooleanOperatorOptions

Wird verwendet, um einen Suchoperator für boolesche Properties anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

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

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die boolesche Eigenschaft zu isolieren. Wenn der Operatorname beispielsweise closed und der Name der Property isClosed ist, werden bei Suchanfragen wie closed:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property isClosed mit <value> übereinstimmt. Bei einer Suche, bei der derselbe <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger String-Properties oder Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

ObjectPropertyOptions

Die Optionen für Objektattribute.

JSON-Darstellung 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Felder
subobjectProperties[]

object (PropertyDefinition)

Die Eigenschaften des untergeordneten Objekts. Diese Properties stellen ein verschachteltes Objekt dar. Wenn diese Property beispielsweise eine Postanschrift darstellt, könnten die SubobjectProperties street, city und state heißen. Die maximale Anzahl von Elementen ist 1.000.

EnumPropertyOptions

Die Optionen für enum-Properties, mit denen Sie eine eingeschränkte Anzahl von Strings definieren können, die mit Nutzerabfragen übereinstimmen, Rankings für diese Stringwerte festlegen und einen Operatornamen definieren können, der mit diesen Strings verknüpft wird, damit Nutzer die Ergebnisse auf Elemente mit einem bestimmten Wert eingrenzen können. Für Elemente in einem Anfrage-Tracking-System mit Prioritätsinformationen können Sie beispielsweise p0 als zulässigen Enum-Wert definieren und diesen Enum mit dem Operatornamen priority verknüpfen. So können Suchende ihrer Suchanfrage priority:p0 hinzufügen, um die Ergebnisse auf die Elemente einzuschränken, die mit dem Wert p0 indexiert sind.

JSON-Darstellung 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Felder
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Die Liste der möglichen Werte für das Aufzählungsattribut. Alle EnumValuePairs müssen einen Stringwert angeben. Wenn Sie für einen EnumValuePair einen Ganzzahlwert angeben, müssen alle möglichen EnumValuePairs einen Ganzzahlwert angeben. Sowohl der Stringwert als auch der Ganzzahlwert müssen für alle möglichen Werte eindeutig sein. Mögliche Werte können nach der Festlegung nicht mehr entfernt oder geändert werden. Wenn Sie eine sortierte Rangfolge angeben und der Meinung sind, dass Sie in Zukunft weitere Enum-Werte einfügen könnten, lassen Sie Lücken zwischen den ursprünglichen Ganzzahlwerten, damit Sie einen Wert zwischen zuvor registrierten Werten hinzufügen können. Die maximale Anzahl von Elementen ist 100.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Hiermit wird das Ranking für die Aufzählung festgelegt, das bestimmt, wie die Ganzzahlwerte in den möglichen EnumValuePairs zum Sortieren der Ergebnisse verwendet werden. Falls angegeben, müssen für alle möglichen EnumValuePair-Werte, die für diese Property angegeben sind, Ganzzahlwerte angegeben werden. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Wenn festgelegt, wird beschrieben, wie das Enum als Suchoperator verwendet werden soll.

EnumPropertyOptions.EnumValuePair

Das Paar aus Aufzählungswerten definiert zwei Dinge: einen erforderlichen Stringwert und einen optionalen Ganzzahlwert. Der Stringwert definiert den erforderlichen Suchbegriff, der zum Abrufen dieses Elements erforderlich ist, z. B. p0 für ein Element mit Priorität. Der Ganzzahlwert bestimmt das Ranking dieses Stringwerts im Vergleich zu anderen aufgezählten Werten für dieselbe Property. Sie können beispielsweise p0 mit 0 verknüpfen und ein anderes Enum-Paar wie p1 und 1 definieren. Sie müssen den Ganzzahlwert in Kombination mit ordered ranking verwenden, um das Ranking eines bestimmten Werts im Vergleich zu anderen aufgezählten Werten für denselben Property-Namen festzulegen. Hier führt eine absteigende Rangfolge für priority-Properties zu einem höheren Ranking für Elemente, die mit dem Wert p0 indexiert sind, im Vergleich zu Elementen, die mit dem Wert p1 indexiert sind. Ohne eine angegebene Rangfolge hat der Ganzzahlwert keine Auswirkungen auf das Artikelranking.

JSON-Darstellung 
{
  "stringValue": string,
  "integerValue": integer
}
Felder
stringValue

string

Der Stringwert des EnumValuePair. Die maximale Länge beträgt 32 Zeichen.
integerValue

integer

Der Ganzzahlwert des EnumValuePair, der nicht negativ sein darf. Optional.

EnumPropertyOptions.OrderedRanking

Gibt die Sortierrichtung für eine Ganzzahl vom Typ EnumValuePair im Vergleich zu anderen Ganzzahlwerten vom Typ „EnumValuePair“ an. Bei einigen Properties weisen niedrigere Ganzzahlwerte auf eine höhere Wichtigkeit hin, bei anderen ist es umgekehrt.

Enums
NO_ORDER Es gibt keine Rangfolge für die Unterkunft. Die Ergebnisse werden nicht anhand des Werts dieser Property angepasst.
ASCENDING Diese Property wird in aufsteigender Reihenfolge sortiert. Je niedriger der Wert, desto niedriger das Ranking.
DESCENDING Diese Property wird in absteigender Reihenfolge sortiert. Je niedriger der Wert, desto höher das Ranking.

EnumPropertyOptions.EnumOperatorOptions

Wird verwendet, um einen Suchoperator für enum-Properties anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind. Wenn Sie beispielsweise keinen Operator für ein enum-Attribut priority mit den möglichen Werten p0 und p1 angeben, werden mit einer Abfrage, die den Begriff p0 enthält, Elemente zurückgegeben, die p0 als Wert des Attributs priority haben, sowie alle Elemente, die den String p0 in anderen Feldern enthalten. Wenn Sie einen Operatornamen für die Enum-Liste angeben, z. B. priority, können Suchende mit der Abfrage priority:p0 die Ergebnisse auf Elemente beschränken, die p0 als Wert für diese Property haben.

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

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die enum-Eigenschaft zu isolieren. Wenn beispielsweise „operatorName“ priority und der Name der Property priorityVal ist, werden bei Suchanfragen wie priority:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property priorityVal mit <value> übereinstimmt. Bei einer Suche, bei der derselbe <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger String-Properties oder Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

DatePropertyOptions

Die Optionen für Datumseigenschaften.

JSON-Darstellung 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Felder
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Gibt an, wie das Datum als Suchoperator verwendet werden soll.

DatePropertyOptions.DateOperatorOptions

Optional. Bietet einen Suchoperator für Datumseigenschaften. Mit query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

JSON-Darstellung 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Felder
operatorName

string

Gibt den tatsächlichen String an, der in der Abfrage erforderlich ist, um das Datumsattribut zu isolieren. Angenommen, ein Schemaobjekt für das Problem-Tracking hat ein Attribut namens closeDate, das einen Operator mit dem Operatornamen closedon angibt. Bei Suchanfragen in diesen Daten werden mit Abfragen wie closedon:<value> nur Ergebnisse zurückgegeben, bei denen der Wert des Attributs closeDate mit <value> übereinstimmt. Bei einer Suche, bei der derselbe <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger String-Attribute oder des Texts im Inhaltsfeld der indexierten Datenquelle übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
lessThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Datumseigenschaft mit dem Operator „kleiner als“ zu isolieren. Wenn der Name des „kleiner-als-Bedieners“ beispielsweise closedbefore und der Name der Property closeDate ist, werden bei Suchanfragen wie closedbefore:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property closeDate vor <value> liegt. Der Name des Operators darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
greaterThanOperatorName

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Datumseigenschaft mit dem Operator „Größer als“ zu isolieren. Wenn beispielsweise „greaterThanOperatorName“ closedafter und der Name der Property closeDate ist, werden bei Suchanfragen wie closedafter:<value> nur Ergebnisse angezeigt, bei denen der Wert der Property closeDate nach <value> liegt. Der Name des Operators darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

TextPropertyOptions

Die Optionen für Texteigenschaften.

JSON-Darstellung 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Felder
retrievalImportance

object (RetrievalImportance)

Gibt an, wie wichtig die Tokens im Feld für die Suchqualität sind, wenn sie für die Suche verwendet werden.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Wenn festgelegt, wird beschrieben, wie die Property als Suchoperator verwendet werden soll.

RetrievalImportance

JSON-Darstellung 
{
  "importance": enum (RetrievalImportance.Importance)
}
Felder
importance

enum (RetrievalImportance.Importance)

Gibt die Ranking-Wichtigkeit an, die der Property zugewiesen wird, wenn sie beim Abrufen abgeglichen wird. Die Tokenbedeutung einer Property kann nach der Festlegung nicht mehr geändert werden.

RetrievalImportance.Importance

Enums
DEFAULT Die Übereinstimmung wird wie eine Übereinstimmung im Textkörper behandelt.
HIGHEST Die Übereinstimmung wird wie eine Übereinstimmung mit dem Titel des Artikels behandelt.
HIGH Die Übereinstimmung wird wichtiger als der Textkörper behandelt.
LOW Die Übereinstimmung hat eine geringere Bedeutung als der Textkörper.
NONE Bei der Abfrage darf kein Abgleich mit diesem Feld erfolgen. Die Property kann weiterhin für die Operatorabgleiche, die Facetten und die Vorschläge verwendet werden.

TextPropertyOptions.TextOperatorOptions

Wird verwendet, um einen Suchoperator für Texteigenschaften anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

JSON-Darstellung 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Felder
operatorName

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die Texteigenschaft zu isolieren. Wenn der Operatorname beispielsweise subject und der Name der Property subjectLine ist, werden bei Suchanfragen wie subject:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property subjectLine mit <value> übereinstimmt. Bei einer Suche, bei der derselbe Wert <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert beliebiger Texteigenschaften oder Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
exactMatchWithOperator

boolean

Wenn „wahr“ ist, wird der Textwert in Operatorsuchen und Facet-Treffern als ein atomarer Wert tokenisiert. Wenn der Operatorname beispielsweise „genre“ und der Wert „Science-Fiction“ ist, stimmen die Abfrageeinschränkungen „genre:science“ und „genre:fiction“ nicht mit dem Element überein, „genre:Science-Fiction“ hingegen schon. Bei der Übereinstimmung von Textwerten wird die Groß- und Kleinschreibung berücksichtigt und Sonderzeichen werden nicht entfernt. Wenn „false“ festgelegt ist, wird der Text tokenisiert. Wenn der Wert beispielsweise „Science-Fiction“ ist, stimmen die Suchanfragen „genre:science“ und „genre:fiction“ mit dem Element überein.

HtmlPropertyOptions

Die Optionen für HTML-Properties.

JSON-Darstellung 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Felder
retrievalImportance

object (RetrievalImportance)

Gibt an, wie wichtig die Tokens im Feld für die Suchqualität sind, wenn sie für das Abrufen verwendet werden. Kann nur auf „DEFAULT“ oder „NONE“ gesetzt werden.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Wenn festgelegt, wird beschrieben, wie die Property als Suchoperator verwendet werden soll.

HtmlPropertyOptions.HtmlOperatorOptions

Wird verwendet, um einen Suchoperator für HTML-Properties anzugeben. Dies ist optional. Mit query.search-Operatoren können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Artikeltyp relevant sind.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die HTML-Property zu isolieren. Wenn der Operatorname beispielsweise subject und der Name der Property subjectLine ist, werden bei Suchanfragen wie subject:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property subjectLine mit <value> übereinstimmt. Bei einer Suche, bei der derselbe <value> ohne Operator verwendet wird, werden dagegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert einer beliebigen HTML-Property oder dem Text im Inhaltsfeld des Elements übereinstimmt. Der Name des Betreibers darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

PropertyDisplayOptions

Die Anzeigeoptionen für eine Property.

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

string

Das nutzerfreundliche Label für das Attribut, das verwendet wird, wenn das Attribut in „ObjectDisplayOptions“ angegeben ist. Wenn angegeben, wird das Anzeigelabel vor den Attributwerten angezeigt, wenn das Attribut Teil der Objektanzeigeoptionen ist. Wenn der Attributwert beispielsweise „1“ lautet, ist der Wert für den Nutzer möglicherweise nicht hilfreich. Wenn der angegebene Anzeigename „priority“ lautet, wird in den Suchergebnissen „priority : 1“ angezeigt. Das gibt Nutzern einen klaren Kontext. Optional. Wenn Sie diesen Wert nicht angeben, werden nur die Attributwerte angezeigt. Die maximale Länge beträgt 64 Zeichen.