Schema

La definizione dello schema per un'origine dati.

Rappresentazione JSON
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Campi
objectDefinitions[]

object (ObjectDefinition)

L'elenco degli oggetti di primo livello per l'origine dati. Il numero massimo di elementi è 10.

operationIds[]

string

ID delle operazioni a lunga esecuzione (LRO) attualmente in esecuzione per questo schema. Dopo aver modificato lo schema, attendi il completamento delle operazioni prima di indicizzare altri contenuti.

ObjectDefinition

La definizione di un oggetto all'interno di un'origine dati.

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

string

Il nome dell'oggetto, che ne definisce il tipo. Le richieste di indicizzazione degli articoli devono impostare il campo objectType su questo valore. Ad esempio, se name è Document, le richieste di indicizzazione per gli elementi di tipo Document devono impostare objectType su Document. Ogni definizione di oggetto deve avere un nome univoco all'interno di uno schema. Il nome deve iniziare con una lettera e può contenere solo lettere (A-Z, a-z) o numeri (0-9). La lunghezza massima è di 256 caratteri.

options

object (ObjectOptions)

Le opzioni facoltative specifiche per l'oggetto.

propertyDefinitions[]

object (PropertyDefinition)

Le definizioni delle proprietà dell'oggetto. Il numero massimo di elementi è 1000.

ObjectOptions

Le opzioni per un oggetto.

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

object (ObjectOptions.FreshnessOptions)

Le opzioni di aggiornamento per un oggetto.

displayOptions

object (ObjectDisplayOptions)

Le opzioni che determinano il modo in cui l'oggetto viene visualizzato nella pagina dei risultati di Cloud Search.

suggestionFilteringOperators[]

string

Operatori che possono essere utilizzati per filtrare i suggerimenti. Per l'API query.suggest, in FilterOptions verranno rispettati solo gli operatori menzionati qui. Sono supportati solo gli operatori TEXT ed ENUM.

NOTA: "objecttype", "type" e "mimetype" sono già supportati. Questa proprietà consente di configurare operatori specifici per lo schema.

Anche se si tratta di un array, è possibile specificare un solo operatore. Si tratta di un array per l'estensibilità futura.

Gli operatori che mappano a più proprietà all'interno dello stesso oggetto non sono supportati. Se l'operatore si estende a diversi tipi di oggetti, questa opzione deve essere impostata una volta per ogni definizione di oggetto.

ObjectOptions.FreshnessOptions

Indica quale proprietà di aggiornamento utilizzare per modificare il ranking nei risultati di ricerca di un articolo. Le date più recenti indicano una qualità migliore. Utilizza la proprietà dell'opzione di aggiornamento più adatta ai tuoi dati. Per i documenti condivisi, l'ora dell'ultima modifica è la più pertinente. Per i dati sugli eventi nel calendario, l'ora in cui si verifica l'evento è un indicatore di aggiornamento più pertinente. In questo modo, gli eventi nel calendario che si verificano più vicino al momento della query di ricerca sono considerati di qualità superiore e vengono classificati di conseguenza.

Rappresentazione JSON
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Campi
freshnessProperty

string

Questa proprietà indica il livello di aggiornamento dell'oggetto nell'indice. Se impostata, questa proprietà deve essere una proprietà di primo livello all'interno di property definitions e deve essere timestamp type o date type. In caso contrario, l'API Indexing utilizza updateTime come indicatore dell'aggiornamento. La lunghezza massima è di 256 caratteri.

Quando viene utilizzata una proprietà per calcolare l'aggiornamento, il valore predefinito è 2 anni a partire dall'ora corrente.

freshnessDuration

string (Duration format)

La durata dopo la quale un oggetto deve essere considerato obsoleto. Il valore predefinito è 180 giorni (in secondi).

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

ObjectDisplayOptions

Le opzioni di visualizzazione di un oggetto.

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

string

L'etichetta facile da usare da visualizzare nel risultato di ricerca per indicare il tipo di elemento. (Facoltativo) Se non viene fornito, l'etichetta dell'oggetto non viene visualizzata nella riga del contesto dei risultati di ricerca. La lunghezza massima è di 64 caratteri.

metalines[]

object (ObjectDisplayOptions.Metaline)

Definisce le proprietà visualizzate nelle metalinee dei risultati di ricerca. I valori delle proprietà vengono visualizzati nell'ordine indicato di seguito. Se una proprietà contiene più valori, tutti i valori vengono visualizzati prima delle proprietà successive. Per questo motivo, è buona norma specificare le proprietà singolari prima di quelle ripetute in questo elenco. Tutte le proprietà devono impostare isReturnable su true. Il numero massimo di metalinee è 3.

ObjectDisplayOptions.Metaline

Una metalinea è un elenco di proprietà che vengono visualizzate insieme al risultato di ricerca per fornire il contesto.

Rappresentazione JSON
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Campi
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

L'elenco delle proprietà visualizzate per la metalinea. Il numero massimo di proprietà è 5.

ObjectDisplayOptions.DisplayedProperty

Un riferimento a una proprietà di primo livello all'interno dell'oggetto che deve essere visualizzata nei risultati di ricerca. I valori delle proprietà scelte vengono visualizzati nei risultati di ricerca insieme al display label per la proprietà, se specificato. Se non viene specificata un'etichetta di visualizzazione, vengono visualizzati solo i valori.

Rappresentazione JSON
{
  "propertyName": string
}
Campi
propertyName

string

Il nome della proprietà di primo livello, come definito in una definizione di proprietà per l'oggetto. Se il nome non è una proprietà definita nello schema, viene visualizzato un errore durante il tentativo di aggiornarlo.

PropertyDefinition

La definizione di una proprietà all'interno di un oggetto.

Rappresentazione 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.
}
Campi
name

string

Il nome della proprietà. Le richieste di indicizzazione degli articoli inviate all'API Indexing devono impostare property name su questo valore. Ad esempio, se il nome è subject_line, le richieste di indicizzazione per gli elementi del documento con campi dell'oggetto devono impostare name per quel campo su subject_line. Utilizza il nome come identificatore della proprietà dell'oggetto. Una volta registrato come proprietà per un oggetto, non puoi riutilizzare questo nome per un'altra proprietà all'interno dell'oggetto. Il nome deve iniziare con una lettera e può contenere solo lettere (A-Z, a-z) o numeri (0-9). La lunghezza massima è di 256 caratteri.

isReturnable

boolean

Indica che la proprietà identifica i dati che devono essere restituiti nei risultati di ricerca tramite l'API Query. Se impostato su true, indica che gli utenti dell'API Query possono utilizzare i campi delle proprietà corrispondenti nei risultati. Tuttavia, la memorizzazione dei campi richiede una maggiore allocazione di spazio e utilizza una maggiore larghezza di banda per le query di ricerca, il che influisce sulle prestazioni in set di dati di grandi dimensioni. Imposta su true solo se il campo è necessario per i risultati di ricerca. Non può essere true per le proprietà di tipo oggetto.

isRepeatable

boolean

Indica che per la proprietà sono consentiti più valori. Ad esempio, un documento ha una sola descrizione, ma può avere più commenti. Non può essere true per le proprietà di tipo booleano. Se impostato su false, le proprietà che contengono più di un valore causano il rifiuto della richiesta di indicizzazione per l'elemento.

isSortable

boolean

Indica che la proprietà può essere utilizzata per l'ordinamento. Non può essere true per le proprietà ripetibili. Non può essere true per le proprietà di tipo object. Per impostare questa opzione, IsReturnable deve essere true. Supportato solo per le proprietà booleane, date, double, integer e timestamp.

isFacetable

boolean

Indica che la proprietà può essere utilizzata per generare facet. Non può essere true per le proprietà di tipo object. Per impostare questa opzione, IsReturnable deve essere true. Supportato solo per proprietà booleane, enum, intere e di testo.

isSuggestable

boolean

Indica che la proprietà può essere utilizzata per generare suggerimenti di query.

isWildcardSearchable

boolean

Indica che gli utenti possono eseguire ricerche con caratteri jolly per questa proprietà. Supportato solo per le proprietà di testo. Per impostare questa opzione, IsReturnable deve essere true. In un determinato set di dati è possibile contrassegnare come isWildcardSearchable un massimo di 5 proprietà. Per maggiori dettagli, vedi Definire le proprietà degli oggetti

displayOptions

object (PropertyDisplayOptions)

Le opzioni che determinano il modo in cui la proprietà viene visualizzata nella pagina dei risultati di Cloud Search se è specificato che deve essere visualizzata nel display options dell'oggetto.

Campo unione property_options. Le opzioni specifiche per tipo che determinano la modalità di indicizzazione e utilizzo della proprietà. Se le opzioni devono essere quelle predefinite per un tipo, questo campo deve comunque essere impostato su uno dei tipi. Se questo campo non è impostato, gli aggiornamenti dello schema vengono rifiutati. property_options può essere solo uno dei seguenti:
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

Le opzioni per le proprietà di tipo intero.

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

enum (IntegerPropertyOptions.OrderedRanking)

Utilizzato per specificare il ranking ordinato per l'intero. Può essere utilizzato solo se isRepeatable è falso.

minimumValue

string (Int64Value format)

Il valore minimo della proprietà. I valori minimo e massimo per la proprietà vengono utilizzati per classificare i risultati in base al ordered ranking. Le richieste di indicizzazione con valori inferiori al minimo sono accettate e classificate con lo stesso peso degli elementi indicizzati con il valore minimo.

maximumValue

string (Int64Value format)

Il valore massimo della proprietà. I valori minimo e massimo per la proprietà vengono utilizzati per classificare i risultati in base al ordered ranking. Le richieste di indicizzazione con valori superiori al massimo sono accettate e classificate con lo stesso peso degli elementi indicizzati con il valore massimo.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Se impostato, descrive come utilizzare l'intero come operatore di ricerca.

integerFacetingOptions

object (IntegerFacetingOptions)

Se impostato, descrive le opzioni di suddivisione in livelli per gli interi per la proprietà di tipo intero specificata. La proprietà di numero intero corrispondente deve essere contrassegnata come isFacetable.

IntegerPropertyOptions.OrderedRanking

Utilizzato per specificare il modo in cui un valore intero deve essere classificato rispetto ad altri valori. Un numero intero con un ranking ordinato più elevato suggerisce un'importanza maggiore. Ad esempio, in alcune origini dati una priorità inferiore indica un'importanza maggiore, mentre in altre una priorità più elevata indica un'importanza maggiore.

Enum
NO_ORDER Non esiste un ordine di ranking per la proprietà. I risultati non vengono aggiustati in base al valore di questa proprietà.
ASCENDING Questa proprietà è classificata in ordine crescente. I valori più bassi indicano un ranking inferiore.
DESCENDING Questa proprietà è classificata in ordine decrescente. Valori più bassi indicano un ranking più elevato.

IntegerPropertyOptions.IntegerOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà intere. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà integer. Ad esempio, se operatorName è priority e il nome della proprietà è priorityVal, query come priority:<value> mostrano risultati solo se il valore della proprietà denominata priorityVal corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà di tipo intero utilizzando l'operatore minore. Ad esempio, se lessThanOperatorName è prioritybelow e il nome della proprietà è priorityVal, le query come prioritybelow:<value> mostrano risultati solo se il valore della proprietà denominata priorityVal è inferiore a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà di tipo intero utilizzando l'operatore maggiore. Ad esempio, se greaterThanOperatorName è priorityabove e il nome della proprietà è priorityVal, le query come priorityabove:<value> mostrano risultati solo se il valore della proprietà denominata priorityVal è maggiore di <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

DoublePropertyOptions

Le opzioni per le proprietà doppie.

Rappresentazione JSON
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Campi
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Se impostato, descrive in che modo il doppio deve essere utilizzato come operatore di ricerca.

DoublePropertyOptions.DoubleOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà doppie. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per utilizzare la proprietà doppia nell'ordinamento o come un aspetto. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

TimestampPropertyOptions

Le opzioni per le proprietà timestamp.

Rappresentazione JSON
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Campi
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Se impostato, descrive in che modo il timestamp deve essere utilizzato come operatore di ricerca.

TimestampPropertyOptions.TimestampOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà timestamp. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà timestamp. Ad esempio, se operatorName è closedon e il nome della proprietà è closeDate, query come closedon:<value> mostrano risultati solo se il valore della proprietà denominata closeDate corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà timestamp utilizzando l'operatore minore. Ad esempio, se lessThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano risultati solo se il valore della proprietà denominata closeDate è precedente a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà timestamp utilizzando l'operatore maggiore di. Ad esempio, se greaterThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano risultati solo se il valore della proprietà denominata closeDate è successivo a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

BooleanPropertyOptions

Le opzioni per le proprietà booleane.

Rappresentazione JSON
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Campi
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Se impostato, descrive come deve essere utilizzato il valore booleano come operatore di ricerca.

BooleanPropertyOptions.BooleanOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà booleane. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà booleana. Ad esempio, se operatorName è closed e il nome della proprietà è isClosed, query come closed:<value> mostrano risultati solo se il valore della proprietà denominata isClosed corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

ObjectPropertyOptions

Le opzioni per le proprietà degli oggetti.

Rappresentazione JSON
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Campi
subobjectProperties[]

object (PropertyDefinition)

Le proprietà dell'oggetto secondario. Queste proprietà rappresentano un oggetto nidificato. Ad esempio, se questa proprietà rappresenta un indirizzo postale, le proprietà degli oggetti secondari potrebbero essere denominate via, città e provincia. Il numero massimo di elementi è 1000.

EnumPropertyOptions

Le opzioni per le proprietà enum, che ti consentono di definire un insieme limitato di stringhe da associare alle query degli utenti, impostare i ranking per i valori di stringa e definire un nome operatore da associare a queste stringhe in modo che gli utenti possano restringere i risultati solo agli elementi con un valore specifico. Ad esempio, per gli elementi di un sistema di monitoraggio delle richieste con informazioni sulla priorità, puoi definire p0 come valore enumerato consentito e associare questo enum al nome dell'operatore priority in modo che gli utenti di ricerca possano aggiungere priority:p0 alla query per limitare l'insieme di risultati solo agli elementi indicizzati con il valore p0.

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

object (EnumPropertyOptions.EnumValuePair)

L'elenco dei valori possibili per la proprietà di enumerazione. Tutti gli elementi EnumValuePairs devono fornire un valore stringa. Se specifichi un valore intero per un EnumValuePair, tutte le possibili EnumValuePairs devono fornire un valore intero. Sia il valore di stringa che il valore intero devono essere univoci rispetto a tutti i valori possibili. Una volta impostati, i possibili valori non possono essere rimossi o modificati. Se fornisci un ranking ordinato e ritieni di poter inserire ulteriori valori enumerati in futuro, lascia spazi nei valori interi iniziali per consentire l'aggiunta di un valore tra i valori registrati in precedenza. Il numero massimo di elementi è 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Utilizzato per specificare il ranking ordinato per l'enumerazione che determina in che modo i valori interi forniti nelle possibili EnumValuePairs vengono utilizzati per classificare i risultati. Se specificato, devono essere forniti valori interi per tutti i possibili valori EnumValuePair specificati per questa proprietà. Può essere utilizzato solo se isRepeatable è falso.

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Se impostato, descrive come utilizzare l'enumerazione come operatore di ricerca.

EnumPropertyOptions.EnumValuePair

La coppia di valori di enumerazione definisce due elementi: un valore di stringa obbligatorio e un valore intero facoltativo. Il valore di stringa definisce il termine di query necessario per recuperare l'elemento, ad esempio p0 per un elemento prioritario. Il valore intero determina il ranking del valore di stringa rispetto ad altri valori enumerati per la stessa proprietà. Ad esempio, potresti associare p0 a 0 e definire un'altra coppia di enum come p1 e 1. Devi utilizzare il valore intero in combinazione con ordered ranking per impostare il ranking di un determinato valore rispetto ad altri valori enumerati per lo stesso nome della proprietà. In questo caso, un ordine di ranking DESCENDENTE per le proprietà priority comporta un aumento del ranking per gli elementi indicizzati con un valore p0 rispetto agli elementi indicizzati con un valore p1. Senza un ordine di ranking specificato, il valore intero non ha alcun effetto sul ranking degli articoli.

Rappresentazione JSON
{
  "stringValue": string,
  "integerValue": integer
}
Campi
stringValue

string

Il valore stringa di EnumValuePair. La lunghezza massima è di 32 caratteri.

integerValue

integer

Il valore intero di EnumValuePair che deve essere non negativo. Facoltativo.

EnumPropertyOptions.OrderedRanking

Utilizzato per specificare la direzione del ranking per un numero intero EnumValuePair rispetto ad altri valori interi EnumValuePair. Per alcune proprietà, valori interi più bassi indicano un'importanza maggiore, mentre in altre un numero intero più alto indica un'importanza maggiore.

Enum
NO_ORDER Non esiste un ordine di ranking per la proprietà. I risultati non vengono modificati in base al valore di questa proprietà.
ASCENDING Questa proprietà è classificata in ordine crescente. I valori più bassi indicano un ranking inferiore.
DESCENDING Questa proprietà è classificata in ordine decrescente. Valori più bassi indicano un ranking più elevato.

EnumPropertyOptions.EnumOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà enum. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato. Ad esempio, se non fornisci un operatore per una proprietà enum priority con possibili valori p0 e p1, una query contenente il termine p0 restituisce gli elementi che hanno p0 come valore della proprietà priority, nonché tutti gli elementi che contengono la stringa p0 in altri campi. Se fornisci un nome operatore per l'enum, ad esempio priority, gli utenti di ricerca possono utilizzare questo operatore per perfezionare i risultati in modo da visualizzare solo gli elementi che hanno p0 come valore di questa proprietà, con la query priority:p0.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà enum. Ad esempio, se operatorName è priority e il nome della proprietà è priorityVal, query come priority:<value> mostrano risultati solo se il valore della proprietà denominata priorityVal corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

DatePropertyOptions

Le opzioni per le proprietà data.

Rappresentazione JSON
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Campi
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Se impostato, descrive come la data deve essere utilizzata come operatore di ricerca.

DatePropertyOptions.DateOperatorOptions

Facoltativo. Fornisce un operatore di ricerca per le proprietà date. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica la stringa effettiva richiesta nella query per isolare la proprietà data. Ad esempio, supponiamo che un oggetto dello schema di monitoraggio dei problemi abbia una proprietà denominata closeDate che specifica un operatore con un operatorName di closedon. Per le ricerche su questi dati, query come closedon:<value> mostrano risultati solo se il valore della proprietà closeDate corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo dei contenuti per l'origine dati indicizzata. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà data utilizzando l'operatore minore. Ad esempio, se lessThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano risultati solo se il valore della proprietà denominata closeDate è precedente a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà data utilizzando l'operatore maggiore di. Ad esempio, se greaterThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano risultati solo se il valore della proprietà denominata closeDate è successivo a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

TextPropertyOptions

Le opzioni per le proprietà del testo.

Rappresentazione JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Campi
retrievalImportance

object (RetrievalImportance)

Indica l'importanza della qualità di ricerca dei token all'interno del campo quando vengono utilizzati per il recupero.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Se impostato, descrive come la proprietà deve essere utilizzata come operatore di ricerca.

RetrievalImportance

Rappresentazione JSON
{
  "importance": enum (RetrievalImportance.Importance)
}
Campi
importance

enum (RetrievalImportance.Importance)

Indica l'importanza del ranking assegnata alla proprietà quando viene trovata una corrispondenza durante il recupero. Una volta impostata, l'importanza del token di una proprietà non può essere modificata.

RetrievalImportance.Importance

Enum
DEFAULT Tratta la corrispondenza come una corrispondenza del corpo del testo.
HIGHEST Tratta la corrispondenza come una corrispondenza con il titolo dell'elemento.
HIGH Tratta la corrispondenza con maggiore importanza rispetto al testo del corpo.
LOW Tratta la corrispondenza con un'importanza inferiore rispetto al testo del corpo.
NONE Non eseguire la corrispondenza con questo campo durante il recupero. La proprietà può comunque essere utilizzata per la corrispondenza degli operatori, le sfaccettature e i suggerimenti, se lo desideri.

TextPropertyOptions.TextOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà di testo. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà di testo. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, le query come subject:<value> mostrano risultati solo se il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà di testo o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

exactMatchWithOperator

boolean

Se true, il valore di testo viene tokenizzato come un valore atomico nelle ricerche con operatori e nelle corrispondenze dei facet. Ad esempio, se il nome dell'operatore è "genere" e il valore è "fantascienza", le limitazioni della query "genere:scienza" e "genere:fantasia" non corrispondono all'elemento, mentre "genere:fantascienza" sì. La corrispondenza dei valori di testo è sensibile alle maiuscole e non rimuove i caratteri speciali. Se è falso, il testo viene tokenizzato. Ad esempio, se il valore è "fantascienza", le query "genere:scienza" e "genere:fiction" corrispondono all'elemento.

HtmlPropertyOptions

Le opzioni per le proprietà HTML.

Rappresentazione JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Campi
retrievalImportance

object (RetrievalImportance)

Indica l'importanza della qualità di ricerca dei token all'interno del campo quando vengono utilizzati per il recupero. Può essere impostato solo su DEFAULT o NONE.

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Se impostato, descrive come la proprietà deve essere utilizzata come operatore di ricerca.

HtmlPropertyOptions.HtmlOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà HTML. Questo passaggio è facoltativo. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà HTML. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, le query come subject:<value> mostrano risultati solo se il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà HTML o testo all'interno del campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

PropertyDisplayOptions

Le opzioni di visualizzazione per una proprietà.

Rappresentazione JSON
{
  "displayLabel": string
}
Campi
displayLabel

string

L'etichetta facile da usare per la proprietà che viene utilizzata se è specificato che la proprietà deve essere visualizzata in ObjectDisplayOptions. Se fornita, l'etichetta di visualizzazione viene mostrata prima dei valori della proprietà quando la proprietà fa parte delle opzioni di visualizzazione dell'oggetto. Ad esempio, se il valore della proprietà è "1", il valore da solo potrebbe non essere un contesto utile per l'utente. Se il nome visualizzato specificato è "priority", l'utente vedrà "priority : 1" nei risultati di ricerca, il che fornisce un contesto chiaro agli utenti che effettuano ricerche. È FACOLTATIVO. Se non viene specificato, vengono visualizzati solo i valori delle proprietà. La lunghezza massima è di 64 caratteri.