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ługo trwających operacji (LRO) uruchomionych obecnie dla tego schematu. Po zmodyfikowaniu schematu poczekaj na zakończenie operacji, zanim zindeksujesz dodatkową treść.

ObjectDefinition

Definicja obiektu w źródle danych.

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

string

Nazwa obiektu, która następnie określa jego typ. W przypadku próśb o zindeksowanie produktów pole objectType powinno mieć tę wartość. Jeśli na przykład nazwa to Dokument, żądania indeksowania elementów typu Dokument powinny ustawić wartość objectType na 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) oraz cyfry (0–9). Maksymalna długość to 256 znaków.

options

object (ObjectOptions)

Opcjonalne opcje związane z obiektem.

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 Cloud Search.

suggestionFilteringOperators[]

string

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

UWAGA: parametry „objecttype”, „type” i „mimetype” są już obsługiwane. Ta właściwość służy do konfigurowania operatorów związanych ze schematem.

Mimo że jest to tablica, można określić tylko jeden operator. To jest tablica pozwalająca na rozszerzanie jej w przyszłości.

Mapowanie na większą liczbę właściwości w tym samym obiekcie nie jest 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 właściwość dotyczącą aktualności, która ma być używana podczas dostosowywania pozycji w rankingu wyników wyszukiwania. Nowsze, nowsze daty oznaczają wyższą jakość. Używaj opcji częstotliwości aktualizacji, która najlepiej sprawdza się w przypadku Twoich danych. W przypadku dokumentów udziału plików najbardziej istotny jest czas ostatniej modyfikacji. W przypadku danych o wydarzeniach w kalendarzu bardziej trafnym wskaźnikiem aktualności jest godzina, w której ma ono miejsce. W ten sposób wydarzenia w kalendarzu, które mają miejsce bliżej chwili wyszukiwania, są uważane za wyższą jakość i odpowiednio pozycjonowane.

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

string

Ta właściwość wskazuje poziom aktualności obiektu w indeksie. Jeśli jest skonfigurowana, ta właściwość musi być usługą najwyższego poziomu w obrębie obiektu property definitions i musi mieć typ timestamp type lub date type. W przeciwnym razie interfejs Indexing API używa updateTime jako wskaźnika aktualności. Maksymalna długość to 256 znaków.

Gdy do obliczania aktualności danych używana jest usługa, wartość domyślna to 2 lata od bieżącej daty.

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 z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".

ObjectDisplayOptions

Opcje wyświetlania obiektu.

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

string

Etykieta przyjazna dla użytkownika wyświetlana w wynikach wyszukiwania, która wskazuje typ elementu. Ta wartość jest OPCJONALNA. Jeśli jej nie podasz, 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 metawierszach wyników wyszukiwania. Wartości właściwości są wyświetlane w podanej tu kolejności. Jeśli usługa zawiera wiele wartości, wszystkie są wyświetlane przed kolejnymi usługami. Z tego powodu zaleca się określenie właściwości liczby pojedynczej, a nie powtórzenie ich z tej listy. Wszystkie właściwości muszą ustawić isReturnable na wartość prawda. Maksymalna liczba metalinii to 3.

ObjectDisplayOptions.Metaline

Metawiersz to lista właściwości wyświetlanych wraz z wynikiem wyszukiwania w celu określenia kontekstu.

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

object (ObjectDisplayOptions.DisplayedProperty)

Lista wyświetlanych właściwości metadanych. Maksymalna liczba właściwości to 5.

ObjectDisplayOptions.DisplayedProperty

Odwołanie do właściwości najwyższego poziomu w obiekcie, która powinna być wyświetlana w wynikach wyszukiwania. Wartości wybranych właściwości wyświetlają się w wynikach wyszukiwania razem z właściwością display label, jeśli została ona określona. Jeśli nie określisz etykiety wyświetlanej, wyświetlą się 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ą w schemacie, podczas próby aktualizacji schematu pojawi 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 produktów wysyłane do interfejsu Indexing API powinny mieć ustawioną wartość property name na poziomie tej wartości. Jeśli na przykład nazwa to subject_line, to w przypadku żądań indeksowania elementów dokumentów z polami tematu wartość name powinna być równa subject_line. Użyj jej jako identyfikatora właściwości obiektu. Po zarejestrowaniu jako właściwości 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) oraz cyfry (0–9). Maksymalna długość to 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, oznacza to, ż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ększej przestrzeni i większej przepustowości łącza na zapytania, co wpływa na wydajność w dużych zbiorach danych. Ustaw tutaj wartość true (prawda) tylko wtedy, gdy to pole jest wymagane dla wyników wyszukiwania. Wartość nie może mieć wartości prawda w przypadku właściwości, których typ jest obiektem.

isRepeatable

boolean

Wskazuje, że dla właściwości może być widocznych wiele wartości. Na przykład dokument ma tylko 1 opis, ale może zawierać wiele komentarzy. Wartość nie może mieć wartości prawda w przypadku właściwości, których typ jest wartością logiczną. Jeśli zasada ma wartość Fałsz, właściwości zawierające więcej niż 1 wartość powodują odrzucenie prośby o zindeksowanie danego elementu.

isSortable

boolean

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

isFacetable

boolean

Wskazuje, że tej właściwości można używać do generowania aspektów. Wartość nie może mieć wartości prawda w przypadku właściwości, których typ to obiekt. Aby 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 tekstowych.

isSuggestable

boolean

Wskazuje, że tej właściwości można używać do generowania sugestii dotyczących zapytań.

isWildcardSearchable

boolean

Wskazuje, że użytkownicy mogą wyszukiwać tę właściwość przy użyciu symboli wieloznacznych. Obsługiwane tylko w przypadku właściwości Tekst. Aby ustawić tę opcję, atrybut IsReturnable musi mieć wartość true (prawda). W danym źródle danych jako wartość isWildcardSearchable można oznaczyć maksymalnie 5 właściwości. Więcej informacji znajdziesz w sekcji 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 Cloud Search, jeśli została określona do wyświetlania w obiekcie display options obiektu.

Pole sumy property_options. Opcje specyficzne dla danego typu, które określają sposób indeksowania i używania usługi. W przypadku, gdy te opcje powinny być domyślną opcją dla danego typu, to pole 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. Tej opcji można użyć tylko wtedy, gdy isRepeatable ma wartość false (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 w rankingu zgodnie z zasadą ordered ranking. Prośby o zindeksowanie z wartościami mniejszymi niż minimalna są akceptowane i pozycjonowane z taką samą wagą jak 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 w rankingu zgodnie z zasadą ordered ranking. Żądania indeksowania z wartościami większymi niż maksymalna są akceptowane i pozycjonowane z taką samą wagą jak produkty zindeksowane z wartością maksymalną.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Jeśli jest ustawiony, określa, jak należy używać liczby całkowitej jako operatora wyszukiwania.

integerFacetingOptions

object (IntegerFacetingOptions)

Jeśli jest ustawiony, opisuje opcje określania 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 „Facetable”.

IntegerPropertyOptions.OrderedRanking

Służy do określania sposobu wyznaczania pozycji liczby całkowitej w stosunku do innych wartości. Liczba całkowita z wyższą pozycją w rankingu oznacza większe znaczenie. Na przykład w niektórych źródłach danych niższy priorytet oznacza większe znaczenie, a w innych – wyższy.

Wartości w polu enum
NO_ORDER Nie ma żadnej pozycji w rankingu dla usługi. Wyniki nie są dostosowywane według wartości tej właściwości.
ASCENDING Ta usługa jest wyświetlana w kolejności rosnącej. Niższe wartości oznaczają niższą pozycję w rankingu.
DESCENDING Ta usługa jest posortowana w kolejności malejącej. Niższe wartości oznaczają wyższą pozycję w rankingu.

IntegerPropertyOptions.IntegerOperatorOptions

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

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

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości liczby całkowitej. Jeśli na przykład operatorNameName ma wartość Priority, a nazwa właściwości to PriorityVal, zapytania typu Priority:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie PriorityVal odpowiada wartości <value>. Z kolei wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w przypadku których <value> odpowiada wartości dowolnej właściwości ciągu znaków lub tekstu w polu treści. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

lessThanOperatorName

string

Wskazuje nazwę operatora wymaganą w zapytaniu, by wyodrębnić właściwość liczby całkowitej za pomocą operatora „mniejsze niż”. Na przykład jeśli wartość właściwości lessThanOperatorName ma wartość priorytet poniżej, a nazwa właściwości to PriorityVal, zapytania typu Priorytet poniżej:<wartość> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie PriorityVal jest mniejsza 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 wymaganą w zapytaniu, by wyodrębnić właściwość liczb całkowitych za pomocą operatora „większe niż”. Na przykład jeśli wartość właściwości GreatThanOperatorName ma wyższy priorytet niż <value>, a nazwa właściwości to PriorityVal, zapytania typu PriorityVal wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie 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 podwójnej precyzji.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

Jeśli jest ustawiony, określa, jak należy używać liczby zmiennoprzecinkowej jako operatora wyszukiwania.

DoublePropertyOptions.DoubleOperatorOptions

Służy do udostępniania operatora wyszukiwania właściwości podwójnego. Jest to opcjonalne. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem przeszukiwanego elementu.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora, która jest wymagana w zapytaniu, aby można było użyć właściwości podwójnego przy sortowaniu 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 ustawiony, 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. Jest to opcjonalne. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem przeszukiwanego elementu.

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

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości sygnatury czasowej. Jeśli na przykład operatorNameName to closedon, a nazwa właściwości to closeDate, zapytania w rodzaju closedon:<value> wyświetlą wyniki tylko wtedy, gdy wartość właściwości o nazwie closeDate będzie zgodna z wartością <value>. Z kolei wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w których element <value> odpowiada wartości dowolnej właściwości ciągu znaków lub tekstu w polu treści. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

lessThanOperatorName

string

Wskazuje nazwę operatora wymaganą w zapytaniu, aby wyodrębnić właściwość sygnatury czasowej za pomocą operatora „mniej niż”. Na przykład jeśli wartość właściwości lessThanOperatorName to closedbefore i nazwa właściwości to closedDate, zapytania typu closedbefore:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie 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 wymaganą w zapytaniu, aby wyodrębnić właściwość sygnatury czasowej za pomocą operatora „większe niż”. Na przykład jeśli wartość właściwości GreatThanOperatorName to closedafter, a nazwa właściwości to closedDate, zapytania typu closedafter:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie closeDate jest późniejsza niż wartość właściwości <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 ustawiony, określa, w jaki sposób wartość logiczna powinna być używana jako operator wyszukiwania.

BooleanPropertyOptions.BooleanOperatorOptions

Służy do podawania operatora wyszukiwania właściwości logicznych. Jest to opcjonalne. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem przeszukiwanego elementu.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości logicznej. Jeśli na przykład operatorNameName ma wartość closed, a nazwa właściwości to isClosed, zapytania takie jak closed:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie isClosed odpowiada parametrowi <value>. Natomiast wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w których element <value> odpowiada wartości dowolnej właściwości ciągu znaków lub tekstu w polu treści. 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ą obiekt zagnieżdżony. Jeśli na przykład ta właściwość reprezentuje adres pocztowy, obiekt subobjectMethod może mieć nazwy street, city i state. Maksymalna liczba elementów to 1000.

EnumPropertyOptions

Opcje właściwości wyliczenia, które umożliwiają zdefiniowanie ograniczonego zestawu ciągów znaków pasujących do zapytań użytkowników, ustawianie rankingów dla tych wartości ciągów oraz zdefiniowanie nazwy operatora, która zostanie powiązana z tymi ciągami, dzięki czemu użytkownicy będą mogli zawężać 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 dozwoloną wartość wyliczeniową i powiązać tę wartość z nazwą operatora Priority. Dzięki temu użytkownicy wyszukiwarki mogą dodać do zapytania Priorytet:p0 i ograniczyć zbiór wyników tylko do tych elementów zindeksowanych 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 wyliczenia. Wszystkie pary EnumValuepairs muszą zawierać wartość ciągu. Jeśli podasz liczbę całkowitą dla jednej wartości EnumValuepairs, wszystkie możliwe parametry EnumValuepairs muszą określać wartość całkowitą. Zarówno wartość ciągu, jak i liczba całkowita muszą być unikalne wśród wszystkich możliwych wartości. Po ustawieniu wartości nie można ich usuwać ani modyfikować. Jeśli podasz uporządkowany ranking i uważasz, że w przyszłości można wstawić dodatkowe wartości wyliczeniowe, pozostaw luki w początkowych wartościach całkowitych, aby umożliwić dodanie wartości pomię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 dla wyliczenia określającego sposób, w jaki wartości całkowite podane w możliwych parach EnumValuePary są używane do ustalania pozycji wyników. Jeśli zostanie określona, musisz podać wartości całkowite dla wszystkich możliwych wartości EnumValueSparuj dla tej właściwości. Tej opcji można użyć tylko wtedy, gdy isRepeatable ma wartość false (fałsz).

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Jeśli jest ustawiony, określa, w jaki sposób wyliczenie ma być używane jako operator wyszukiwania.

EnumPropertyOptions.EnumValuePair

Para wartości wyliczeniowych definiuje 2 rzeczy: wymaganą wartość ciągu znaków i opcjonalną liczbę całkowitą. Wartość ciągu określa potrzebne hasło w zapytaniu wymagane do pobrania danego elementu, np. p0 w przypadku elementu priorytetowego. Wartość liczby całkowitej określa pozycję danej wartości ciągu w porównaniu z innymi wartościami wyliczonymi dla tej samej właściwości. Możesz np. powiązać wartość p0 z 0 i zdefiniować inną parę wyliczeniową, np. p1 i 1. Aby ustawić ranking danej wartości w odniesieniu do innych wartości wyliczonych dla tej samej nazwy właściwości, musisz użyć wartości całkowitej w połączeniu z właściwością ordered ranking. W tym przypadku kolejność w rankingu DESCENDING dla właściwości priorytetu powoduje wyższą pozycję w rankingu elementów zindeksowanych z wartością p0 w porównaniu do elementów zindeksowanych z wartością p1. W przypadku braku określonej kolejności produktów wartość będąca liczbą całkowitą nie ma wpływu na ranking produktów.

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

string

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

integerValue

integer

Wartość całkowita argumentu EnumValueSparuj, która nie może być ujemna. Opcjonalnie.

EnumPropertyOptions.OrderedRanking

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

Wartości w polu enum
NO_ORDER Nie ma żadnej pozycji w rankingu dla usługi. Wyniki nie są dostosowywane według wartości tej właściwości.
ASCENDING Ta usługa jest wyświetlana w kolejności rosnącej. Niższe wartości oznaczają niższą pozycję w rankingu.
DESCENDING Ta usługa jest posortowana w kolejności malejącej. Niższe wartości oznaczają wyższą pozycję w rankingu.

EnumPropertyOptions.EnumOperatorOptions

Służy do udostępniania operatora wyszukiwania właściwości wyliczenia. Jest to opcjonalne. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem przeszukiwanego elementu. Jeśli na przykład nie podasz żadnego operatora dla właściwości priorytetu z możliwymi wartościami p0 i p1, zapytanie zawierające hasło p0 zwróci elementy, które mają p0 jako wartość właściwości Priority, a także elementy, które zawierają ciąg p0 w innych polach. Jeśli podasz w wyliczeniu nazwę operatora, np. Priority, użytkownicy będą mogli za jego pomocą zawęzić wyniki tylko do elementów, które mają jako wartość tej właściwości p0 i zapytanie Priority:p0.

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości wyliczenia. Jeśli na przykład operatorNameName ma wartość Priority, a nazwa właściwości to PriorityVal, zapytania typu Priority:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie PriorityVal odpowiada wartości <value>. Z kolei wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w przypadku których <value> odpowiada wartości dowolnej właściwości ciągu znaków lub tekstu w polu treści. 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życia daty jako operatora wyszukiwania.

DatePropertyOptions.DateOperatorOptions

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

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

string

Wskazuje rzeczywisty ciąg wymagany w zapytaniu w celu wyodrębnienia właściwości daty. Załóżmy, że obiekt schematu śledzenia problemów ma właściwość o nazwie closeDate, która określa operator z operatorem closedon. W przypadku wyszukiwań tych danych zapytania takie jak closedon:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości closeDate jest zgodna z wartością <value>. Z kolei wyszukiwanie zawierające taki sam element <value> bez operatora zwraca wszystkie elementy, w których element <value> odpowiada wartości którejkolwiek właściwości ciągu lub tekstu znajdującego się w polu treści 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 wymaganą w zapytaniu, aby wyodrębnić właściwość daty za pomocą operatora „mniej niż”. Na przykład jeśli wartość właściwości lessThanOperatorName to closedbefore i nazwa właściwości to closedDate, zapytania typu closedbefore:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie 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 wymaganą w zapytaniu, aby wyodrębnić właściwość daty za pomocą operatora „większe niż”. Na przykład jeśli wartość właściwości GreatThanOperatorName to closedafter, a nazwa właściwości to closedDate, zapytania typu closedafter:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie closeDate jest późniejsza niż wartość właściwości <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 ustawiony, określa, jak należy używać właściwości jako operatora wyszukiwania.

RetrievalImportance

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

enum (RetrievalImportance.Importance)

Wskazuje znaczenie usługi w rankingu, gdy zostanie dopasowane podczas pobierania. Po ustawieniu znaczenia tokena usługi nie można już zmienić.

RetrievalImportance.Importance

Wartości w polu enum
DEFAULT Dopasuj tekst do treści.
HIGHEST Dopasowanie do tytułu produktu należy potraktować jako dopasowanie do siebie.
HIGH Traktuj dopasowanie o większym znaczeniu niż tekst główny.
LOW Mniej ważne znaczenie 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 właściwości tekstu. Jest to opcjonalne. Operatory query.search pozwalają użytkownikom ograniczyć zapytanie do określonych pól związanych z typem przeszukiwanego elementu.

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

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości tekstowej. Jeśli na przykład operatorNameName to subject, a nazwa właściwości to subjectLine, zapytania w rodzaju subject:<value> wyświetlają wyniki tylko wtedy, gdy wartość właściwości o nazwie subjectLine jest zgodna z wartością <value>. Natomiast wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w których element <value> odpowiada wartości dowolnej właściwości tekstowej lub tekstu znajdującego się w polu treści danego elementu. Nazwa operatora może zawierać tylko małe litery (a–z). Maksymalna długość to 32 znaki.

exactMatchWithOperator

boolean

Jeśli ma wartość prawda, wartość tekstowa jest tokenizowana jako jedna wartość niepodzielna podczas wyszukiwania operatorów i dopasowań aspektów. Jeśli np. nazwa operatora to „genre”, a wartością jest „science-fiction”, ograniczenia zapytania „genre:science” i „genre:fiction” nie pasują do elementu, natomiast operator „genre:science-fiction” tak. W dopasowaniu wartości tekstowych wielkość liter ma znaczenie i nie powoduje usunięcia znaków specjalnych. Jeśli ma wartość false (fałsz), tekst jest tokenizowany. Jeśli wartość to np. „science-fiction”, do zapytania pasują zapytania „genre:science” i „genre:fiction”.

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 ustawiony, określa, jak należy używać właściwości jako operatora wyszukiwania.

HtmlPropertyOptions.HtmlOperatorOptions

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

Zapis JSON
{
  "operatorName": string
}
Pola
operatorName

string

Wskazuje nazwę operatora wymaganą w zapytaniu w celu wyodrębnienia właściwości HTML. Jeśli na przykład operatorNameName to subject, a nazwa właściwości to subjectLine, zapytania w rodzaju subject:<value> wyświetlą wyniki tylko wtedy, gdy wartość właściwości o nazwie subjectLine będzie zgodna z wartością <value>. Natomiast wyszukiwanie wykorzystujące ten sam element <value> bez operatora zwraca wszystkie elementy, w których element <value> odpowiada wartości dowolnej właściwości HTML lub tekstu w polu treści. 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 dla właściwości używanej, jeśli właściwość została określona do wyświetlenia w obiekcie ObjectDisplayOptions. Jeśli właściwość została podana, etykieta wyświetlana jest widoczna przed wartościami właściwości, gdy właściwość wchodzi w skład opcji wyświetlania obiektu. Jeśli np. wartość właściwości to „1”, sama wartość może nie być przydatnym kontekstem dla użytkownika. Jeśli nadano wyświetlaną nazwę typu „Priority”, użytkownik widzi w wynikach wyszukiwania pozycję „Priorytet : 1”, co zapewnia użytkownikom wyszukującym jasny kontekst. Jest to wartość OPCJONALNA. Jeśli jej nie podasz, wyświetlane będą tylko wartości właściwości. Maksymalna długość to 64 znaki.