Il Knowledge Graph supporta una varietà di tipi di campo, ciascuno progettato per diversi tipi di dati.
Tipi di campo standard
Ogni campo è definito da un tipo. Questi sono i tipi di campo standard disponibili sulla piattaforma Yext.
| Tipo | Descrizione | Validazione disponibile |
|---|---|---|
| CTA | Call to action con etichetta e link | Lunghezza dei caratteri dell'etichetta (fino a 255), lunghezza dei caratteri del link (fino a 2000) |
| Foto complessa | Foto con didascalia incorporata, dettagli, URL di clickthrough e testo alternativo | Rapporto d'aspetto, larghezza/altezza minima |
| Galleria di foto complesse | Galleria di foto con didascalia integrata, dettagli, URL cliccabile e testo alternativo | Proporzione, larghezza/altezza minima, numero di elementi (fino a 500) |
| Video complesso | URL di YouTube (e YouTube Shorts) con descrizione integrata | Lunghezza della descrizione (fino a 140 caratteri) |
| Galleria video complessi | Galleria di URL di YouTube con descrizione incorporata | Lunghezza della descrizione (fino a 140 caratteri), numero di elementi (fino a 100) |
| Orari giornalieri | Configura un orario specifico per ogni giorno della settimana. | n/d |
| Data | Campo data | Intervallo di date |
| Data + ora | Campo data con ora del giorno specificata | Intervallo di data e ora |
| Relazione tra entità | Elenco di entità correlate con la possibilità di selezionare un tipo di relazione unidirezionale, bidirezionale (campo condiviso) o bidirezionale (campo distinto) | Tipi di entità selezionabili, numero di elementi (fino a 5.000) |
| File | I tipi di campo dei file possono essere configurati per supportare un solo file o un elenco di file. | Formato e dimensione massima dei file (fino a 1 GB) |
| Orari | Configura un elenco degli orari per ogni giorno della settimana. Specifica se un'entità è operativa utilizzando aperto, chiuso, suddiviso o 24 ore. È possibile specificare più intervalli di ore per un determinato giorno. | n/d |
| Testo a più righe | Testo in formato lungo | Lunghezza dei caratteri (fino a 100.000) |
| Selezione di più opzioni | Campo di opzione in cui l'utente può selezionare più opzioni | Opzioni disponibili, Numero di articoli (fino a 2.000) |
| Numero | Campo numerico | Intervallo numerico |
| Numero di telefono | Campo numerico con prefisso internazionale e formattazione automatica del numero di telefono | n/d (la convalida su ciò che costituisce un numero di telefono valido deriva da Google ) |
| Foto | Foto con testo alternativo | Rapporto d'aspetto, larghezza/altezza minima |
| Galleria di foto | Galleria di foto con testo alternativo | Proporzione, larghezza/altezza minima, numero di elementi (fino a 500) |
| Prezzo | Campo del prezzo | n/d |
| Rich Text | Campo RTF con formattazione | Tipo di formattazione (grassetto, corsivo, sottolineatura, elenco puntato, elenco numerato, collegamento ipertestuale, blocco di codice), Lunghezza dei caratteri (fino a 100.000) |
| Testo a una sola riga | Testo in forma abbreviata | Lunghezza dei caratteri (fino a 100.000) |
| Selezione di un'opzione | Campo opzione dove l'utente può selezionare una sola opzione | Opzioni disponibili |
| Slug | Un'etichetta breve e di facile lettura alla fine di un URL che tipicamente funge da identificatore, ad esempio, hitchhikers.yext.com/docs | I caratteri alfanumerici minuscoli e i seguenti caratteri speciali: - . _ ~ : / [ ] @ ! $ ' ( ) * + ; = " |
| Testo-elenco | Elenco di stringhe di testo | Lunghezza dei caratteri (fino a 100.000), numero di elementi (fino a 1000) |
| Ora | Un valore di ora e minuto (hh:mm) |
n/d |
| URL | URL del sito web | Lunghezza dei caratteri (fino a 2000) |
| Video | URL di YouTube (e YouTube Shorts) | n/d |
| Galleria di video | Galleria di URL di YouTube (e YouTube Shorts) | Proporzioni, Larghezza/Altezza minima, Numero di elementi (fino a 100) |
| Sì / No | Campo con opzioni Sì, No o Non specificato | n/d |
Tipo di campo del file
Il tipo di campo File consente di memorizzare i file direttamente nelle entità. Questo tipo è disponibile per l'uso in campi personalizzati e tipi di campi personalizzati.
Proprietà
Il tipo di campo File è composto dalle seguenti cinque proprietà:
| Proprietà | Descrizione |
|---|---|
sourceURL |
URL di origine del file. Questo campo viene compilato solo se il file viene caricato tramite un URL ospitato. |
url |
L'URL ospitato da Yext del file. |
mimeType |
Il tipo MIME del file. Attualmente, sono supportati tutti i tipi MIME. |
name |
Il nome visualizzato del file. Impostabile dall'utente. Nota: la proprietà name non può essere mappata tramite un connettore, ma può essere impostata o modificata su tutte le altre interfacce. |
taglia |
La dimensione del file in byte. |
I tipi di campo dei file possono essere configurati per supportare un solo file o un elenco di file. Questo creerà automaticamente un limite massimo di convalida per il caricamento dei file pari a 1 o 5000, rispettivamente.
di convalida
La convalida predefinita per i campi file è riportata di seguito. È inoltre possibile configurare la convalida per i campi personalizzati e i tipi di campi personalizzati File.
| Opzione | Validazione predefinita | Convalida personalizzata |
|---|---|---|
| Formato del file | Sono consentiti tutti i formati di tipo MIME. | Puoi limitare i file caricati a un sottoinsieme di tipi di file consentiti in base al tipo MIME comune. |
| Dimensione massima del file | I file non possono superare 1 GB. | Imposta un limite massimo diverso in byte, kilobyte o megabyte. Il valore deve essere un numero intero. |
Nota: esiste un problema noto con JsonFormat.Printer che influisce su Configurazione come Codice, in cui la proprietà maxSize viene restituita come stringa quando viene estratta. Tuttavia, quando applicata, questa proprietà deve essere un numero.
Caricamento file
È possibile caricare i file utilizzando tutte le interfacce per la modifica delle entità nel Knowledge Graph (ovvero, Modifica entità, Caricamento entità, Connettori, API e CaC).
Tutte le interfacce supportano il caricamento di file tramite riferimento a un URL di origine. Il caricamento da un file system locale è supportato solo in Modifica entità.
Per caricare un file che è ospitato online, indica l'URL ospitato utilizzando la proprietà url. Questo url fornito sarà poi propagato alla proprietà sourceUrl, mentre il campo URL cambierà per essere l'URL ospitato da Yext di questo file.
Aggiornamento dei file
Per modificare un file archiviato in un campo di un'entità, aggiorna il valore della proprietà url in modo che sia l'URL del nuovo file ospitato. L'invio di aggiornamenti alla proprietà sourceUrl non è supportato.
La stringa user-agent utilizzata per scaricare i file è YextBot YextFileDownloader/1.0.
Accesso ai file memorizzati
I file memorizzati sulle entità sono accessibili tramite Modifica entità e tramite API.
Modifica entità
I file possono essere scaricati dalla proprietà URL. Lo stato di modifica di questo campo mostrerà tutte le proprietà del campo File. Le proprietà di un file non possono essere modificate in Modifica entità, ad eccezione del nome del file.
API
Aprendo l'URL memorizzato nella proprietà url, il file verrà scaricato sul tuo dispositivo locale. Ecco un esempio di come apparirebbe su Entities: GET.
Con altri campi omessi, la risposta è la seguente:
{
"response": {
"entities": [{
"c_pdfFile": [{
"sourceUrl": "https://www.pdfs.com/123",
"url":"https://a.mktgcdn.com/f/3912636/123",
"mimeType": "application/pdf",
"name": "Instruction Manual",
"size": 2001
}]
}]
}
}Tipo di campo foto
Il tipo di campo Foto consente di memorizzare le foto direttamente nelle entità. Questo tipo è disponibile per l'uso in campi personalizzati e tipi di campi personalizzati.
Proprietà
Il tipo di campo Foto è composto dalle seguenti cinque proprietà:
| Proprietà | Descrizione |
|---|---|
larghezza |
La larghezza della foto in pixel. |
Altezza |
L'altezza della foto in pixel. |
url |
L'URL ospitato da Yext del file. |
sourceUrl |
URL di origine del file. Questo campo viene compilato solo se il file viene caricato tramite un URL ospitato. |
thumbnails (Legacy) |
Una funzione legacy che genera miniature di varie dimensioni per una foto al momento del caricamento. Questa funzionalità è stata sostituita dalla trasformazione dinamica delle immagini. |
di convalida
È possibile configurare la convalida per i campi personalizzati Foto e per i tipi di campo personalizzati Foto.
| Opzione | Validazione disponibile | Predefinita | Valori consentiti |
|---|---|---|---|
| Larghezza | Imposta la larghezza minima in pixel | 0 | Numeri interi 0-1000 |
| Altezza | Imposta l'altezza minima in pixel | 0 | Numeri interi 0-1000 |
| Proporzione | Imposta il rapporto tra larghezza e altezza accettato | Libero | Senza vincoli, 1:1, 4:3, 3:2, 5:3, 16:9, 3:1, 2:3, 5:7, 4:5, 16:10 |
Limitazioni
| Opzione | Valori consentiti |
|---|---|
| Dimensione dell'immagine | Fino a 100 megapixel |
| Formato immagine | JPEG, PNG, BMP, GIF, TIFF, WEBP |
Caricamento foto
Le foto possono essere caricate tramite tutte le interfacce di modifica delle entità nel Knowledge Graph.
Tutte le interfacce supportano il caricamento di foto tramite riferimento a un URL di origine. Il caricamento di una foto da un file system locale è supportato solo in Modifica entità.
Per caricare una foto ospitata online, inserisci l'URL della foto nella proprietà url. Questo URL verrà quindi propagato alla proprietà sourceUrl, mentre il campo URL sarà l'URL della foto ospitato da Yext.
Aggiornamento delle foto
Per modificare la foto che è memorizzata in un determinato campo Foto, aggiorna il valore della proprietà url con il nuovo URL della foto ospitata. L'invio di aggiornamenti direttamente alla proprietà sourceUrl non è supportato.
Accesso alle foto
Una volta che un'immagine è stata caricata su un'entità, il suo URL ospitato viene mantenuto come riferimento nel campo dell'entità. Puoi accedere all'entità tramite API per recuperare direttamente l'URL della foto, ad esempio:
Con altri campi omessi, la risposta è la seguente:
{
"response": {
"entities": [{
"photoGallery": [{
"image": {
"width": 314,
"height": 366,
"url": "http://a.mktgcdn.com/p/Oua5ocwC7euaUFkJ-V8n3OpF76Xtfh_rdsDT9ki_laY/314x366.jpg"
}]
}]
}
}A ogni immagine viene assegnato un UUID lungo (la lunga stringa casuale mostrata sopra), quindi l'URL appare come: a.mktgcdn.com/p/UUID/WIDTHxHEIGHT.EXT.
Sono supportati sia HTTP che HTTPS.
Tipi di campi personalizzati
Puoi creare tipi di campo personalizzati per raggruppare più campi in un unico campo complesso. Ad esempio, potresti creare un tipo di campo "Sostituzione degli orari di apertura" con campi secondari per giorno, orario di apertura e orario di chiusura.
Di solito userai i tipi di campo integrati in Yext. Se necessario per il tuo caso d'uso, puoi anche creare tipi di campo personalizzati.
Per creare un tipo di campo personalizzato:
- Vai su Knowledge Graph > Configurazione e fai clic sul riquadro Tipi di campo .
-
Fai clic su Aggiungi tipo di campo personalizzato.
-
Inserisci le informazioni di base per il tuo tipo di campo personalizzato.
- Nome del tipo di campo
- Nome API: verrà impostato automaticamente in base al nome, ma se desideri puoi modificarlo.
-
Descrizione del tipo (opzionale)
- Se utilizzi profili in lingue alternative, aggiungi le traduzioni al tuo tipo di entità personalizzato. Fai clic su Aggiungi traduzione nell'impostazione Nome o Descrizione.
- Scegli la lingua desiderata e inserisci il valore tradotto. Fai clic su Salva o Salva e aggiungine un'altra per aggiungere un'altra traduzione alla stessa impostazione.
- Aggiungi i singoli campi che costituiranno il tuo nuovo tipo di campo. Per iniziare, fai clic su Aggiungi un sottocampo.
- Inserisci le impostazioni per il sottocampo.
- Tipo di sottocampo: scegli il tipo di sottocampo che desideri aggiungere. A seconda del tipo di campo scelto, potresti visualizzare impostazioni leggermente diverse.
- Etichetta del sottocampo: inserisci un'etichetta per il sottocampo. Aggiungi traduzioni se lo desideri.
- Convalida: imposta regole di convalida come un numero minimo o massimo di caratteri o altri contenuti accettati nel sottocampo.
- Impostazioni: scegli se questo sottocampo deve essere obbligatorio quando compili il tuo campo personalizzato e se ha opzioni di elenco.
- Fai clic su Aggiungi sottocampo per aggiungere altri sottocampi.
- Fai clic sull' icona del cestino in un sottocampo per rimuoverlo.
- Fai clic su Salva nella parte inferiore dello schermo per salvare il tipo di campo personalizzato.