Schema

Definicja schematu źródła danych.

Zapis JSON
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Pola
objectDefinitions[]

object (ObjectDefinition)

Lista obiektów najwyższego poziomu dla źródła danych. Maksymalna liczba elementów to 10.

operationIds[]

string

Identyfikatory długotrwałych operacji (LRO) aktualnie uruchomionych dla tego schematu. Po zmodyfikowaniu schematu poczekaj na zakończenie operacji, zanim zindeksujesz dodatkowe treści.

ObjectDefinition

Definicja obiektu w źródle danych.

Zapis JSON
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Pola
name

string

Nazwa obiektu, która określa jego typ. Prośby o zindeksowanie elementów powinny ustawić w polu objectType tę wartość. Jeśli na przykład nazwa to Dokument, żądania indeksowania elementów typu Dokument powinny mieć wartość objectType równa Dokument. Każda definicja obiektu musi mieć niepowtarzalną nazwę w schemacie. Nazwa musi zaczynać się od litery i może zawierać tylko litery (A–Z, a–z) i cyfry (0–9). Maksymalna długość wynosi 256 znaków.

options

object (ObjectOptions)

Opcjonalne opcje specyficzne dla obiektu.

propertyDefinitions[]

object (PropertyDefinition)

Definicje właściwości obiektu. Maksymalna liczba elementów to 1000.

ObjectOptions

Opcje obiektu.

Zapis JSON
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Pola
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Opcje aktualności obiektu.

displayOptions

object (ObjectDisplayOptions)

Opcje określające sposób wyświetlania obiektu na stronie wyników w Cloud Search.

suggestionFilteringOperators[]

string

Operatory, których można używać do filtrowania sugestii. W przypadku interfejsu query.suggest API tylko wymienione tutaj operatory będą uwzględniane w zasadzie FilterOptions. Obsługiwane są tylko operatory TEXT i ENUM.

UWAGA: "objecttype", "type" i „typ MIME” są już obsługiwane. Ta właściwość służy do konfigurowania operatorów specyficznych dla schematu.

Mimo że jest to tablica, można określić tylko jeden operator. To jest tablica na potrzeby przyszłego rozszerzania.

Operatory mapowane na wiele usług w obrębie tego samego obiektu nie są obsługiwane. Jeśli operator obejmuje różne typy obiektów, tę opcję należy ustawić raz dla każdej definicji obiektu.

ObjectOptions.FreshnessOptions

Wskazuje, której właściwości aktualności należy użyć podczas dostosowywania rankingu wyszukiwania elementu. Nowsze, nowsze daty oznaczają wyższą jakość. Użyj opcji aktualności, która najlepiej działa z Twoimi danymi. W przypadku dokumentów udziału plików najbardziej trafny jest czas ostatniej modyfikacji. W przypadku danych wydarzeń z kalendarza bardziej przydatnym wskaźnikiem aktualności jest godzina wystąpienia wydarzenia. W ten sposób wydarzenia w kalendarzu, które nastąpiły w najbliższym czasie, gdy użytkownik wyszukuje zapytanie, są uważane za lepszej jakości i mają odpowiednią pozycję w rankingu.

Zapis JSON
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Pola
freshnessProperty

string

Ta właściwość wskazuje poziom aktualności obiektu w indeksie. Jeśli jest ustawiona, musi być usługą najwyższego poziomu w obrębie property definitions i musi to być timestamp type lub date type. W przeciwnym razie jako wskaźnik aktualności będzie używać interfejsu indeksowania API: updateTime. Maksymalna długość wynosi 256 znaków.

Gdy usługa jest używana do obliczania aktualności wyników, domyślnie przyjmuje się wartość 2 lata od bieżącego momentu.

freshnessDuration

string (Duration format)

Czas, po którym obiekt powinien być uznawany za nieaktualny. Wartość domyślna to 180 dni (w sekundach).

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".

ObjectDisplayOptions

Opcje wyświetlania obiektu.

Zapis JSON
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Pola
objectDisplayLabel

string

Przyjazna dla użytkownika etykieta wyświetlana w wynikach wyszukiwania, informująca o typie elementu. To jest OPCJONALNE. jeśli nie zostanie podany, etykieta obiektu nie będzie wyświetlana w wierszu kontekstu wyników wyszukiwania. Maksymalna długość to 64 znaki.

metalines[]

object (ObjectDisplayOptions.Metaline)

Określa właściwości wyświetlane w metaliniach wyników wyszukiwania. Wartości właściwości są wyświetlane w podanej tutaj kolejności. Jeśli właściwość zawiera kilka wartości, wszystkie są wyświetlane przed następnymi właściwościami. Z tego względu przed powtórzeniem właściwości na tej liście warto określać je po kolei. We wszystkich właściwościach isReturnable musi mieć wartość prawda. Maksymalna liczba metalinii to 3.

ObjectDisplayOptions.Metaline

Metaline to lista właściwości, które są wyświetlane razem z wynikiem wyszukiwania w celu podania kontekstu.

Zapis JSON
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Pola
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Lista wyświetlanych właściwości metalinii. Maksymalna liczba usług to 5.

ObjectDisplayOptions.DisplayedProperty

Odwołanie do właściwości najwyższego poziomu w obiekcie, która powinna wyświetlać się w wynikach wyszukiwania. Wartości wybranych właściwości są wyświetlane w wynikach wyszukiwania wraz z opisem właściwości display label, jeśli została określona. Jeśli nie określono etykiety wyświetlanej, wyświetlane są tylko wartości.

Zapis JSON
{
  "propertyName": string
}
Pola
propertyName

string

Nazwa właściwości najwyższego poziomu zdefiniowana w definicji właściwości obiektu. Jeśli nazwa nie jest zdefiniowaną właściwością schematu, podczas próby zaktualizowania schematu pojawia się błąd.

PropertyDefinition

Definicja właściwości w obiekcie.

Zapis JSON
{
  "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.
}
Pola
name

string

Nazwa usługi. Żądania indeksowania elementów wysyłane do interfejsu Indexing API powinny ustawić w polu property name tę wartość. Jeśli np. nazwa to subject_line, w prośbach o zindeksowanie elementów dokumentu z polami tematu wartość name tego pola powinna wynosić subject_line. Użyj nazwy jako identyfikatora właściwości obiektu. Po zarejestrowaniu się jako właściwość obiektu nie możesz ponownie użyć tej nazwy dla innej właściwości w tym obiekcie. Nazwa musi zaczynać się od litery i może zawierać tylko litery (A–Z, a–z) i cyfry (0–9). Maksymalna długość wynosi 256 znaków.

isReturnable

boolean

Wskazuje, że właściwość identyfikuje dane, które powinny być zwracane w wynikach wyszukiwania przez interfejs Query API. Jeśli ma wartość true, wskazuje, że użytkownicy interfejsu Query API mogą używać w wynikach pasujących pól właściwości. Przechowywanie pól wymaga jednak większego przydziału miejsca i wymaga większej przepustowości na potrzeby zapytań, co wpływa na wydajność dużych zbiorów danych. Ustaw tutaj wartość true (prawda) tylko wtedy, gdy pole jest potrzebne do wyświetlania wyników wyszukiwania. Nie można ustawić wartości prawda w przypadku właściwości, których typ jest obiektem.

isRepeatable

boolean

Wskazuje, że w danej usłudze dozwolonych jest wiele wartości. Na przykład dokument ma tylko 1 opis, ale może zawierać wiele komentarzy. Nie może mieć wartości prawda w przypadku właściwości, których typ jest wartością logiczną. Jeśli ma wartość Fałsz, właściwości, które zawierają więcej niż 1 wartość, powodują odrzucenie żądania indeksowania danego elementu.

isSortable

boolean

Wskazuje, że właściwość można używać do sortowania. Nie można ustawić wartości prawda w przypadku właściwości, które są powtarzalne. Nie można ustawić wartości prawda w przypadku właściwości, których typ to obiekt. Aby można było ustawić tę opcję, atrybut IsReturnable musi mieć wartość true (prawda). Obsługiwane tylko w przypadku właściwości wartości logicznej, daty, liczby zmiennoprzecinkowej, liczby całkowitej i sygnatury czasowej.

isFacetable

boolean

Wskazuje, że właściwość może być używana do generowania aspektów. Nie można ustawić wartości prawda w przypadku właściwości, których typ to obiekt. Aby można było ustawić tę opcję, atrybut IsReturnable musi mieć wartość true (prawda). Obsługiwane tylko w przypadku właściwości logicznych, wyliczeniowych, liczb całkowitych i tekstu.

isSuggestable

boolean

Wskazuje, że właściwość może służyć do generowania sugestii zapytań.

isWildcardSearchable

boolean

Wskazuje, że użytkownicy mogą wyszukiwać tę usługę przy użyciu symboli wieloznacznych. Obsługiwane tylko w przypadku właściwości tekstowych. Aby można było ustawić tę opcję, atrybut IsReturnable musi mieć wartość true (prawda). W danym źródle danych jako isWildcardSearchable można oznaczyć maksymalnie 5 właściwości. Więcej informacji znajdziesz w artykule Definiowanie właściwości obiektu.

displayOptions

object (PropertyDisplayOptions)

Opcje określające sposób wyświetlania właściwości na stronie wyników w Cloud Search, jeśli skonfigurowano ją do wyświetlania w display options obiektu.

Pole sumy property_options. Opcje zależne od typu, które określają sposób indeksowania i używania usługi. Jeśli opcje powinny być domyślnymi opcjami dla danego typu, pole to nadal musi być ustawione na jeden z typów. Jeśli to pole nie jest skonfigurowane, aktualizacje schematu są odrzucane. property_options może mieć tylko jedną z tych wartości:
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

Opcje właściwości liczb całkowitych.

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

enum (IntegerPropertyOptions.OrderedRanking)

Służy do określania uporządkowanego rankingu liczby całkowitej. Można użyć tylko wtedy, gdy isRepeatable ma wartość fałsz.

minimumValue

string (Int64Value format)

Minimalna wartość nieruchomości. Minimalne i maksymalne wartości właściwości służą do ustalania pozycji wyników według tych zasad: ordered ranking. Żądania indeksowania z wartościami mniejszymi od wartości minimalnej są akceptowane i porządkowane z tą samą wagą co produkty zindeksowane z wartością minimalną.

maximumValue

string (Int64Value format)

Maksymalna wartość właściwości. Minimalne i maksymalne wartości właściwości służą do ustalania pozycji wyników według tych zasad: ordered ranking. Żądania indeksowania z wartościami wyższymi niż maksymalna są akceptowane i pozycjonowane z tą samą wagą co produkty zindeksowane z wartością maksymalną.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Jeśli jest ustawiony, określa sposób używania liczby całkowitej jako operatora wyszukiwania.

integerFacetingOptions

object (IntegerFacetingOptions)

Jeśli jest ustawiony, opisuje opcje aspektów liczb całkowitych dla danej właściwości liczby całkowitej. Odpowiednia właściwość liczby całkowitej powinna być oznaczona jako „IsFacetable”.

IntegerPropertyOptions.OrderedRanking

Służy do określania pozycji liczby całkowitej w rankingu względem innych wartości. Liczba całkowita o wyższym uporządkowanym rankingu sugeruje większe znaczenie. Na przykład w niektórych źródłach danych niższy priorytet oznacza większą ważność, a w innych wyższy priorytet.

Wartości w polu enum
NO_ORDER Brak rankingu dla usługi. Wyniki nie są dostosowywane na podstawie wartości tej właściwości.
ASCENDING Ta usługa jest posortowana w kolejności rosnącej. Niższe wartości oznaczają niższe pozycje w rankingu.
DESCENDING Ta usługa jest posortowana w kolejności malejącej. Mniejsze wartości oznaczają wyższą pozycję w rankingu.

IntegerPropertyOptions.IntegerOperatorOptions

Służy do udostępniania operatora wyszukiwania dla właściwości liczb całkowitych. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości liczby całkowitej. Jeśli na przykład operatorName ma wartość Priorytet, a nazwa właściwości to PriorityVal, zapytania takie jak Priority:<value> pokażą tylko wyniki, w których wartość właściwości PriorityVal odpowiada <value>. Natomiast wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; jest zgodne z wartością dowolnego elementu ciągu tekstowego lub dowolnym tekstem w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

lessThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości liczby całkowitej przy użyciu operatora mniejszości. Na przykład: jeśli lessThanOperatorName ma wartość Priority below, a nazwa właściwości to PriorityVal, to zapytania takie jak Priority below:<value> pokażą tylko wyniki, w których wartość właściwości o nazwie PriorityVal<value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

greaterThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości liczby całkowitej przy użyciu operatora „większe niż”. Na przykład: jeśli większościąkroThanOperatorName ma wartość Priority above, a nazwa właściwości to PriorityVal, to zapytania takie jak Priority above:<value> pokażą tylko wyniki wtedy, gdy wartość właściwości PriorityVal jest większa niż <value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

DoublePropertyOptions

Opcje właściwości typu double.

Zapis JSON
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Pola
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Jeśli jest ustawiony, opisuje sposób użycia liczby zmiennoprzecinkowej jako operatora wyszukiwania.

DoublePropertyOptions.DoubleOperatorOptions

Służy do wskazywania operatora wyszukiwania dla obiektów typu double. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu użycia właściwości podwójnej precyzji do sortowania lub jako aspektu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

TimestampPropertyOptions

Opcje właściwości sygnatury czasowej.

Zapis JSON
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Pola
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Jeśli jest ustawiona, określa, jak należy używać sygnatury czasowej jako operatora wyszukiwania.

TimestampPropertyOptions.TimestampOperatorOptions

Służy do udostępniania operatora wyszukiwania właściwości sygnatury czasowej. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości sygnatury czasowej. Jeśli na przykład operatorName to closedon, a nazwa właściwości to closeDate, zapytania takie jak closedon:<value> powodują wyświetlenie wyników tylko wtedy, gdy wartość właściwości o nazwie closeDate jest zgodna z wartością <value>. Natomiast wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; jest zgodne z wartością dowolnego elementu ciągu tekstowego lub dowolnym tekstem w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

lessThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości sygnatury czasowej przy użyciu operatora mniejszości. Jeśli na przykład mniejThanOperatorName to closedbefore, a nazwa usługi to closeDate, zapytania takie jak closedbefore:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości closeDate jest wcześniejsza niż wartość <value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

greaterThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości sygnatury czasowej przy użyciu operatora „większe niż”. Jeśli na przykład większeThanOperatorName to closedafter, a nazwa usługi to closeDate, zapytania takie jak closedafter:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości closeDate jest późniejsza niż wartość <value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

BooleanPropertyOptions

Opcje właściwości wartości logicznych.

Zapis JSON
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Pola
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Jeśli jest ustawiona, opisuje sposób używania wartości logicznej jako operatora wyszukiwania.

BooleanPropertyOptions.BooleanOperatorOptions

Służy do udostępniania operatora wyszukiwania dla właściwości logicznych. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu do wyodrębnienia właściwości logicznej. Jeśli na przykład operatorName to closed, a nazwa właściwości to isClosed, zapytania takie jak closed:<value> pokażą tylko wyniki, w których wartość właściwości isClosed jest zgodna z wartością <value>. Natomiast wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; jest zgodne z wartością dowolnego elementu ciągu tekstowego lub dowolnym tekstem w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

ObjectPropertyOptions

Opcje właściwości obiektu.

Zapis JSON
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Pola
subobjectProperties[]

object (PropertyDefinition)

Właściwości obiektu podrzędnego. Te właściwości reprezentują zagnieżdżony obiekt. Jeśli na przykład właściwość reprezentuje adres pocztowy, obiekt podrzędny może mieć nazwy street (ulica), city (miasto) i state (stan). Maksymalna liczba elementów to 1000.

EnumPropertyOptions

Opcje właściwości wyliczeniowych, które umożliwiają zdefiniowanie ograniczonego zestawu ciągów znaków pasujących do zapytań użytkowników, ustawianie rankingów dla tych ciągów oraz zdefiniowanie nazwy operatora do powiązania z tymi ciągami znaków, aby użytkownicy mogli zawęzić wyniki tylko do elementów o określonej wartości. Na przykład w przypadku elementów w systemie śledzenia żądań z informacjami o priorytecie możesz zdefiniować p0 jako dopuszczalną wartość wyliczeniową i powiązać tę wartość z nazwą priorytetu operatora, tak aby użytkownicy korzystający z wyszukiwarki mogli dodać do zapytania parametr priorytet:p0, by ograniczyć zbiór wyników tylko do tych elementów, które zostały zindeksowane tylko z wartością p0.

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

object (EnumPropertyOptions.EnumValuePair)

Lista możliwych wartości właściwości wyliczeniowej. Wszystkie pary wartości EnumValuePairs muszą zawierać ciąg znaków. Jeśli podasz liczbę całkowitą dla jednej wartości parametru EnumValuePair, wszystkie możliwe wartości EnumValuePairs muszą podawać wartość całkowitą. Zarówno wartość ciągu znaków, jak i wartość całkowita muszą być niepowtarzalne wśród wszystkich możliwych wartości. Ustawionych wartości nie można usuwać ani modyfikować. Jeśli podajesz uporządkowany ranking i uważasz, że możesz wstawić dodatkowe wartości wyliczeniowe w przyszłości, pozostaw luki w początkowych wartościach całkowitych, aby umożliwić dodanie wartości między wcześniej zarejestrowanymi wartościami. Maksymalna liczba elementów to 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Służy do określania uporządkowanego rankingu wyliczenia, które określa sposób, w jaki wartości całkowite podane w możliwych parach wartości EnumValuePair są używane do ustalania pozycji wyników w rankingu. Jeśli została określona, należy podać wszystkie liczby całkowite dla wszystkich możliwych wartości EnumValuePair podanych dla tej właściwości. Można użyć tylko wtedy, gdy isRepeatable ma wartość fałsz.

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Jeśli jest ustawiony, określa sposób używania wyliczenia jako operatora wyszukiwania.

EnumPropertyOptions.EnumValuePair

Para wartości wyliczeniowych definiuje 2 elementy: wymaganą wartość ciągu tekstowego i opcjonalną liczbę całkowitą. Wartość ciągu określa niezbędne wyszukiwane hasło wymagane do pobrania tego elementu, na przykład p0 w przypadku elementu priorytetowego. Wartość liczby całkowita określa pozycję danej wartości ciągu w porównaniu z innymi wartościami wyliczonymi w przypadku tej samej usługi. Możesz na przykład powiązać wartość p0 z wartością 0 i zdefiniować kolejną parę wyliczeniową, taką jak p1 i 1. Aby ustawić ranking danej wartości w odniesieniu do innych wartości wyliczanych dla tej samej nazwy właściwości, musisz użyć wartości całkowitej w połączeniu z atrybutem ordered ranking. W tym przypadku kolejność DESCENDING dla właściwości priorytet skutkuje wyższą pozycją w rankingu w przypadku elementów zindeksowanych o wartości p0 w porównaniu z elementami indeksowanymi o wartości p1. Bez określonej kolejności w rankingu liczba całkowita nie ma wpływu na pozycję produktu w rankingu.

Zapis JSON
{
  "stringValue": string,
  "integerValue": integer
}
Pola
stringValue

string

Wartość ciągu znaków funkcji EnumValuePair. Maksymalna długość to 32 znaki.

integerValue

integer

Wartość całkowita parametru EnumValuePair, która nie może być ujemna. Opcjonalnie:

EnumPropertyOptions.OrderedRanking

Służy do określania kierunku rankingu liczby całkowitej EnumValuePair w odniesieniu do innych wartości całkowitych EnumValuePair. W przypadku niektórych właściwości mniejsze liczby całkowite oznaczają większe znaczenie, a w innych większe wartości.

Wartości w polu enum
NO_ORDER Brak rankingu dla usługi. Wyniki nie są dostosowywane na podstawie wartości tej właściwości.
ASCENDING Ta usługa jest posortowana w kolejności rosnącej. Niższe wartości oznaczają niższe pozycje w rankingu.
DESCENDING Ta usługa jest posortowana w kolejności malejącej. Mniejsze wartości oznaczają wyższą pozycję w rankingu.

EnumPropertyOptions.EnumOperatorOptions

Służy do udostępniania operatora wyszukiwania właściwości wyliczeniowych. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu. Jeśli np. nie podasz operatora dla właściwości wyliczeniowej Priority o możliwych wartościach p0 i p1, zapytanie zawierające hasło p0 zwróci elementy, w przypadku których wartością właściwości p0 jest p0, oraz wszystkie elementy, które zawierają ciąg p0 w innych polach. Jeśli podasz nazwę operatora dla wyliczenia, np. Priority, użytkownicy będą mogli używać tego operatora do zawężania wyników tylko do tych elementów, których wartość właściwości to p0, z następującym zapytaniem Priority:p0.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości wyliczenia. Jeśli na przykład operatorName ma wartość Priorytet, a nazwa właściwości to PriorityVal, zapytania takie jak Priority:<value> powodują wyświetlenie wyników tylko wtedy, gdy wartość właściwości o nazwie PriorityVal odpowiada <value>. Natomiast wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; jest zgodne z wartością dowolnego elementu ciągu tekstowego lub dowolnym tekstem w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

DatePropertyOptions

Opcje właściwości daty.

Zapis JSON
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Pola
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Jeśli jest ustawiony, określa sposób używania daty jako operatora wyszukiwania.

DatePropertyOptions.DateOperatorOptions

Opcjonalnie: Udostępnia operator wyszukiwania właściwości daty. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Pola
operatorName

string

Wskazuje rzeczywisty ciąg znaków wymagany w zapytaniu do wyodrębnienia właściwości daty. Załóżmy na przykład, że obiekt schematu śledzenia problemów ma właściwość o nazwie closeDate, która określa operator z operatoremNameName o wartości closedon. W przypadku wyszukiwania tych danych zapytania takie jak closedon:&lt;value&gt; powodują wyświetlenie wyników tylko wtedy, gdy wartość właściwości closedon:&lt;value&gt; jest zgodna z wartością closedon:&lt;value&gt;. Z kolei wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; odpowiada wartości dowolnych właściwości ciągu znaków lub tekstu w tym polu w przypadku zindeksowanego źródła danych. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

lessThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości date za pomocą operatora mniejszości. Jeśli na przykład mniejThanOperatorName to closedbefore, a nazwa usługi to closeDate, zapytania takie jak closedbefore:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości closeDate jest wcześniejsza niż wartość <value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

greaterThanOperatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości daty przy użyciu operatora „większe niż”. Jeśli na przykład większeThanOperatorName to closedafter, a nazwa usługi to closeDate, zapytania takie jak closedafter:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości closeDate jest późniejsza niż wartość <value>. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

TextPropertyOptions

Opcje właściwości tekstu.

Zapis JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Pola
retrievalImportance

object (RetrievalImportance)

Wskazuje znaczenie jakości wyszukiwania tokenów w polu używanych do pobierania.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Jeśli jest ustawiona, opisuje sposób korzystania z właściwości jako operatora wyszukiwania.

RetrievalImportance

Zapis JSON
{
  "importance": enum (RetrievalImportance.Importance)
}
Pola
importance

enum (RetrievalImportance.Importance)

Wskazuje znaczenie w rankingu, które jest przypisywane usłudze, gdy jest ona dopasowywana podczas pobierania. Po ustawieniu wartości tokena właściwości nie można zmienić jej ważności.

RetrievalImportance.Importance

Wartości w polu enum
DEFAULT Traktuj dopasowanie jako dopasowanie tekstu głównego.
HIGHEST Traktuj dopasowanie jako dopasowanie do tytułu produktu.
HIGH Traktuj dopasowanie ważniejsze niż tekst główny.
LOW Traktuj dopasowanie mniej ważne niż tekst główny.
NONE Nie dopasowuj do tego pola podczas pobierania. Tej właściwości można nadal używać do dopasowywania operatorów, określania aspektów i sugerowania w razie potrzeby.

TextPropertyOptions.TextOperatorOptions

Służy do udostępniania operatora wyszukiwania dla właściwości tekstowych. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu w celu wyodrębnienia właściwości tekstowej. Jeśli na przykład operatorName to subject, a nazwa właściwości to subjectLine, zapytania takie jak subject:<value> pokażą tylko wyniki, w których wartość właściwości o nazwie subjectLine odpowiada wartości <value>. Z kolei wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; odpowiada wartości dowolnych właściwości tekstowych lub tekstu zawartego w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

exactMatchWithOperator

boolean

Jeśli w wyszukiwaniu operatorów i dopasowaniach aspektu wartość tekstowa jest tokenizowana jako jedna wartość atomowa, Jeśli na przykład nazwą operatora jest „gatunek” Wartość to „science-fiction”, ograniczenie zapytania „genre:science” i „genre:fiction” nie pasuje do produktu; „genre:science-fiction” co robi. W dopasowywaniu wartości tekstowych rozróżniana jest wielkość liter i nie usuwa znaków specjalnych. Jeśli ma wartość false (fałsz), tekst jest tokenizowany. Jeśli na przykład wartość to „science-fiction” zapytania „genre:science” i „genre:fiction” pasuje do elementu.

HtmlPropertyOptions

Opcje właściwości HTML.

Zapis JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Pola
retrievalImportance

object (RetrievalImportance)

Wskazuje znaczenie jakości wyszukiwania tokenów w polu używanych do pobierania. Można ustawić tylko wartość DEFAULT lub BRAK.

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Jeśli jest ustawiona, opisuje sposób korzystania z właściwości jako operatora wyszukiwania.

HtmlPropertyOptions.HtmlOperatorOptions

Służy do udostępniania operatora wyszukiwania właściwości HTML. Nie jest to jednak wymagane. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem szukanego elementu.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu do wyodrębnienia właściwości HTML. Jeśli na przykład operatorName to subject, a nazwa właściwości to subjectLine, zapytania takie jak subject:<value> pokażą tylko wyniki, w których wartość właściwości o nazwie subjectLine odpowiada wartości <value>. Z kolei wyszukiwanie z tym samym atrybutem &lt;value&gt; bez operatora zwraca wszystkie elementy, w których &lt;value&gt; odpowiada wartości dowolnych właściwości HTML lub tekstu w polu treści elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

PropertyDisplayOptions

Opcje wyświetlania usługi.

Zapis JSON
{
  "displayLabel": string
}
Pola
displayLabel

string

Przyjazna dla użytkownika etykieta właściwości, która jest używana, jeśli właściwość ma być wyświetlana w ObjectDisplayOptions. Jeśli właściwość zostanie podana, etykieta wyświetlana jest wyświetlana przed wartościami właściwości, gdy właściwość jest częścią opcji wyświetlania obiektu. Jeśli na przykład wartość właściwości to „1”, sama wartość może nie być przydatnym kontekstem dla użytkownika. Jeśli wyświetlaną nazwą było „priorytet”, użytkownik widzi wartość „priorytet : 1”. w wynikach wyszukiwania, co zapewnia użytkownikom jasny kontekst. To jest OPCJONALNE. jeśli nie zostanie podana, wyświetlane będą tylko wartości właściwości. Maksymalna długość to 64 znaki.