Verwaltung benutzerdefinierter Felder
Falls Ihre App Daten je Standort im Knowledge Manager von Yext speichern muss, die jedoch nicht in den vorhandenen Datenmodellen enthalten sind, kann Ihre App benutzerdefinierte Felder nutzen. Benutzerdefinierte Felder sind konfigurierbare Felder, die zu einem Yext-Konto hinzugefügt werden können und die es Kunden oder Apps ermöglichen, benutzerdefinierte Daten für jeden Standort zu speichern. Benutzerdefinierte Felder verfügen über eine integrierte Unterstützung für verschiedenste Datentypen sowie über eine konfigurierbare Feldüberprüfung.

Benutzerdefinierte Felder sind Attribute des Standort-Objekts in der API. Sie sind abrufbar und als natives Standortfeld einstellbar. Beispielweise könnte Ihre App Daten von einer externen Plattform in einem benutzerdefinierten Feld speichern oder ein solches Feld für die Speicherung eines Primärschlüssels für ein externes System benötigen. In diesen Fällen würde Ihre App eine Definition für ein benutzerdefiniertes Feld auf dem Konto erstellen und dieses Feld dann für die Speicherung von Daten in jedem Standortobjekt nutzen.

Verhalten bei benutzerdefinierten Feldern

Um Kunden und andere Apps vor potenziell schädlichem Verhalten zu schützen, können Apps auf ein bestimmtes Verhalten bei benutzerdefinierten Feldern beschränkt werden. Diese Einschränkungen wirken sich auf die Fähigkeit der App aus, Definitionen für benutzerdefinierte Felder auf einem Yext-Konto zu erstellen, zu aktualisieren und zu entfernen. Beachten Sie bitte, dass unabhängig von deren Einstellungen, Apps immer eine Lese- und/oder Schreibberechtigung für benutzerdefinierte Felder haben, sofern sie Zugriff auf die Standorte-Endpunkte haben. Um Ihrer App das Erstellen, Aktualisieren und das Entfernen von Definitionen für benutzerdefinierte Felder zu ermöglichen, müssen Sie auf Ihrer Seite „App-Einstellungen“ ein Verhalten bei benutzerdefinierten Feldern festlegen. Das von Ihnen gewählte Verhalten hängt von Ihrem Szenario ab:
  • Ihre App muss keine Definitionen für benutzerdefinierte Felder erstellen/aktualisieren/entfernen können (Standard).
    • Verhalten bei benutzerdefinierten Feldern: Wählen Sie „Deaktiviert“. Ihre App wird nach wie vor über die Standorte-Endpunkte Lese- und/oder Schreibzugriff auf benutzerdefinierte Felder haben.
  • Ihre App wird immer privat sein.
    • Verhalten bei benutzerdefinierten Feldern: Wählen Sie „Für alle Felder aktiviert“. Ihre App wird die Endpunkte für benutzerdefinierte Felder nutzen können, um Definitionen für benutzerdefinierte Felder auf einem Konto zu erstellen, zu aktualisieren und zu entfernen.
  • Ihre App wird für das App Directory eingereicht werden.
    • Verhalten bei benutzerdefinierten Feldern: Wählen Sie „Aktiviert für Felder mit Präfix“. Ihre App wird die Endpunkte für benutzerdefinierte Felder nutzen können, um Definitionen für diese auf einem Konto zu erstellen, zu aktualisieren und zu entfernen – jedoch nur, wenn der Name des benutzerdefinierten Felds mit dem von Ihnen angegebenen Präfix beginnt.
FÜR ALLE FELDER AKTIVIERT Falls Sie die Einstellung „Für alle Felder aktiviert“ wählen, wird Ihre App nicht für die Einreichung zum App Directory berechtigt sein.
KANN NACH EINREICHUNG NICHT BEARBEITET WERDEN Ihr Verhalten für benutzerdefinierte Felder kann, nachdem Ihre App für das App Directory eingereicht oder darin veröffentlicht wurde, nicht mehr bearbeitet werden.

Präfixe für benutzerdefinierte Felder

Ihr Präfix für ein benutzerdefiniertes Feld sollte ein kurzer, einzigartiger und kundenseitiger String zwischen drei und 50 Zeichen Länge sein. Dieser String wird in der Regel den Namen der externen Plattform enthalten, mit der Ihre App integriert ist (z. B. „Zendesk“, „Salesforce“ oder „HubSpot“). Falls Ihr Verhalten für benutzerdefinierte Felder „Aktiviert für Felder mit Präfix“ ist, müssen alle Definitionen der von Ihnen verwalteten benutzerdefinierten Felder mit diesem String beginnen.

Lautet Ihr Präfix zum Beispiel „BeispielCo“, so können Sie nur Definitionen von benutzerdefinierten Feldern erstellen, aktualisieren oder entfernen, die Namen wie „BeispielCo ID“, „BeispielCo Ticketwarteschlange“ usw. aufweisen. Beachten Sie bitte, dass das Präfix für benutzerdefinierte Felder Ihre App nicht davon abhält, andere Werte benutzerdefinierter Felder für den Standort abzurufen und festzulegen. Dies gilt unabhängig vom Präfix.
KANN NACH DER EINREICHUNG NICHT BEARBEITET WERDEN Ihr Präfix für benutzerdefinierte Felder kann nicht bearbeitet werden, nachdem Ihre App für das App Directory eingereicht oder darin veröffentlicht wurde.