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. Es sind maximal 10 Elemente zulässig.
operationIds[]

string

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

ObjectDefinition

Die Definition für ein Objekt in einer Datenquelle.

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

string

Der Name für das Objekt, der dann seinen Typ definiert. Bei Anfragen zur Indexierung von Artikeln muss das Feld objectType auf diesen Wert festgelegt werden. Wenn beispielsweise name Dokument ist, sollte bei Indexierungsanfragen für Elemente vom Typ „Dokument“ objectType auf Dokument gesetzt werden. Jede Objektdefinition muss innerhalb eines Schemas eindeutig benannt werden. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Zahlen (0–9) enthalten. Die maximale Länge beträgt 256 Zeichen.
options

object (ObjectOptions)

Die optionalen objektspezifischen Optionen.
propertyDefinitions[]

object (PropertyDefinition)

Die Attributdefinitionen für das Objekt. Es sind maximal 1.000 Elemente zulässig.

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)

Die Optionen, mit denen festgelegt wird, wie das Objekt auf der Cloud Search-Ergebnisseite angezeigt wird.
suggestionFilteringOperators[]

string

Operatoren zum Filtern von Vorschlägen. Für die query.suggest API werden nur die hier genannten Operatoren 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 dies ein Array ist, kann nur ein Operator angegeben werden. Dies ist ein Array für die zukünftige Erweiterbarkeit.

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

ObjectOptions.FreshnessOptions

Gibt an, welche Aktualitätseigenschaft beim Anpassen des Rankings für ein Element verwendet werden soll. Aktuellere, aktuellere Datumsangaben deuten auf eine höhere Qualität hin. Verwenden Sie die Property für die Aktualitätsoption, die für Ihre Daten am besten geeignet ist. Bei Fileshare-Dokumenten ist der Zeitpunkt der letzten Änderung am relevantesten. Bei Kalendertermindaten ist der Zeitpunkt des Ereignisses ein relevanterer Indikator für die Aktualität. So werden Kalendertermine, die näher an der Zeit der Suchanfrage stattfinden, von höherer Qualität betrachtet und entsprechend eingestuft.

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

string

Diese Eigenschaft gibt die Aktualität des Objekts im Index an. Wenn festgelegt, muss diese Property eine Top-Level-Property innerhalb von property definitions und ein timestamp type- oder date type-Element sein. Andernfalls verwendet die Indexing API updateTime als Aktualitätsindikator. Die maximale Länge beträgt 256 Zeichen.

Wenn eine Eigenschaft zur Berechnung der Aktualität verwendet wird, beträgt der Wert standardmäßig zwei Jahre ab der aktuellen Uhrzeit.
freshnessDuration

string (Duration format)

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

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. 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 werden soll, um den Typ des Elements anzugeben. Dies ist OPTIONAL. Wenn nicht angegeben, wird in der Kontextzeile der Suchergebnisse keine Objektbezeichnung angezeigt. Die maximale Länge beträgt 64 Zeichen.
metalines[]

object (ObjectDisplayOptions.Metaline)

Definiert die Eigenschaften, die in den Metazeilen der Suchergebnisse angezeigt werden. Die Attributwerte werden in der hier angegebenen Reihenfolge angezeigt. Wenn eine Eigenschaft mehrere Werte enthält, werden alle Werte vor den nächsten Eigenschaften angezeigt. Aus diesem Grund empfiehlt es sich, in dieser Liste einzelne Properties vor wiederholten Properties anzugeben. Alle Attribute müssen isReturnable auf „true“ setzen. Die maximale Anzahl an Metazeilen ist 3.

ObjectDisplayOptions.Metaline

Eine Metazeile ist eine Liste von Eigenschaften, die zusammen mit dem Suchergebnis angezeigt werden, um Kontext bereitzustellen.

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

object (ObjectDisplayOptions.DisplayedProperty)

Die Liste der angezeigten Eigenschaften für die Metazeile. Es sind maximal 5 Properties 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 Eigenschaften werden in den Suchergebnissen zusammen mit dem display label für diese Eigenschaft angezeigt, sofern einer angegeben ist. Wenn keine Anzeige angegeben ist, werden nur die Werte angezeigt.

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

string

Der Name der übergeordneten Eigenschaft, wie in einer Eigenschaftsdefinition für das Objekt definiert. Wenn der Name keine definierte Property im Schema ist, wird beim Versuch, das Schema zu aktualisieren, ein Fehler ausgegeben.

PropertyDefinition

Die Definition einer Eigenschaft 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 Eigenschaft. Bei Anfragen zur Indexierung von Elementen, die an die Indexing API gesendet werden, muss property name auf diesen Wert festgelegt werden. Wenn der Name beispielsweise subject_line lautet, sollte bei Indexierungsanfragen für Dokumentelemente mit Betrefffeldern die name für dieses Feld auf subject_line gesetzt werden. Verwenden Sie den Namen als Kennung für die Objekteigenschaft. Wenn Sie diesen Namen einmal als Eigenschaft für ein Objekt registriert haben, können Sie ihn nicht mehr für eine andere Eigenschaft innerhalb des Objekts verwenden. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Zahlen (0–9) enthalten. Die maximale Länge beträgt 256 Zeichen.
isReturnable

boolean

Gibt an, dass die Property Daten identifiziert, die in Suchergebnissen über die Query API zurückgegeben werden sollen. Durch die Einstellung true können Nutzer der Query API in den Ergebnissen übereinstimmende Eigenschaftsfelder verwenden. Das Speichern von Feldern erfordert jedoch mehr Speicherplatz und benötigt mehr Bandbreite für Suchanfragen, was die Leistung bei großen Datasets beeinträchtigt. Geben Sie hier nur true an, wenn das Feld für Suchergebnisse erforderlich ist. Kann nicht für Properties vom Typ „Objekt“ festgelegt werden.
isRepeatable

boolean

Gibt an, dass mehrere Werte für die Property zulässig sind. Beispiel: Ein Dokument hat nur eine Beschreibung, kann aber mehrere Kommentare enthalten. Kann nicht für Properties mit booleschem Wert "true" sein. Wenn dieser Parameter auf „false“ gesetzt ist, führen Eigenschaften, die mehr als einen Wert enthalten, dazu, dass die Indexierungsanfrage für dieses Element abgelehnt wird.
isSortable

boolean

Gibt an, dass das Attribut zum Sortieren verwendet werden kann. Darf nicht für Attribute sein, die wiederholbar sind. Kann nicht für Properties vom Typ „Objekt“ auf „true“ gesetzt sein. IsReturnable muss auf "true" gesetzt sein, um diese Option festzulegen. Wird nur für boolesche Eigenschaften, Datums-, Doppel-, Ganzzahl- und Zeitstempelattribute unterstützt.
isFacetable

boolean

Gibt an, dass das Attribut zum Generieren von Attributen verwendet werden kann. Kann nicht für Properties vom Typ „Objekt“ auf „true“ gesetzt sein. IsReturnable muss auf "true" gesetzt sein, um diese Option festzulegen. Wird nur für boolesche Eigenschaften, Enum-, Ganzzahl- und Texteigenschaften unterstützt.
isSuggestable

boolean

Gibt an, dass das Attribut zum Generieren von Abfragevorschlägen verwendet werden kann.
isWildcardSearchable

boolean

Gibt an, dass Nutzer für diese Property eine Platzhaltersuche ausführen können. Wird nur für Texteigenschaften unterstützt. IsReturnable muss auf "true" gesetzt sein, um diese Option festzulegen. In einer Datenquelle können maximal fünf Properties als „isWildcardSearchable“ gekennzeichnet werden. Weitere Informationen finden Sie unter Objekteigenschaften definieren.
displayOptions

object (PropertyDisplayOptions)

Die Optionen, mit denen festgelegt wird, wie das Attribut auf der Cloud Search-Ergebnisseite angezeigt wird, wenn die Anzeige im display options des Objekts festgelegt ist.
Union-Feld property_options. Die typspezifischen Optionen, die bestimmen, wie die Property indexiert und verwendet wird. Falls die Optionen die Standardoptionen für einen Typ sein sollen, muss dieses Feld trotzdem auf einen der Typen festgelegt werden. Wenn dieses Feld nicht festgelegt ist, werden Schemaaktualisierungen 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 Ganzzahl-Properties.

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

enum (IntegerPropertyOptions.OrderedRanking)

Dient zum Angeben der geordneten Rangfolge für die Ganzzahl. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
minimumValue

string (Int64Value format)

Der Mindestwert der Eigenschaft. Der Mindest- und Höchstwert für die Property wird verwendet, um die Ergebnisse gemäß ordered ranking zu ordnen. Indexierungsanfragen mit Werten unter dem Minimum werden akzeptiert und mit der gleichen Gewichtung wie Elemente, die mit dem Mindestwert indexiert sind, eingestuft.
maximumValue

string (Int64Value format)

Der Maximalwert der Eigenschaft. Der Mindest- und Höchstwert für die Property wird verwendet, um die Ergebnisse gemäß ordered ranking zu ordnen. Indexierungsanfragen mit Werten über dem Maximalwert werden akzeptiert und mit der gleichen Gewichtung wie Elemente, die mit dem Höchstwert indexiert sind, eingestuft.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

object (IntegerFacetingOptions)

Wenn festgelegt, werden Ganzzahl-Facet-Optionen für das angegebene Ganzzahlattribut beschrieben. Die entsprechende Ganzzahleigenschaft sollte als isFacetable gekennzeichnet sein.

IntegerPropertyOptions.OrderedRanking

Damit wird angegeben, wie ein ganzzahliger Wert im Verhältnis zu anderen Werten eingestuft werden soll. Eine Ganzzahl mit einem höheren Rang deutet auf eine höhere Wichtigkeit hin. Bei 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 Für die Unterkunft gibt es keine Rangfolge. Die Ergebnisse werden nicht durch den Wert dieser Eigenschaft angepasst.
ASCENDING Diese Eigenschaft wird in aufsteigender Reihenfolge sortiert. Niedrigere Werte bedeuten ein niedrigeres Ranking.
DESCENDING Diese Unterkunft wird in absteigender Reihenfolge sortiert. Niedrigere Werte bedeuten ein höheres Ranking.

IntegerPropertyOptions.IntegerOperatorOptions

Dient zur Bereitstellung eines Suchoperators für Ganzzahleigenschaften. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um das Ganzzahlattribut zu isolieren. Wenn „operatorName“ beispielsweise priorität und der Name der Eigenschaft prioritätVal lautet, liefern Abfragen wie priorität:<wert> nur dann Ergebnisse, wenn der Wert der Eigenschaft mit dem Namen prioritätVal mit <wert> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit dem gleichen <wert> ohne Operator alle Elemente zurück, bei denen <wert> mit dem Wert einer der Stringeigenschaften oder Text im Inhaltsfeld für das Element übereinstimmt. Der Operatorname 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 das Ganzzahlattribut mit dem Kleiner-als-Operator zu isolieren. Wenn „lessThanOperatorName“ beispielsweise prioritätbelow und der Name der Eigenschaft prioritätVal lautet, liefern Abfragen wie prioritätbelow:<value> nur dann Ergebnisse, wenn der Wert der Eigenschaft mit dem Namen prioritätVal 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 das Integer-Attribut mit dem Größer-als-Operator zu isolieren. Wenn „größerThanOperatorName“ z. B. auf Prioritätüber und der Name der Eigenschaft PrioritätVal lautet, liefern Abfragen wie Prioritätabove:<Wert> nur Ergebnisse, wenn der Wert der Eigenschaft PrioritätVal größer als <Wert> ist. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

DoublePropertyOptions

Die Optionen für Double-Properties.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

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

DoublePropertyOptions.DoubleOperatorOptions

Dient zur Bereitstellung eines Suchoperators für Double-Properties. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um das Attribut „double“ für die Sortierung oder als Attribut zu verwenden. Der Operatorname 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 Zeitstempelattribute bereitzustellen. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um das Zeitstempelattribut zu isolieren. Beispiel: Wenn "operatorName" closedon ist und der Name der Property closeDate ist, liefern Abfragen wie closedon:<value> nur dann Ergebnisse, wenn der Wert der Property namens closeDate mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit dem gleichen <value> ohne Operator alle Elemente zurück, bei denen <value> mit dem Wert der String-Eigenschaften oder des Textes im Inhaltsfeld für das Element übereinstimmt. Der Operatorname 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 das Zeitstempelattribut mit dem Kleiner-als-Operator zu isolieren. Wenn „lessThanOperatorName“ beispielsweise closedbefore ist und der Name der Property closeDate ist, liefern Abfragen wie closedbefore:<value> nur Ergebnisse, wenn der Wert der Property namens closeDate vor <value> liegt. 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 das Zeitstempelattribut mit dem Operator „größer als“ zu isolieren. Wenn „größerThanOperatorName“ beispielsweise closedafter ist und der Name der Property closeDate ist, liefern Abfragen wie closedafter:<value> nur Ergebnisse, wenn der Wert der Property namens closeDate nach <value> liegt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

BooleanPropertyOptions

Die Optionen für boolesche Eigenschaften.

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

Dient zur Bereitstellung eines Suchoperators für boolesche Eigenschaften. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den in der Abfrage erforderlichen Operatornamen an, um die boolesche Eigenschaft zu isolieren. Wenn „operatorName“ closed ist und der Name der Eigenschaft isClosed ist, liefern Abfragen wie closed:<value> nur dann Ergebnisse, wenn der Wert der Eigenschaft isClosed mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben <value> ohne Operator alle Elemente zurück, bei denen <value> mit dem Wert der String-Eigenschaften oder des Textes im Inhaltsfeld für das Element übereinstimmt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

ObjectPropertyOptions

Die Optionen für Objekteigenschaften.

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

object (PropertyDefinition)

Die Eigenschaften des Unterobjekts. Diese Eigenschaften stellen ein verschachteltes Objekt dar. Wenn diese Property beispielsweise eine Postanschrift darstellt, können die Unterobjekteigenschaften street, city und state genannt werden. Es sind maximal 1.000 Elemente zulässig.

EnumPropertyOptions

Die Optionen für Enum-Properties, mit denen Sie einen eingeschränkten Satz von Strings definieren können, um Nutzeranfragen abzugleichen, Rankings für diese Stringwerte festzulegen und einen Operatornamen zu definieren, der mit diesen Strings gekoppelt wird, sodass Nutzer die Ergebnisse auf Elemente mit einem bestimmten Wert eingrenzen können. Für Elemente in einem Anfrageverfolgungssystem mit Prioritätsinformationen könnten Sie beispielsweise p0 als zulässigen enum-Wert definieren und diese Enum mit dem Operatornamen Priorität verknüpfen. So könnten Nutzer der Suche Priorität:p0 zu ihrer Suchanfrage hinzufügen und die Ergebnismenge auf die Ergebnisse beschrä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 enumeration-Attribut. Alle EnumValuePairs müssen einen Stringwert angeben. Wenn Sie für ein EnumValuePair einen Ganzzahlwert angeben, müssen alle möglichen EnumValuePairs einen Ganzzahlwert bereitstellen. Sowohl der Stringwert als auch der Ganzzahlwert müssen über alle möglichen Werte hinweg eindeutig sein. Nach dem Festlegen können mögliche Werte weder entfernt noch geändert werden. Wenn Sie eine geordnete Rangfolge angeben und glauben, dass Sie in Zukunft weitere enum-Werte einfügen könnten, lassen Sie Lücken in den anfänglichen ganzzahligen Werten, damit zwischen zuvor registrierten Werten ein Wert hinzugefügt werden kann. Es sind maximal 100 Elemente zulässig.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Wird verwendet, um die geordnete Rangfolge für die Aufzählung anzugeben, die bestimmt, wie die in den möglichen EnumValuePairs bereitgestellten Ganzzahlwerte zum Ranking der Ergebnisse verwendet werden. Wenn angegeben, müssen ganzzahlige Werte für alle möglichen EnumValuePair-Werte für diese Eigenschaft angegeben werden. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValuePair

Das Aufzählungswertpaar 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 Prioritätselement. Der Ganzzahlwert bestimmt die Rangfolge dieses Stringwerts im Verhältnis zu anderen Aufzählungswerten für dasselbe Attribut. Sie können beispielsweise p0 mit 0 verknüpfen und ein weiteres enum-Paar wie p1 und 1 definieren. Sie müssen den Ganzzahlwert in Kombination mit ordered ranking verwenden, um die Rangfolge eines bestimmten Werts im Verhältnis zu anderen Aufzählungswerten für denselben Attributnamen festzulegen. In diesem Fall führt eine Rangfolgenreihenfolge von ABSTEIGEND für die Attribute priorität zu einem verbesserten Ranking für Elemente mit einem Wert von p0 im Vergleich zu Elementen mit dem Wert p1. Ohne angegebene Rangfolgenreihenfolge hat der ganzzahlige Wert keine Auswirkung auf das Ranking der Artikel.

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

string

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

integer

Ganzzahlwert von EnumValuePair, der nicht negativ sein darf. Optional.

EnumPropertyOptions.OrderedRanking

Wird verwendet, um die Ranking-Richtung für eine EnumValuePair-Ganzzahl relativ zu anderen EnumValuePair-Ganzzahlwerten anzugeben. Bei einigen Eigenschaften weisen niedrigere Ganzzahlwerte auf eine höhere Wichtigkeit hin, während bei anderen eine höhere Ganzzahl eine höhere Wichtigkeit anzeigt.

Enums
NO_ORDER Für die Unterkunft gibt es keine Rangfolge. Die Ergebnisse werden nicht durch den Wert dieser Eigenschaft angepasst.
ASCENDING Diese Eigenschaft wird in aufsteigender Reihenfolge sortiert. Niedrigere Werte bedeuten ein niedrigeres Ranking.
DESCENDING Diese Unterkunft wird in absteigender Reihenfolge sortiert. Niedrigere Werte bedeuten ein höheres Ranking.

EnumPropertyOptions.EnumOperatorOptions

Wird verwendet, um einen Suchoperator für enum-Attribute bereitzustellen. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind. Wenn Sie beispielsweise keinen Operator für das Enum-Attribut Priority mit den möglichen Werten p0 und p1 angeben, gibt eine Abfrage, die den Begriff p0 enthält, Elemente zurück, bei denen p0 als Wert für das Attribut Priorität verwendet wird, sowie alle Elemente, in denen in anderen Feldern der String p0 enthalten ist. Wenn Sie für die Aufzählung einen Operatornamen angeben, z. B. Priority, können Nutzer der Suche mit diesem Operator die Ergebnisse auf Elemente beschränken, bei denen p0 als Wert für dieses Attribut verwendet wird. Dazu wird die Abfrage Priority:p0 verwendet.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um das enum-Attribut zu isolieren. Wenn „operatorName“ beispielsweise priorität und der Name der Eigenschaft prioritätVal lautet, liefern Abfragen wie priorität:<wert> nur dann Ergebnisse, wenn der Wert der Eigenschaft mit dem Namen prioritätVal mit <wert> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit dem gleichen <wert> ohne Operator alle Elemente zurück, bei denen <wert> mit dem Wert einer der Stringeigenschaften oder Text im Inhaltsfeld für das Element übereinstimmt. Der Operatorname 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)

Falls festgelegt, wird beschrieben, wie das Datum als Suchoperator verwendet werden soll.

DatePropertyOptions.DateOperatorOptions

Optional. Stellt einen Suchoperator für Datumseigenschaften bereit. Mit dem Operator "query.search" können Nutzer die Suchanfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den String an, der in der Abfrage tatsächlich erforderlich ist, um das Datumsattribut zu isolieren. Angenommen, ein Schemaobjekt für die Problemverfolgung hat eine Eigenschaft namens closeDate, die einen Operator mit demoperatorName closedon angibt. Bei Suchanfragen nach diesen Daten werden bei Abfragen wie closedon:<value> nur Ergebnisse angezeigt, wenn der Wert der Eigenschaft closeDate mit <value> übereinstimmt. Bei einer Suche mit demselben <value> ohne Operator werden hingegen alle Elemente zurückgegeben, bei denen <value> mit dem Wert von Stringeigenschaften oder Text im Inhaltsfeld für die indexierte Datenquelle übereinstimmt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
lessThanOperatorName

string

Gibt den Namen des Operators an, der in der Abfrage erforderlich ist, um die Datumseigenschaft mit dem Kleiner-als-Operator zu isolieren. Wenn „lessThanOperatorName“ beispielsweise closedbefore ist und der Name der Property closeDate ist, liefern Abfragen wie closedbefore:<value> nur Ergebnisse, wenn der Wert der Property namens closeDate vor <value> liegt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
greaterThanOperatorName

string

Gibt den in der Abfrage erforderlichen Operatornamen an, um die Datumseigenschaft mit dem Operator "größer als" zu isolieren. Wenn „größerThanOperatorName“ beispielsweise closedafter ist und der Name der Property closeDate ist, liefern Abfragen wie closedafter:<value> nur Ergebnisse, wenn der Wert der Property namens closeDate nach <value> liegt. Der Operatorname 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 die Wichtigkeit der Suchqualität der Tokens im Feld an, wenn sie zum Abrufen verwendet werden.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

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

RetrievalImportance

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

enum (RetrievalImportance.Importance)

Gibt die Rangfolgenwichtigkeit an, die der Property zugewiesen wird, wenn sie während des Abrufs zugeordnet wird. Nach dem Festlegen kann die Tokenwichtigkeit einer Eigenschaft nicht mehr geändert werden.

RetrievalImportance.Importance

Enums
DEFAULT Die Übereinstimmung wird wie eine Textübereinstimmung behandelt.
HIGHEST Behandeln Sie die Übereinstimmung wie eine Übereinstimmung mit dem Titel des Artikels.
HIGH Behandeln Sie die Übereinstimmung mit größerer Bedeutung als der Textkörper.
LOW Die Übereinstimmung wird mit geringerer Bedeutung behandelt als der Textkörper.
NONE Beim Abruf nicht mit diesem Feld abgleichen. Das Attribut kann bei Bedarf weiterhin für den Operatorabgleich, die Facettierung und Vorschläge verwendet werden.

TextPropertyOptions.TextOperatorOptions

Dient zur Bereitstellung eines Suchoperators für Texteigenschaften. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den in der Abfrage erforderlichen Operatornamen an, um das Textattribut zu isolieren. Beispiel: Wenn OperatorName subject lautet und der Name der Eigenschaft subjectLine lautet, liefern Abfragen wie subject:<Wert> nur dann Ergebnisse, wenn der Wert der Eigenschaft subjectLine mit <Wert> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit dem gleichen <Wert> ohne Operator alle Elemente zurück, bei denen <Wert> mit dem Wert einer Texteigenschaft oder eines Textes im Inhaltsfeld für das Element übereinstimmt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.
exactMatchWithOperator

boolean

Wenn „true“, wird der Textwert in Operatorsuchen und Attributübereinstimmungen als ein atomarer Wert tokenisiert. Wenn der Operatorname beispielsweise "genre" und der Wert "Science-Fiction" lautet, stimmen die Suchanfrageneinschränkungen "genre:science" und "genre:Fiction" nicht mit dem Artikel überein, "genre:science-Fiction" hingegen schon. Beim Textwertabgleich wird zwischen Groß- und Kleinschreibung unterschieden und es werden keine Sonderzeichen entfernt. Bei „false“ wird der Text tokenisiert. Wenn der Wert beispielsweise "Science-Fiction" lautet, stimmen die Suchanfragen "genre:science" und "genre:Fiction" mit dem Artikel überein.

HtmlPropertyOptions

Die Optionen für HTML-Eigenschaften.

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

object (RetrievalImportance)

Gibt die Wichtigkeit der Suchqualität der Tokens im Feld an, wenn sie zum Abrufen verwendet werden. Kann nur auf STANDARD oder NONE festgelegt werden.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

HtmlPropertyOptions.HtmlOperatorOptions

Dient zur Bereitstellung eines Suchoperators für HTML-Eigenschaften. Dies ist optional. Mit den Query.search-Operatoren können Nutzer die Abfrage auf bestimmte Felder beschränken, die für den gesuchten Elementtyp relevant sind.

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die HTML-Eigenschaft zu isolieren. Wenn „operatorName“ beispielsweise subject ist und der Name der Eigenschaft subjectLine lautet, liefern Abfragen wie subject:<Wert> nur dann Ergebnisse, wenn der Wert der Eigenschaft subjectLine mit <Wert> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben <Wert> ohne Operator alle Elemente zurück, bei denen <Wert> mit dem Wert einer HTML-Eigenschaft oder eines Textes im Inhaltsfeld für das Element übereinstimmt. Der Operatorname darf nur Kleinbuchstaben (a–z) enthalten. Die maximale Länge beträgt 32 Zeichen.

PropertyDisplayOptions

Die Anzeigeoptionen für eine Eigenschaft.

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

string

Die benutzerfreundliche Bezeichnung der Eigenschaft, die verwendet wird, wenn die Eigenschaft in ObjectDisplayOptions angezeigt werden soll. Falls angegeben, wird die Anzeige vor den Eigenschaftswerten angezeigt, wenn die Eigenschaft Teil der Anzeigeoptionen für das Objekt ist. Wenn der Wert der Eigenschaft beispielsweise „1“ ist, ist der Wert alleine möglicherweise nicht hilfreich für den Nutzer. Wenn der angegebene Anzeigename "Priorität" lautete, wird dem Nutzer in den Suchergebnissen das Wort "Priorität : 1" angezeigt, was den Nutzern der Suche einen klaren Kontext bietet. Dies ist OPTIONAL. Falls nicht angegeben, werden nur die Eigenschaftswerte angezeigt. Die maximale Länge beträgt 64 Zeichen.