Schema

Die Schemadefinition für eine Datenquelle.

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

object (ObjectDefinition)

Die Liste der Objekte der obersten 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 des Objekts, der dann seinen Typ definiert. Bei Anfragen zur Artikelindexierung muss das Feld objectType auf diesen Wert festgelegt werden. Beispiel: Wenn Name den Wert Dokument hat, sollte bei Indexierungsanfragen für Elemente vom Typ „Dokument“ objectType auf Dokument festgelegt 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 Eigenschaftsdefinitionen 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, die bestimmen, wie das Objekt auf der Cloud Search-Ergebnisseite angezeigt wird.
suggestionFilteringOperators[]

string

Operatoren, die zum Filtern von Vorschlägen verwendet werden können. Für die query.suggest API werden in der FilterOptions nur die hier erwähnten Operatoren berücksichtigt. Es werden nur die Operatoren TEXT und ENUM unterstützt.

HINWEIS: "objecttype", "type" und „MIME-Typ“ werden bereits unterstützt. Mit diesem Attribut werden schemaspezifische Operatoren konfiguriert.

Auch wenn dies ein Array ist, kann nur ein Operator angegeben werden. Dies ist ein Array für zukünftige Erweiterbarkeit.

Operatoren, die mehreren Attributen 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 Suchrankings 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 am besten für Ihre Daten 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. Auf diese Weise werden Kalendertermine, die kurz vor der Suchanfrage stattfinden, als qualitativ hochwertig eingestuft und entsprechend eingestuft.

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 der obersten Ebene innerhalb von property definitions und eine timestamp type- oder date type-Property sein. Andernfalls verwendet die Index API updateTime als Aktualitätsindikator. Die maximale Länge beträgt 256 Zeichen.

Wenn eine Eigenschaft zur Berechnung der Aktualität verwendet wird, wird der Wert standardmäßig auf 2 Jahre ab der aktuellen Zeit gesetzt.
freshnessDuration

string (Duration format)

Der Zeitraum, nach dem ein Objekt als veraltet betrachtet wird. Der Standardwert ist 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 in den Suchergebnissen angezeigt wird und den Typ des Elements angibt. Dies ist OPTIONAL. Andernfalls wird in der Kontextzeile der Suchergebnisse kein Objektlabel 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 Eigenschaftswerte 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 Eigenschaften vor wiederholten Attributen anzugeben. Alle Attribute müssen isReturnable auf „true“ festlegen. Es sind maximal 3 Metazeilen zulässig.

ObjectDisplayOptions.Metaline

Eine Metazeile ist eine Liste von Properties, 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 Unterkünfte zulässig.

ObjectDisplayOptions.DisplayedProperty

Ein Verweis auf eine Property der obersten Ebene innerhalb des Objekts, die in den Suchergebnissen angezeigt werden soll. Die Werte der ausgewählten Unterkünfte werden in den Suchergebnissen zusammen mit der display label für diese Property angezeigt, sofern eine angegeben wurde. Wenn keine Anzeige angegeben wurde, werden nur die Werte angezeigt.

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

string

Der Name der obersten Ebene, wie in einer Eigenschaftsdefinition für das Objekt definiert. Wenn der Name keine definierte Eigenschaft 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 Artikelindexierung, die an die API gesendet werden, sollte property name auf diesen Wert festgelegt werden. Wenn der Name beispielsweise subject_line ist, sollte bei Indexierungsanfragen für Dokumentelemente mit Betrefffeldern als name für dieses Feld subject_line festgelegt werden. Verwenden Sie den Namen als Kennung für die Objekteigenschaft. Sobald ein Name als Eigenschaft für ein Objekt registriert wurde, können Sie ihn nicht für eine andere Eigenschaft innerhalb dieses Objekts wiederverwenden. 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. Wenn true festgelegt ist, können Nutzer der Query API übereinstimmende Attributfelder in Ergebnissen verwenden. Das Speichern von Feldern erfordert jedoch mehr Speicherplatz und erfordert mehr Bandbreite für Suchanfragen. Dies beeinträchtigt bei großen Datasets die Leistung. Legen Sie diesen Wert hier nur auf true fest, wenn das Feld für Suchergebnisse benötigt wird. Darf für Properties des Typs "Objekt" nicht "true" sein.
isRepeatable

boolean

Gibt an, dass mehrere Werte für das Attribut zulässig sind. Ein Dokument kann beispielsweise nur eine Beschreibung, aber mehrere Kommentare haben. Darf für Properties mit einem booleschen Wert nicht "true" sein. Wenn die Richtlinie auf „false“ gesetzt ist, führen Attribute, 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 für Attribute, die wiederholbar sind, nicht auf „true“ gesetzt werden. Darf für Properties vom Typ "Objekt" nicht "true" sein. „IsReturnable“ muss auf „true“ gesetzt sein, damit diese Option festgelegt werden kann. Wird nur für boolesche, Datums-, Double-, Ganzzahl- und Zeitstempelattribute unterstützt.
isFacetable

boolean

Gibt an, dass das Attribut zum Generieren von Attributen verwendet werden kann. Darf für Properties vom Typ "Objekt" nicht "true" sein. „IsReturnable“ muss auf „true“ gesetzt sein, damit diese Option festgelegt werden kann. Wird nur für boolesche, enum-, Integer- und Text-Properties unterstützt.
isSuggestable

boolean

Gibt an, dass das Attribut zum Generieren von Vorschlägen für Suchanfragen verwendet werden kann.
isWildcardSearchable

boolean

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

object (PropertyDisplayOptions)

Die Optionen, die bestimmen, wie die Property auf der Cloud Search-Ergebnisseite angezeigt wird, wenn sie im display options des Objekts angezeigt werden soll.
Union-Feld property_options. Die typspezifischen Optionen, die bestimmen, wie die Eigenschaft 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 Ganzzahleigenschaften.

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

enum (IntegerPropertyOptions.OrderedRanking)

Wird verwendet, um die sortierte Rangfolge für die Ganzzahl anzugeben. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
minimumValue

string (Int64Value format)

Der Mindestwert der Eigenschaft. Die Mindest- und Höchstwerte für die Property werden zum Ranking von Ergebnissen gemäß ordered ranking verwendet. Indexierungsanfragen mit Werten unter dem Minimum werden akzeptiert und mit derselben Gewichtung eingestuft wie Elemente, die mit dem Mindestwert indexiert werden.
maximumValue

string (Int64Value format)

Der Maximalwert der Eigenschaft. Die Mindest- und Höchstwerte für die Property werden zum Ranking von Ergebnissen gemäß ordered ranking verwendet. Indexierungsanfragen mit Werten, die über dem Maximum liegen, werden akzeptiert und mit derselben Gewichtung eingestuft wie Elemente, die mit dem Höchstwert indexiert werden.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Beschreibt, wie die Ganzzahl als Suchoperator verwendet werden soll, falls festgelegt.
integerFacetingOptions

object (IntegerFacetingOptions)

Wenn dieser Wert festgelegt ist, werden Optionen für Ganzzahlattribute für das angegebene Ganzzahlattribut beschrieben. Das entsprechende Ganzzahlattribut sollte als „isFacetable“ gekennzeichnet sein.

IntegerPropertyOptions.OrderedRanking

Damit wird angegeben, wie ein Ganzzahlwert im Verhältnis zu anderen Werten eingestuft werden soll. Eine Ganzzahl mit einer höher sortierten Rangfolge deutet auf eine höhere Bedeutung hin. Beispielsweise deutet bei einigen Datenquellen eine niedrigere Priorität auf eine höhere Bedeutung hin, während in anderen eine höhere Priorität auf eine höhere Wichtigkeit hinweist.

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

IntegerPropertyOptions.IntegerOperatorOptions

Wird verwendet, um einen Suchoperatoren für ganzzahlige Attribute bereitzustellen. Dies ist optional. Mit den Operatoren „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 Operatornamen an, der in der Abfrage erforderlich ist, um das Ganzzahlattribut zu isolieren. Beispiel: Wenn der "operatorName" priorität und der Name der Eigenschaft PriorityVal ist, zeigen Abfragen wie Priority:<value> nur dann Ergebnisse an, wenn der Wert der Eigenschaft PriorityVal mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert eines String-Attributs oder Texts im Inhaltsfeld des Elements ü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 die ganzzahlige Eigenschaft mit dem Kleiner-als-Operator zu isolieren. Beispiel: Wenn lessThanOperatorName den Wert Prioritybelow hat und der Property-Name PriorityVal, werden mit Abfragen wie Prioritybelow:<value> nur Ergebnisse zurückgegeben, bei denen der Wert der Property namens 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 das Ganzzahlattribut mit dem Größer-als-Operator zu isolieren. Beispiel: Wenn größerThanOperatorName den Wert Priorityabove hat und der Name des Attributs PriorityVal ist, zeigen Abfragen wie Priorityabove:<value> nur Ergebnisse an, wenn der Wert der Property namens 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 Double-Properties.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

Beschreibt, wie der String „Double“ als Suchoperator verwendet werden soll, falls er festgelegt ist.

DoublePropertyOptions.DoubleOperatorOptions

Wird verwendet, um einen Suchoperator für Double-Properties bereitzustellen. Dies ist optional. Mit den Operatoren „query.search“ können Nutzer die Suchanfrage 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 Eigenschaft Double beim Sortieren 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)

Beschreibt, wie der Zeitstempel als Suchoperator verwendet werden soll, falls er festgelegt wurde.

TimestampPropertyOptions.TimestampOperatorOptions

Wird verwendet, um einen Suchoperator für Zeitstempelattribute bereitzustellen. Dies ist optional. Mit den Operatoren „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 Operatornamen an, der in der Abfrage erforderlich ist, um das Zeitstempelattribut zu isolieren. Beispiel: Wenn deroperatorName closedon lautet und der Name der Eigenschaft closeDate ist, zeigen Abfragen wie closedon:<value> nur Ergebnisse, wenn der Wert der Eigenschaft namens closeDate mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert eines String-Attributs oder Texts im Inhaltsfeld des Elements ü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 Attribut timestamp mit dem Kleiner-als-Operator zu isolieren. Beispiel: Wenn lessThanOperatorName den Wert closedbefore hat und der Name der Eigenschaft closeDate ist, zeigen Abfragen wie closedbefore:<value> nur Ergebnisse an, bei denen der Wert der Eigenschaft 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 timestamp-Attribut mit dem Größer-als-Operator zu isolieren. Beispiel: Wenn größerThanOperatorName closedafter ist und der Name der Eigenschaft closeDate ist, zeigen Abfragen wie closedafter:<value> nur Ergebnisse an, wenn der Wert der Eigenschaft 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 Attribute.

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

object (BooleanPropertyOptions.BooleanOperatorOptions)

Beschreibt, wie der boolesche Wert als Suchoperator verwendet werden soll, falls festgelegt.

BooleanPropertyOptions.BooleanOperatorOptions

Wird verwendet, um einen Suchoperator für boolesche Attribute bereitzustellen. Dies ist optional. Mit den Operatoren „query.search“ können Nutzer die Suchanfrage 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 zum Isolieren der booleschen Eigenschaft erforderlich ist. Wenn deroperatorName beispielsweise closed und der Name der Eigenschaft isClosed ist, zeigen Abfragen wie closed:<value> nur Ergebnisse an, wenn der Wert der Eigenschaft namens isClosed mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert eines String-Attributs oder Texts im Inhaltsfeld des Elements ü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 repräsentiert, können die UnterobjekteProperties in den Namen street, city und state benannt werden. Es sind maximal 1.000 Elemente zulässig.

EnumPropertyOptions

Die Optionen für enum-Eigenschaften, mit denen Sie einen eingeschränkten Satz von Zeichenfolgen definieren können, die mit Nutzeranfragen übereinstimmen, Rankings für diese Zeichenfolgewerte festlegen und einen Operatornamen zur Paarung mit diesen Zeichenfolgen definieren, sodass Nutzer die Ergebnisse auf Elemente mit einem bestimmten Wert beschränken 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 diese enum mit dem Operatornamen Priority verknüpfen. So können Nutzer der Suche ihrer Suchanfrage Priority:p0 hinzufügen, um die Ergebnismenge auf die Elemente mit dem Wert p0 zu beschränken.

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 die Aufzählungseigenschaft. Alle EnumValuePairs müssen einen Stringwert angeben. Wenn Sie für ein EnumValuePair einen ganzzahligen Wert angeben, muss für alle möglichen EnumValuePairs ein Ganzzahlwert angegeben werden. Sowohl der String- als auch der Ganzzahlwert müssen für alle möglichen Werte eindeutig sein. Mögliche Werte können nach ihrer Festlegung weder entfernt noch geändert werden. Wenn Sie eine geordnete Rangfolge angeben und glauben, dass Sie in Zukunft zusätzliche enum-Werte einfügen möchten, lassen Sie Lücken bei den Anfangs-Ganzzahlwerten, 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 angegebenen Ganzzahlwerte zum Ranking der Ergebnisse verwendet werden. Falls angegeben, müssen für alle möglichen EnumValuePair-Werte für diese Eigenschaft Ganzzahlwerte angegeben werden. Kann nur verwendet werden, wenn isRepeatable „false“ ist.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Beschreibt, wie die Aufzählung als Suchoperator verwendet werden soll, sofern vorhanden.

EnumPropertyOptions.EnumValuePair

Das Aufzählungswertpaar definiert zwei Elemente: einen erforderlichen Stringwert und einen optionalen Ganzzahlwert. Der Stringwert definiert den erforderlichen Suchbegriff, der zum Abrufen dieses Elements erforderlich ist, zum Beispiel p0 für ein Prioritätselement. Der ganzzahlige Wert bestimmt die Rangfolge dieses Stringwerts in Relation 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. Hier führt die Rangfolge von ABSTEIGEND für Eigenschaften vom Typ Priority zu einem Ranking-Boost für Elemente mit einem Wert von p0 im Vergleich zu Elementen mit einem Wert von p1. Ohne eine festgelegte Rangfolge hat der ganzzahlige Wert keine Auswirkungen auf das Ranking von Artikeln.

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

string

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

integer

Der ganzzahlige Wert von EnumValuePair, der nicht negativ sein darf. Optional.

EnumPropertyOptions.OrderedRanking

Gibt die Richtung des Rankings für eine EnumValuePair-Ganzzahl im Verhältnis zu anderen ganzzahligen EnumValuePair-Ganzzahlwerten an. Bei einigen Eigenschaften weisen niedrigere Ganzzahlwerte auf eine höhere Wichtigkeit hin, während bei anderen eine höhere Ganzzahl eine höhere Bedeutung angibt.

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

EnumPropertyOptions.EnumOperatorOptions

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

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die enum-Eigenschaft zu isolieren. Beispiel: Wenn der "operatorName" priorität und der Name der Eigenschaft PriorityVal ist, zeigen Abfragen wie Priority:<value> nur dann Ergebnisse an, wenn der Wert der Eigenschaft PriorityVal mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert eines String-Attributs oder Texts im Inhaltsfeld des Elements ü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)

Beschreibt, wie das Datum als Suchoperator verwendet werden soll, sofern festgelegt.

DatePropertyOptions.DateOperatorOptions

Optional. Stellt einen Suchoperator für Datumseigenschaften bereit. Mit den Operatoren „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 erforderlich ist, um die Datumseigenschaft zu isolieren. Angenommen, ein Schemaobjekt für die Problemverfolgung hat die Eigenschaft closeDate, die als Operator den Operator closedon angibt. Bei Suchanfragen zu diesen Daten werden mit closedon:&lt;value&gt; nur Ergebnisse angezeigt, bei denen der Wert der closedon:&lt;value&gt;-Eigenschaft mit closedon:&lt;value&gt; übereinstimmt. Im Gegensatz dazu werden bei einer Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurückgegeben, bei denen &lt;value&gt; mit dem Wert eines String-Attributs oder Texts im Inhaltsfeld der indexierten Datenquelle ü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 die Datumseigenschaft mit dem Kleiner-als-Operator zu isolieren. Beispiel: Wenn lessThanOperatorName den Wert closedbefore hat und der Name der Eigenschaft closeDate ist, zeigen Abfragen wie closedbefore:<value> nur Ergebnisse an, bei denen der Wert der Eigenschaft 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 die Datumseigenschaft mit dem Größer-als-Operator zu isolieren. Beispiel: Wenn größerThanOperatorName closedafter ist und der Name der Eigenschaft closeDate ist, zeigen Abfragen wie closedafter:<value> nur Ergebnisse an, wenn der Wert der Eigenschaft 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 Tokens für die Suchqualität im Feld an, wenn sie für den Abruf verwendet werden.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Beschreibt, wie die Property als Suchoperator verwendet werden soll, sofern festgelegt.

RetrievalImportance

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

enum (RetrievalImportance.Importance)

Gibt die Wichtigkeit der Rangfolge an, die der Property zugewiesen wird, wenn sie während des Abrufs abgeglichen wird. Nachdem die Tokenwichtigkeit einer Property festgelegt wurde, kann sie nicht mehr geändert werden.

RetrievalImportance.Importance

Enums
DEFAULT Behandeln Sie die Übereinstimmung wie eine Textübereinstimmung.
HIGHEST Die Übereinstimmung wird wie eine Übereinstimmung mit dem Titel des Elements behandelt.
HIGH Die Übereinstimmung ist wichtiger als der Fließtext.
LOW Die Übereinstimmung mit einer geringeren Bedeutung als dem Fließtext behandeln.
NONE Keine Übereinstimmungen mit diesem Feld beim Abrufen. Die Eigenschaft kann bei Bedarf weiterhin für den Operatorabgleich, Facetten und Vorschläge verwendet werden.

TextPropertyOptions.TextOperatorOptions

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

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

string

Gibt den Operatornamen an, der in der Abfrage erforderlich ist, um die Texteigenschaft zu isolieren. Wenn deroperatorName beispielsweise subject und der Name der Eigenschaft subjectLine ist, zeigen Abfragen wie subject:<value> nur Ergebnisse an, wenn der Wert der Eigenschaft namens subjectLine mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert von Texteigenschaften 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.
exactMatchWithOperator

boolean

Bei „true“ wird der Textwert bei Suchen mit Operatoren und Attributübereinstimmungen als ein atomarer Wert tokenisiert. Lautet der Operatorname beispielsweise „genre“ und der Wert ist „Science-Fiction“. die Abfrageeinschränkungen „genre:science“ und „genre:fiktion“ nicht mit dem Artikel übereinstimmt; „genre:Science-Fiction“ macht. Beim Textwertabgleich wird zwischen Groß- und Kleinschreibung unterschieden. Sonderzeichen werden nicht entfernt. Bei „false“ wird der Text in Token umgewandelt. Lautet der Wert beispielsweise „Science-Fiction“ die Abfragen „genre:science“ und „genre:fiktion“ mit dem Element übereinstimmt.

HtmlPropertyOptions

Die Optionen für HTML-Eigenschaften.

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

object (RetrievalImportance)

Gibt die Wichtigkeit der Tokens für die Suchqualität im Feld an, wenn sie für den Abruf verwendet werden. Kann nur auf STANDARD oder NONE gesetzt werden.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Beschreibt, wie die Property als Suchoperator verwendet werden soll, sofern festgelegt.

HtmlPropertyOptions.HtmlOperatorOptions

Wird verwendet, um einen Suchoperatoren für HTML-Eigenschaften bereitzustellen. Dies ist optional. Mit den Operatoren „query.search“ können Nutzer die Suchanfrage 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 Anfrage zum Isolieren der HTML-Eigenschaft erforderlich ist. Wenn deroperatorName beispielsweise subject und der Name der Eigenschaft subjectLine ist, zeigen Abfragen wie subject:<value> nur Ergebnisse an, wenn der Wert der Eigenschaft namens subjectLine mit <value> übereinstimmt. Im Gegensatz dazu gibt eine Suche mit demselben &lt;value&gt;-Operator ohne Operator alle Elemente zurück, bei denen &lt;value&gt; mit dem Wert einer HTML-Eigenschaft 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.

PropertyDisplayOptions

Die Anzeigeoptionen für eine Eigenschaft.

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

string

Das benutzerfreundliche Label für die Eigenschaft, das verwendet wird, wenn die Eigenschaft für die Anzeige in ObjectDisplayOptions angegeben wird. Falls angegeben, wird die Anzeige vor den Eigenschaftswerten angezeigt, wenn die Eigenschaft Teil der Objektanzeigeoptionen ist. Wenn der Attributwert beispielsweise „1“ ist, ist der Wert alleine möglicherweise kein nützlicher Kontext für den Nutzer. Wenn der angegebene Anzeigename „Priorität“ lautete, wird dem Nutzer „Priorität : 1“ angezeigt in den Suchergebnissen angezeigt, die Nutzern einen klaren Kontext bietet. Dies ist OPTIONAL. Falls nicht angegeben, werden nur die Eigenschaftswerte angezeigt. Die maximale Länge beträgt 64 Zeichen.