REST Resource: projects.locations.collections.dataStores.schemas

Risorsa: Schema

Definisce la struttura e il layout di un tipo di dati del documento.

Rappresentazione JSON 
{
  "name": string,
  "fieldConfigs": [
    {
      object (FieldConfig)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "structSchema": {
    object
  },
  "jsonSchema": string
  // End of mutually exclusive fields.
}
Campi
name

string

Immutabile. Il nome completo della risorsa dello schema, nel formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/schemas/{schema}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
fieldConfigs[]

object (FieldConfig)

Solo output. Configurazioni per i campi dello schema.
Rappresentazione dello schema. È necessario fornire struct_schema o json_schema, altrimenti viene generato un errore INVALID_ARGUMENT. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
structSchema

object (Struct format)

La rappresentazione strutturata dello schema.
jsonSchema

string

La rappresentazione JSON dello schema.
Fine dei campi che si escludono a vicenda.

FieldConfig

Configurazioni per i campi di uno schema. Ad esempio, la configurazione di un campo è indicizzabile o ricercabile.

Rappresentazione JSON 
{
  "fieldPath": string,
  "fieldType": enum (FieldType),
  "indexableOption": enum (IndexableOption),
  "dynamicFacetableOption": enum (DynamicFacetableOption),
  "searchableOption": enum (SearchableOption),
  "retrievableOption": enum (RetrievableOption),
  "completableOption": enum (CompletableOption),
  "recsFilterableOption": enum (FilterableOption),
  "keyPropertyType": string,
  "advancedSiteSearchDataSources": [
    enum (AdvancedSiteSearchDataSource)
  ],
  "schemaOrgPaths": [
    string
  ],
  "metatagName": string,
  "searchableFieldImportance": enum (SearchableFieldImportance)
}
Campi
fieldPath

string

Obbligatorio. Il percorso del campo dello schema. Ad esempio: title, description, release_info.release_year.
fieldType

enum (FieldType)

Solo output. Il tipo non elaborato del campo.
indexableOption

enum (IndexableOption)

Se indexableOption è INDEXABLE_ENABLED, i valori dei campi vengono indicizzati in modo che possano essere filtrati o suddivisi in sfaccettature in SearchService.Search.

Se indexableOption non è impostato, il comportamento del server è impostato su INDEXABLE_DISABLED per i campi che supportano l'impostazione di opzioni indicizzabili. Per i campi che non supportano l'impostazione di opzioni indicizzabili, come object e boolean e le proprietà della chiave, il server ignorerà l'impostazione indexableOption e l'impostazione indexableOption per questi campi genererà l'errore INVALID_ARGUMENT.
dynamicFacetableOption

enum (DynamicFacetableOption)

Se dynamicFacetableOption è DYNAMIC_FACETABLE_ENABLED, i valori dei campi sono disponibili per il facet dinamico. Può essere solo DYNAMIC_FACETABLE_DISABLED se FieldConfig.indexable_option è INDEXABLE_DISABLED. Altrimenti, verrà restituito un errore INVALID_ARGUMENT.

Se dynamicFacetableOption non è impostato, il comportamento del server è impostato di default su DYNAMIC_FACETABLE_DISABLED per i campi che supportano l'impostazione di opzioni di facetable dinamiche. Per i campi che non supportano l'impostazione di opzioni di suddivisione dinamica in facet, come object e boolean, il server ignorerà l'impostazione di opzioni di suddivisione dinamica in facet e l'impostazione di dynamicFacetableOption per questi campi genererà l'errore INVALID_ARGUMENT.
searchableOption

enum (SearchableOption)

Se searchableOption è SEARCHABLE_ENABLED, i valori del campo sono ricercabili tramite query di testo in SearchService.Search.

Se SEARCHABLE_ENABLED ma il tipo di campo è numerico, i valori dei campi non saranno ricercabili tramite query di testo in SearchService.Search, in quanto non sono presenti valori di testo associati ai campi numerici.

Se searchableOption non è impostato, il comportamento predefinito del server è SEARCHABLE_DISABLED per i campi che supportano l'impostazione di opzioni di ricerca. Solo i campi string senza mappatura delle proprietà della chiave supportano l'impostazione searchableOption.

Per i campi che non supportano l'impostazione di opzioni di ricerca, il server salterà l'impostazione delle opzioni di ricerca e l'impostazione di searchableOption per questi campi genererà l'errore INVALID_ARGUMENT.
retrievableOption

enum (RetrievableOption)

Se retrievableOption è RETRIEVABLE_ENABLED, i valori dei campi vengono inclusi nei risultati di ricerca.

Se retrievableOption non è impostato, il comportamento predefinito del server è RETRIEVABLE_DISABLED per i campi che supportano l'impostazione di opzioni recuperabili. Per quei campi che non supportano l'impostazione di opzioni recuperabili, come object e boolean, il server ignorerà l'impostazione dell'opzione recuperabile e l'impostazione di retrievableOption per tali campi genererà l'errore INVALID_ARGUMENT.
completableOption

enum (CompletableOption)

Se completableOption è COMPLETABLE_ENABLED, i valori dei campi vengono utilizzati direttamente e restituiti come suggerimenti per il completamento automatico in CompletionService.CompleteQuery.

Se completableOption non è impostato, il comportamento predefinito del server è COMPLETABLE_DISABLED per i campi che supportano l'impostazione di opzioni completabili, ovvero solo i campi string. Per i campi che non supportano l'impostazione di opzioni completabili, il server ignorerà l'impostazione di opzioni completabili e l'impostazione di completableOption per questi campi genererà l'errore INVALID_ARGUMENT.
recsFilterableOption

enum (FilterableOption)

Se recsFilterableOption è FILTERABLE_ENABLED, i valori dei campi sono filtrabili in base all'espressione di filtro in RecommendationService.Recommend.

Se FILTERABLE_ENABLED, ma il tipo di campo è numerico, i valori dei campi non possono essere filtrati in base alle query di testo in RecommendationService.Recommend. Sono supportati solo i campi di testo.

Se recsFilterableOption non è impostato, l'impostazione predefinita è FILTERABLE_DISABLED per i campi che supportano l'impostazione di opzioni filtrabili.

Quando un campo impostato su [FILTERABLE_DISABLED] viene filtrato, viene generato un avviso e viene restituito un risultato vuoto.
keyPropertyType

string

Solo output. Tipo della proprietà della chiave a cui è mappato questo campo. Stringa vuota se non è annotato come mappato a una proprietà chiave.

I tipi di esempio sono title, description. L'elenco completo è definito da keyPropertyMapping nell'annotazione del campo schema.

Se il campo dello schema ha un'annotazione KeyPropertyMapping, indexableOption e searchableOption di questo campo non possono essere modificati.
advancedSiteSearchDataSources[]

enum (AdvancedSiteSearchDataSource)

Se questo campo è impostato, per questo campo verrà indicizzata solo l'origine corrispondente. In caso contrario, i valori provenienti da origini diverse vengono uniti.

Supponendo una pagina con <author, a> nel meta tag e <author, b> nella mappa della pagina: se questo enum è impostato su METATAGS, indicizzeremo solo <author, a>; se questo enum non è impostato, li uniremo e indicizzeremo <author, [a, b]>.
schemaOrgPaths[]

string

Percorsi dei campi per l'indicizzazione dell'attributo personalizzato dai dati schema.org. Per ulteriori dettagli su schema.org e sui relativi tipi definiti, visita la pagina schema.org.

Viene utilizzato solo nello schema della ricerca avanzata sul sito.

Attualmente è supportato solo il percorso completo dalla directory principale. Il percorso completo a un campo viene costruito concatenando i nomi dei campi, a partire da _root, con un punto . come delimitatore. Esempi:

  • Data di pubblicazione della radice: _root.datePublished
  • Data di pubblicazione delle recensioni: _root.review.datePublished
metatagName

string

Facoltativo. Il nome del metatag trovato nella pagina HTML. Se l'utente definisce questo campo, il valore di questo nome metatag verrà utilizzato per estrarre il metatag. Se l'utente non definisce questo campo, verrà utilizzato FieldConfig.field_path per estrarre il metatag.
searchableFieldImportance

enum (SearchableFieldImportance)

Facoltativo. Specifica l'importanza del campo quando searchableOption è SEARCHABLE_ENABLED.

Se searchableOption è SEARCHABLE_DISABLED, questo campo viene ignorato.

Se searchableOption è SEARCHABLE_ENABLED e questo è SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED, si comporta come DEFAULT_IMPORTANCE.

Per ulteriori informazioni, vedere campi ricercabili di peso.

FieldType

Tipo di valore del campo nello schema.

Enum
FIELD_TYPE_UNSPECIFIED Il tipo di campo non è specificato.
OBJECT Il tipo di valore del campo è Object.
STRING Il tipo di valore del campo è Stringa.
NUMBER Il tipo di valore del campo è Numero.
INTEGER Il tipo di valore del campo è Integer.
BOOLEAN Il tipo di valore del campo è booleano.
GEOLOCATION

Il tipo di valore del campo è Geolocalizzazione. La geolocalizzazione è espressa come un oggetto con le seguenti chiavi:

  • id: una stringa che rappresenta l'ID località
  • longitude: un numero che rappresenta la coordinata di longitudine della posizione
  • latitude: un numero che rappresenta la coordinata di latitudine della posizione
  • address: una stringa che rappresenta l'indirizzo completo della località

latitude e longitude devono essere sempre forniti insieme. È necessario fornire almeno una delle seguenti opzioni: a) address o b) la coppia latitude-longitude.
DATETIME

Il tipo di valore del campo è Data/ora. La data e l'ora possono essere espresse come:

  • Un numero che rappresenta i millisecondi trascorsi dall'epoca
  • Una stringa che rappresenta i millisecondi dall'epoca. Ad esempio, "1420070400001"
  • Una stringa che rappresenta la data o la data e l'ora in formato ISO 8601. Ad esempio, "2015-01-01" o "2015-01-01T12:10:30Z"

IndexableOption

L'impostazione delle opzioni indicizzabili nello schema.

Enum
INDEXABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
INDEXABLE_ENABLED Opzione indicizzabile abilitata per un campo dello schema.
INDEXABLE_DISABLED Opzione di indicizzazione disattivata per un campo dello schema.

DynamicFacetableOption

Lo stato dell'opzione di suddivisione dinamica in facet di un campo schema.

Enum
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
DYNAMIC_FACETABLE_ENABLED Opzione di suddivisione dinamica in facet attivata per un campo dello schema.
DYNAMIC_FACETABLE_DISABLED Opzione di facetable dinamica disabilitata per un campo dello schema.

SearchableOption

L'impostazione delle opzioni di ricerca nello schema.

Enum
SEARCHABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
SEARCHABLE_ENABLED Opzione Ricercabile abilitata per un campo dello schema.
SEARCHABLE_DISABLED Opzione di ricerca disattivata per un campo dello schema.

RetrievableOption

L'impostazione delle opzioni recuperabili nello schema.

Enum
RETRIEVABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
RETRIEVABLE_ENABLED Opzione recuperabile abilitata per un campo dello schema.
RETRIEVABLE_DISABLED Opzione recuperabile disattivata per un campo dello schema.

CompletableOption

L'impostazione delle opzioni completabili nello schema.

Enum
COMPLETABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
COMPLETABLE_ENABLED Opzione completabile abilitata per un campo dello schema.
COMPLETABLE_DISABLED Opzione Completabile disabilitata per un campo dello schema.

FilterableOption

Imposta l'opzione di filtro per i campi dello schema.

Enum
FILTERABLE_OPTION_UNSPECIFIED Valore utilizzato quando non è impostato.
FILTERABLE_ENABLED Opzione filtrabile abilitata per un campo dello schema.
FILTERABLE_DISABLED Opzione di filtraggio disabilitata per un campo dello schema.

AdvancedSiteSearchDataSource

Origine facoltativa del campo di ricerca avanzata sul sito.

Enum
ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED Valore utilizzato quando non è impostato.
METATAGS Recupera il valore dal meta tag.
PAGEMAP Recupera il valore dalla mappa della pagina.
URI_PATTERN_MAPPING Recupera il valore dagli attributi impostati dall'API SiteSearchEngineService.SetUriPatternDocumentData.
SCHEMA_ORG Recupera il valore dai dati di schema.org.

SearchableFieldImportance

Specifica l'importanza del campo per la ricerca. Non è previsto che vengano aggiunti nuovi valori a questo enum.

Enum
SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED valore utilizzato quando non è impostato. Si comporta come DEFAULT_IMPORTANCE se il campo è ricercabile.
VERY_LOW_IMPORTANCE Fornisce un piccolo segnale per la ricerca.
LOW_IMPORTANCE Indica che il campo viene utilizzato per la ricerca, ma è meno importante di quello predefinito.
DEFAULT_IMPORTANCE Importanza predefinita. Equivalente al comportamento precedente.
HIGH_IMPORTANCE Più importanti dei campi predefiniti.
VERY_HIGH_IMPORTANCE Il campo più importante per la ricerca.

Metodi

create

 Crea un Schema.

delete

 Elimina un Schema.

get

 Riceve un Schema.

list

 Recupera un elenco di Schema.

patch

 Aggiorna un Schema.