Schema

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

string

Il nome dell'oggetto, che ne definisce il tipo. Le richieste di indicizzazione degli articoli devono impostare il campo objectType su un valore uguale a questo. Ad esempio, se name è Documento, le richieste di indicizzazione per elementi di tipo Documento dovrebbero impostare objectType uguale a Documento. Ogni definizione dell'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.

object (ObjectOptions)

Le opzioni facoltative specifiche dell'oggetto.

object (PropertyDefinition)

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

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

object (ObjectOptions.FreshnessOptions)

Le opzioni di aggiornamento di un oggetto.

object (ObjectDisplayOptions)

Le opzioni che determinano come l'oggetto viene visualizzato nella pagina dei risultati di Cloud Search.

string

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

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

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

La mappatura degli operatori a più proprietà all'interno dello stesso oggetto non è supportata. Se l'operatore si estende su tipi di oggetti diversi, questa opzione deve essere impostata una volta per ogni definizione dell'oggetto.

{
  "freshnessProperty": string,
  "freshnessDuration": string
}

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 Index utilizza updateTime come indicatore di aggiornamento. La lunghezza massima è di 256 caratteri.

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

string (Duration format)

Il periodo di tempo dopo il quale un oggetto deve essere considerato inattivo. Il valore predefinito è 180 giorni (in secondi).

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".

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

string

L'etichetta facile da mostrare da mostrare nel risultato di ricerca per indicare il tipo di articolo. Questo è FACOLTATIVO; se non viene specificata, l'etichetta di un oggetto non viene visualizzata nella riga contestuale dei risultati di ricerca. La lunghezza massima è di 64 caratteri.

object (ObjectDisplayOptions.Metaline)

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

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

object (ObjectDisplayOptions.DisplayedProperty)

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

{
  "propertyName": string
}

string

Il nome della proprietà di primo livello come definito in una definizione della proprietà per l'oggetto. Se il nome non è una proprietà definita nello schema, viene fornito un errore quando tenti di aggiornare lo schema.

{
  "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.
}

string

Il nome della struttura. Le richieste di indicizzazione degli articoli inviate all'API Index devono impostare property name uguale a questo valore. Ad esempio, se il nome è subject_line, le richieste di indicizzazione per gli elementi del documento con campi dell'oggetto dovrebbero impostare il name per quel campo su un valore uguale a subject_line. Utilizza il nome come identificatore della proprietà dell'oggetto. Dopo la registrazione come proprietà di 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.

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 della proprietà corrispondenti nei risultati. Tuttavia, l'archiviazione dei campi richiede una maggiore allocazione di spazio e utilizza più larghezza di banda per le query di ricerca, con ripercussioni sulle prestazioni su set di dati di grandi dimensioni. Impostalo su true qui solo se il campo è necessario per i risultati di ricerca. Non può essere true per le proprietà il cui tipo è un oggetto.

boolean

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

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à il cui tipo è oggetto. Per impostare questa opzione, il valore IsReturnable deve essere true. Supportata solo per le proprietà booleane, date, doppie, numeri interi e timestamp.

boolean

Indica che la proprietà può essere utilizzata per generare facet. Non può essere true per le proprietà il cui tipo è oggetto. Per impostare questa opzione, il valore IsReturnable deve essere true. Supportata solo per le proprietà booleane, enum, interi e di testo.

boolean

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

boolean

Indica che gli utenti possono eseguire ricerche con caratteri jolly per questa proprietà. Supportata solo per le proprietà di testo. Per impostare questa opzione, il valore IsReturnable deve essere true. In una determinata origine dati, è possibile contrassegnare un massimo di cinque proprietà come isWildcardSearchable. Per ulteriori dettagli, consulta Definire le proprietà dell'oggetto.

object (PropertyDisplayOptions)

Le opzioni che determinano come la proprietà viene visualizzata nella pagina dei risultati di Cloud Search se è specificata per essere visualizzata nell'oggetto display options.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

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

enum (IntegerPropertyOptions.OrderedRanking)

Utilizzato per specificare il ranking ordinato per il numero intero. Può essere utilizzato solo se isRepeatable è false.

string (Int64Value format)

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

string (Int64Value format)

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

object (IntegerPropertyOptions.IntegerOperatorOptions)

Se impostato, descrive come utilizzare il numero intero come operatore di ricerca.

object (IntegerFacetingOptions)

Se impostato, descrive le opzioni di faceting con numeri interi per la proprietà di numeri interi specificata. La proprietà del valore intero corrispondente deve essere contrassegnata come isFacetable.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

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

string

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

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà dei numeri interi utilizzando l'operatore "maggiore di". Ad esempio, se higherThanOperatorName è Priorityabove e il nome della proprietà è PriorityVal, query come Priorityabove:<value> mostrano risultati solo quando il valore della proprietà denominato PriorityVal è maggiore di <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}

object (DoublePropertyOptions.DoubleOperatorOptions)

Se impostato, descrive come utilizzare il double come operatore di ricerca.

{
  "operatorName": string
}

string

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

{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

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

string

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

string

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

{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}

object (BooleanPropertyOptions.BooleanOperatorOptions)

Se impostato, descrive come utilizzare il valore booleano come operatore di ricerca.

{
  "operatorName": string
}

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 dove il valore della proprietà denominata isClosed corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}

object (PropertyDefinition)

Le proprietà dell'oggetto secondario. Queste proprietà rappresentano un oggetto nidificato. Ad esempio, se questa proprietà rappresenta un indirizzo postale, il valore subobjectProperties potrebbe essere denominato street, city e state. Il numero massimo di elementi è 1000.

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

object (EnumPropertyOptions.EnumValuePair)

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

enum (EnumPropertyOptions.OrderedRanking)

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

object (EnumPropertyOptions.EnumOperatorOptions)

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

{
  "stringValue": string,
  "integerValue": integer
}

string

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

integer

Il valore intero dell'EnumValuePair che deve essere non negativo. (Facoltativo)

{
  "operatorName": string
}

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 dove il valore della proprietà denominata PriorityVal corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}

object (DatePropertyOptions.DateOperatorOptions)

Se impostato, descrive come utilizzare la data come operatore di ricerca.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

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

string

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

string

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

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

object (RetrievalImportance)

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

object (TextPropertyOptions.TextOperatorOptions)

Se impostato, descrive come utilizzare la proprietà come operatore di ricerca.

{
  "importance": enum (RetrievalImportance.Importance)
}

enum (RetrievalImportance.Importance)

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

{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}

string

Indica il nome dell'operatore obbligatorio 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 dove il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà di testo o testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

boolean

Se true, il valore di testo viene tokenizzato come un valore atomico nelle ricerche degli operatori e nelle corrispondenze dei facet. Ad esempio, se il nome dell'operatore è "gender" e il valore è "fantascienza" le restrizioni delle query "genere:scienza" e "gender:fiction" non corrisponde all'elemento; "genere:fantascienza" encoder-decoder. La corrispondenza dei valori di testo è sensibile alle maiuscole e non rimuove i caratteri speciali. Se il valore è false, il testo viene tokenizzato. Ad esempio, se il valore è "fantascienza" le query "genere:scienza" e "gender:fiction" corrisponde all'articolo.

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

object (RetrievalImportance)

Indica l'importanza della qualità della ricerca dei token all'interno del campo quando sono utilizzati per il recupero. Può essere impostato solo su PREDEFINITO o su NESSUNO.

object (HtmlPropertyOptions.HtmlOperatorOptions)

Se impostato, descrive come utilizzare la proprietà come operatore di ricerca.

{
  "operatorName": string
}

string

Indica il nome dell'operatore obbligatorio 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 dove il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà html o testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

{
  "displayLabel": string
}

string

L'etichetta facile da usare per la proprietà utilizzata se questa viene specificata per essere visualizzata in ObjectDisplayOptions. Se fornita, l'etichetta viene mostrata davanti ai valori della proprietà quando la proprietà fa parte delle opzioni di visualizzazione dell'oggetto. Ad esempio, se il valore della proprietà è "1", il valore in sé potrebbe non essere un contesto utile per l'utente. Se il nome visualizzato era "priorità", l'utente vede "priorità 1" nei risultati di ricerca, il che fornisce un contesto chiaro agli utenti. Questo è FACOLTATIVO; Se non viene specificato, vengono visualizzati solo i valori delle proprietà. La lunghezza massima è di 64 caratteri.