Experience Platform-Dokumentationsübersicht
Die Adobe Experience Platform-Dokumentation ist für eine Reihe von Funktionen und Services von Platform verfügbar. Um auf die Experience Platform-Dokumentation zuzugreifen, kehren Sie zur Dokumentations-Landingpage zurück und wählen Sie das Handbuch aus, das Sie anzeigen möchten.
Dokumentationstypen für Experience Platform
Die Experience Platform-Dokumentation einschließlich Übersichten, Tutorials und Handbüchern für die Benutzeroberfläche (UI) und die API wird in verschiedenen Formaten bereitgestellt. Die häufigsten Dokumentationstypen sind in der folgenden Liste zusammengefasst:
-
API-Referenz: In der API-Referenzdokumentation für jeden Service finden Sie Details zu verfügbaren Endpunkten, einschließlich Kopfzeilen, Parametern, Beispielanfragen und Antworten. Diese Referenzmaterialien bieten nicht denselben Detaillierungsgrad wie die Dokumentation. Es wird empfohlen, das Service-spezifische Entwicklerhandbuch zu konsultieren, um ausführliche API-Nutzungsbeispiele zu erhalten.
-
Entwicklerhandbuch: Jedes Entwicklerhandbuch enthält detaillierte Nutzungsinformationen für alle API-Endpunkte, die für einen bestimmten Service verfügbar sind. Das Handbuch enthält verfügbare Abfrageparameter, Beispielanfragen und Beispielantworten sowie die Beschreibung von „Fallstricken“, die bei Aufrufen an Platform-APIs zu vermeiden sind.
-
Übersicht: Ein Überblick bietet einen allgemeinen Überblick über den Service oder die Funktion und darüber, wie sie mit anderen Platform-Services interagiert. Die Übersicht ist der beste Ausgangspunkt, wenn Sie mehr über neue Funktionen in Platform erfahren möchten.
-
Handbuch zur Fehlerbehebung: Verwenden Sie das Handbuch zur Fehlerbehebung, um Antworten auf häufig gestellte Fragen und Informationen zu Fehlermeldungen zu finden, auf die Sie bei der Verwendung der -API stoßen können. Das Handbuch zur Fehlerbehebung bei Experience Platform bietet Unterstützung bei allgemeinen Fragen und Fehlern, während die einzelnen -Services spezifische Handbücher zur Fehlerbehebung für ihren Bereich bereitstellen.
-
Tutorial: Ein Tutorial ist eine schrittweise Anleitung über die Benutzeroberfläche, die API oder eine Mischung aus beiden, die zu einem bestimmten Ergebnis führt. Im Gegensatz zu einem Entwicklerhandbuch kann sich ein API-Tutorial nur auf einen oder zwei Endpunkte konzentrieren und ist keine erschöpfende API-Ressource. Ebenso können sich Benutzeroberflächen-Tutorials nur auf bestimmte Schritte konzentrieren, nicht auf die vollständige Benutzeroberfläche, die für diesen Service verfügbar ist. Tutorials sind häufig Teil eines größeren Workflows und bieten die Funktion „Nächste Schritte“, die beschreiben, welche Tutorials Sie als Nächstes versuchen sollten.
-
UI-Handbuch: In einem UI-Handbuch werden die Aktionen beschrieben, die in der Platform-Benutzeroberfläche für einen bestimmten Service verfügbar sind. Diese Dokumente enthalten Screenshots und Schritte, die sich auf die Interaktion mit Platform über die Benutzeroberfläche konzentrieren. Ähnlich einem Entwicklerhandbuch werden im Handbuch für die Benutzeroberfläche alle verfügbaren Aktionen und Optionen einschließlich der zu vermeidenden „Fallstricke“ beschrieben. Dies ist die detaillierteste Ressource für die Arbeit mit der -Benutzeroberfläche.