Der Knowledge Graph unterstützt verschiedene Feldtypen, die jeweils für unterschiedliche Datentypen konzipiert sind.
Standardfeldtypen
Jedes Feld ist durch einen Typ definiert. Dies sind die Standardfeldtypen, die auf der Yext-Plattform verfügbar sind.
| Typ | Beschreibung | Verfügbare Validierung |
|---|---|---|
| Call-to-Action | Call-to-Action mit Label und Link | Label-Zeichenlänge (bis zu 255), Link-Zeichenlänge (bis zu 2.000) |
| Komplexes Foto | Foto mit integrierter Bildunterschrift, Details, Klick-URL & Alternativtext | Seitenverhältnis, Mindestbreite/-höhe |
| Komplexe Fotogalerie | Fotogalerie mit integrierter Bildunterschrift, Details, Klick-URL & Alternativtext | Seitenverhältnis, Mindestbreite/-höhe, Anzahl der Elemente (bis zu 500) |
| Komplexes Video | YouTube-URL (und YouTube Shorts) mit integrierter Beschreibung | Beschreibung (Zeichenlänge bis zu 140) |
| Komplexe Videogalerie | Galerie von YouTube-URLs mit integrierter Beschreibung | Länge der Beschreibung (bis zu 140 Zeichen), Anzahl der Elemente (bis zu 100) |
| Tägliche Geschäftszeiten | Konfigurieren Sie für jeden Wochentag eine bestimmte Uhrzeit. | N. zutr. |
| Datum | Datumsfeld | Datumsbereich |
| Datum + Uhrzeit | Datumsfeld mit angegebener Uhrzeit | Datum- und Zeitbereich |
| Entitätsbeziehung | Liste der verknüpften Entitäten mit der Möglichkeit, einen unidirektionalen, bidirektionalen (gemeinsames Feld) oder bidirektionalen (unterschiedliches Feld) Beziehungstyp auszuwählen | Auswählbare Entitätstypen, Anzahl der Elemente (bis zu 5.000) |
| Datei | Dateifeldtypen können so konfiguriert werden, dass sie eine Datei oder eine Liste von Dateien unterstützen. | Dateiformat und maximale Dateigröße (bis zu 1 GB) |
| Zeiten | Konfigurieren Sie eine Liste von Stunden für jeden Wochentag. Geben Sie an, ob eine Entität betriebsbereit ist, indem Sie die Optionen „offen“, „geschlossen“, „geteilt“ oder „24 Stunden“ verwenden. Sie können mehrere Zeitbereiche für einen bestimmten Tag angeben. | N. zutr. |
| Mehrzeiliger Text | Langformatiger Text | Zeichenlänge (bis zu 100.000) |
| Auswahl mit mehreren Optionen | Optionsfeld, in dem Nutzer*innen mehrere Optionen auswählen können | Verfügbare Optionen, Elementanzahl (bis zu 2.000) |
| Nummer | Numerisches Feld | Nummernbereich |
| Telefon | Numerisches Feld mit Ländervorwahl und automatischer Rufnummernformatierung | n/a (die Validierung, was eine gültige Telefonnummer ausmacht, stammt von Google ) |
| Foto | Foto mit Alternativtext | Seitenverhältnis, Mindestbreite/-höhe |
| Fotoalbum | Fotogalerie mit Alternativtext | Seitenverhältnis, Mindestbreite/-höhe, Anzahl der Elemente (bis zu 500) |
| Preis | Preisfeld | N. zutr. |
| Rich Text | Rich-Text-Feld mit Formatierung | Art der Formatierung (fett, kursiv, unterstrichen, Aufzählungsliste, nummerierte Liste, Hyperlink, Codeblock), Zeichenlänge (bis zu 100.000) |
| Einzeiliger Text | Text in Kurzform | Zeichenlänge (bis zu 100.000) |
| Auswahl mit einer Option | Ein Optionsfeld, über das Nutzer*innen nur eine Option auswählen können | Verfügbare Optionen |
| Slug | Ein kurzes, leserfreundliches Label am Ende einer URL, das normalerweise als Identifikator dient, z. B. hitchhikers.yext.com/docs | Kleine Alphanumerik und die folgenden Sonderzeichen: - . _ ~ : / [ ] @ ! $ ' ( ) * + ; = „“ |
| Text-Liste | Liste mit Textzeichenfolgen | Zeichenlänge (bis zu 100.000), Anzahl der Elemente (bis zu 1.000) |
| Uhrzeit | Ein Stunden- und Minutenwert (hh:mm) |
N. zutr. |
| URL | Website-URL | Zeichenlänge (bis zu 2.000) |
| Video | YouTube-URL (und YouTube Shorts) | N. zutr. |
| Videogalerie | Galerie der YouTube- (und YouTube-Shorts) URL | Seitenverhältnis, Mindestbreite/-höhe, Anzahl der Elemente (bis zu 100) |
| Ja/Nein | Feld mit den Optionen Ja, Nein oder Nicht angegeben | N. zutr. |
Datei-Feldtyp
Der Feldtyp „Datei“ ermöglicht es Ihnen, Dateien direkt in Ihren Entitäten zu speichern. Dieser Typ kann in benutzerdefinierten Feldern und benutzerdefinierten Feldtypen verwendet werden.
Eigenschaften
Der Dateifeldtyp besteht aus den folgenden fünf Eigenschaften:
| Eigenschaft | Beschreibung |
|---|---|
sourceURL |
Quell-URL der Datei. Wird nur ausgefüllt, wenn Sie eine gehostete URL hochgeladen haben. |
URL |
Die von Yext gehostete URL der Datei. |
mimeType |
Der MIME-Typ der Datei. Aktuell werden alle MIME-Typen unterstützt. |
Name |
Der Anzeigename der Datei. Von Nutzer*innen einstellbar. Hinweis: Die Eigenschaft Name kann nicht über den Connector zugeordnet, aber über alle anderen Schnittstellen festgelegt oder bearbeitet werden. |
size |
Die Dateigröße in Bytes. |
Dateifeldtypen können so konfiguriert werden, dass sie eine Datei oder eine Liste von Dateien unterstützen. Dadurch wird automatisch eine maximale Dateiupload-Validierung von 1 bzw. 5.000 Dateien erstellt.
Validierung
Die Standardvalidierung für Dateifelder ist unten aufgeführt. Sie können auch die Validierung für benutzerdefinierte Dateifelder und benutzerdefinierte Dateifeldtypen konfigurieren.
| Option | Standardvalidierung | Benutzerdefinierte Validierung |
|---|---|---|
| Dateiformat | Alle MIME-Typ-Formate sind zulässig. | Sie können hochgeladene Dateien auf eine Teilmenge der erlaubten Dateitypen über einen gemeinsamen MIME-Typ einschränken. |
| Maximale Dateigröße | Dateien dürfen 1 GB nicht überschreiten. | Legen Sie eine andere maximale Größenbeschränkung in Byte, Kilobyte oder Megabyte fest. Der Wert muss eine Ganzzahl sein. |
Hinweis: Es gibt ein bekanntes Problem mit JsonFormat.Printer, das Configuration as Code betrifft. Dabei wird die maxSize-Eigenschaft beim Abrufen als Zeichenkette zurückgegeben. Allerdings muss diese Eigenschaft beim Anwenden eine Zahl sein.
Dateien hochladen
Dateien können über alle Schnittstellen hochgeladen werden, um Entitäten im Knowledge Graph zu bearbeiten (z. B. Entität bearbeiten, Entity Upload, Connectors, API und CaC).
Alle Schnittstellen unterstützen Datei-Uploads durch Angabe einer Quell-URL. Das Hochladen von einem lokalen Dateisystem wird nur in Entität bearbeiten unterstützt.
Um eine Datei hochzuladen, die online gehostet wird, geben Sie die gehostete URL mithilfe der url Eigenschaft an. Diese bereitgestellte URL wird dann in die sourceUrl Eigenschaft übertragen, während das URL-Feld zur von Yext gehosteten URL dieser Datei wird.
Dateien aktualisieren
Um eine Datei zu ändern, die in einem Feld einer Entität gespeichert ist, aktualisieren Sie den Wert der url Eigenschaft mit der URL der neuen gehosteten Datei. Das Senden von Aktualisierungen an die sourceUrl Eigenschaft wird nicht unterstützt.
Der User-Agent-String, der zum Herunterladen von Dateien verwendet wird, ist YextBot YextFileDownloader/1.0.
Zugriff auf gespeicherte Dateien
Auf Entitäten gespeicherte Dateien können über Entität bearbeiten und über API abgerufen werden.
Entität bearbeiten
Dateien können über die URL-Eigenschaft heruntergeladen werden. Der Bearbeitungszustand dieses Feldes zeigt alle Eigenschaften des Dateifeldes an. Die Eigenschaften einer Datei können in Entität bearbeiten nicht bearbeitet werden, mit Ausnahme des Dateinamens.
API
Wenn Sie die in der url Eigenschaft gespeicherte URL öffnen, wird die Datei auf Ihr lokales Gerät heruntergeladen. So könnte dies bei einem Entities: GET aussehen.
Wenn andere Felder weggelassen wurden, sieht die Antwort folgendermaßen aus:
{
"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
}]
}]
}
}
Feldtyp Foto
Der Feldtyp Foto ermöglicht es Ihnen, Fotos direkt auf Ihren Entitäten zu speichern. Dieser Typ kann in benutzerdefinierten Feldern und benutzerdefinierten Feldtypen verwendet werden.
Eigenschaften
Der Feldtyp Foto setzt sich aus folgenden fünf Eigenschaften zusammen:
| Eigenschaft | Beschreibung |
|---|---|
Breite |
Die Breite des Fotos in Pixeln. |
Höhe |
Die Höhe des Fotos in Pixeln. |
URL |
Die von Yext gehostete URL der Datei. |
sourceUrl |
Quell-URL der Datei. Wird nur ausgefüllt, wenn Sie eine gehostete URL hochgeladen haben. |
Thumbnails (Veraltet) |
Eine alte Funktion, die beim Hochladen eines Fotos Miniaturansichten in verschiedenen Größen erzeugt. Diese Funktion wurde durch die dynamische Bildtransformation ersetzt. |
Validierung
Sie können die Validierung für benutzerdefinierte Felder und benutzerdefinierte Feldtypen konfigurieren.
| Option | Verfügbare Validierung | Standard | Gültige Werte |
|---|---|---|---|
| Breite | Mindestbreite in Pixeln festlegen | 0 | Ganze Zahlen 0-1.000 |
| Höhe | Mindesthöhe in Pixeln festlegen | 0 | Ganze Zahlen 0-1.000 |
| Seitenverhältnis | Das akzeptierte Verhältnis von Breite zu Höhe einstellen | Frei | Uneingeschränkt, 1:1, 4:3, 3:2, 5:3, 16:9, 3:1, 2:3, 5:7, 4:5, 16:10 |
Einschränkungen
| Option | Gültige Werte |
|---|---|
| Bildgröße | Bis zu 100 Megapixel |
| Bildformat | JPEG, PNG, BMP, GIF, TIFF, WEBP |
Fotos hochladen
Fotos können über alle Schnittstellen zur Bearbeitung von Entitäten im Knowledge Graph hochgeladen werden.
Alle Schnittstellen unterstützen das Hochladen von Fotos durch Referenzierung einer Quell-URL. Das Hochladen eines Fotos aus einem lokalen Dateisystem wird nur in Entität bearbeiten unterstützt.
Um ein Foto hochzuladen, das online gehostet wird, füllen Sie die Foto-URL in die url Eigenschaft ein. Diese URL wird dann an die sourceUrl Eigenschaft weitergeleitet, während das URL-Feld die von Yext gehostete URL des Fotos ist.
Fotos aktualisieren
Um das Foto zu ändern, das in einem bestimmten Fotofeld gespeichert ist, aktualisieren Sie den Wert der url Eigenschaft auf die URL des neuen gehosteten Fotos. Das Senden von Aktualisierungen direkt an die sourceUrl Eigenschaft wird nicht unterstützt.
Zugriff auf Fotos
Sobald ein Bild in eine Entität hochgeladen wurde, wird die zugehörige gehostete URL als Referenz im Feld der Entität gespeichert. Sie können über die API auf die Entität zugreifen, um die URL des Fotos direkt abzurufen, zum Beispiel:
Wenn andere Felder weggelassen wurden, sieht die Antwort folgendermaßen aus:
{
"response": {
"entities": [{
"photoGallery": [{
"image": {
"width": 314,
"height": 366,
"url": "http://a.mktgcdn.com/p/Oua5ocwC7euaUFkJ-V8n3OpF76Xtfh_rdsDT9ki_laY/314x366.jpg"
}]
}]
}
}Jedem Bild wird eine lange UUID (die lange zufällige Zeichenkette oben) zugewiesen, sodass die URL die folgende Form hat: a.mktgcdn.com/p/UUID/WIDTHxHEIGHT.EXT.
Sowohl HTTP als auch HTTPS werden unterstützt.
Typen von benutzerdefinierten Feldern
Sie können benutzerdefinierte Feldtypen erstellen, um mehrere Felder zu einem einzigen komplexen Feld zusammenzufassen. Beispielsweise könnten Sie einen Feldtyp „Geschäftszeitenüberschreibung“ mit Unterfeldern für Tag, Öffnungszeit und Schließzeit erstellen.
Normalerweise verwenden Sie die integrierten Feldtypen in Yext. Wenn es für Ihren Anwendungsfall erforderlich ist, können Sie auch benutzerdefinierte Feldtypen erstellen.
So erstellen Sie einen benutzerdefinierten Feldtyp:
- Navigieren Sie zu Knowledge Graph > Konfiguration und klicken Sie auf die Kachel Feldtypen.
-
Klicken Sie auf Benutzerdefinierten Feldtyp hinzufügen.
-
Geben Sie die grundlegenden Informationen für Ihren benutzerdefinierten Feldtyp ein.
- Name des Feldtyps
- API-Name: Dieser wird automatisch anhand des Namens festgelegt, aber Sie können ihn bei Bedarf ändern.
-
Typbeschreibung (optional)
- Wenn Sie alternative Sprachprofile verwenden, fügen Sie Ihrem benutzerdefinierten Entitätstyp Übersetzungen hinzu. Klicken Sie bei der Einstellung Name oder Beschreibung auf Übersetzung hinzufügen.
- Wählen Sie die gewünschte Sprache aus und geben Sie den übersetzten Wert ein. Klicken Sie auf Speichern oder Speichern und weitere hinzufügen, um derselben Einstellung eine weitere Übersetzung hinzuzufügen.
- Fügen Sie die einzelnen Felder hinzu, die Ihren neuen Feldtyp bilden werden. Um zu beginnen, klicken Sie auf Unterfeld hinzufügen.
- Geben Sie die Einstellungen für Ihr Unterfeld ein.
- Unterfeldtyp: Wählen Sie den Typ des Unterfelds, das Sie hinzufügen möchten. Je nach dem von Ihnen gewählten Feldtyp werden Ihnen möglicherweise leicht unterschiedliche Einstellungen angezeigt.
- Unterfeld-Label: Geben Sie ein Label für das Unterfeld ein. Fügen Sie bei Bedarf Übersetzungen hinzu.
- Validierung: Legen Sie Validierungsregeln fest, wie eine Mindest- oder Höchstanzahl von Zeichen oder andere akzeptierte Inhalte im Unterfeld.
- Einstellungen: Wählen Sie, ob dieses Unterfeld erforderlich sein soll, wenn Sie Ihr benutzerdefiniertes Feld ausfüllen, und ob dieses Unterfeld Listenoptionen hat.
- Klicken Sie auf Unterfeld hinzufügen, um weitere Unterfelder hinzuzufügen.
- Klicken Sie auf das Papierkorbsymbol in einem Unterfeld, um es zu entfernen.
- Klicken Sie unten auf dem Bildschirm auf Speichern, um Ihren benutzerdefinierten Feldtyp zu speichern.