Übersicht über die Experience Platform-Dokumentation
Die Adobe Experience Platform-Dokumentation ist für eine Reihe von Platform-Funktionen und -Diensten verfügbar. Um auf die Experience Platform-Dokumentation zuzugreifen, kehren Sie zur Landingpage Dokumentation zurück und wählen Sie den Guide aus, den Sie anzeigen möchten.
Experience Platform-Dokumentationstypen
Die Experience Platform-Dokumentation ist in verschiedenen Formaten verfügbar, einschließlich Übersichten, Tutorials und Handbüchern für die Benutzeroberfläche (UI) und API. Die gängigsten Dokumentationstypen sind in der folgenden Liste zusammengefasst:
-
API-Referenz: In der API-Referenzdokumentation für jeden Dienst finden Sie Details zu verfügbaren Endpunkten, einschließlich Kopfzeilen, Parametern, Beispielanfragen und Antworten. Diese Referenzmaterialien bieten nicht die gleiche Detailtiefe wie die Dokumentation. Es wird empfohlen, das Service-spezifische Entwicklerhandbuch für detaillierte API-Verwendungsbeispiele zu konsultieren.
-
Entwicklerhandbuch: Jedes Entwicklerhandbuch enthält ausführliche Nutzungsinformationen für alle API-Endpunkte, die für einen bestimmten Dienst verfügbar sind. Das Handbuch enthält verfügbare Abfrageparameter, Beispielanfragen und Beispielantworten sowie eine Beschreibung der "Fallstricke", die beim Aufrufen von Platform -APIs vermieden werden sollen.
-
Überblick: Eine Übersicht bietet einen allgemeinen Überblick über den Dienst oder die Funktion und darüber, wie er mit anderen Platform-Diensten interagiert. Die Übersicht ist der beste Ausgangspunkt, wenn Sie über neue Funktionen in Platform informiert sind.
-
Handbuch zur Fehlerbehebung: Verwenden Sie das Handbuch zur Fehlerbehebung, um Antworten auf häufig gestellte Fragen zu finden und Informationen zu Fehlermeldungen zu erhalten, die bei Verwendung der API wahrscheinlich auftreten werden. Das Handbuch zur Fehlerbehebung für Experience Platform bietet Unterstützung für allgemeine Fragen und Fehler, während einzelne Dienste für die Problembehebung spezifische Handbücher für ihren Bereich bereitstellen.
-
Tutorial: Ein Tutorial ist eine schrittweise Anleitung durch die Benutzeroberfläche, API oder eine Mischung aus beiden, die zu einem bestimmten Ergebnis führt. Im Gegensatz zu einem Entwicklerhandbuch konzentriert sich ein API-Tutorial möglicherweise nur auf einen oder zwei Endpunkte und ist keine vollständige API-Ressource. In ähnlicher Weise können sich Benutzeroberflächen-Tutorials nur auf bestimmte Schritte konzentrieren, nicht auf die vollständige Benutzeroberfläche, die für diesen Dienst verfügbar ist. Tutorials sind häufig Teil eines größeren Workflows und enthalten "nächste Schritte", in denen beschrieben wird, welche Tutorials Sie als Nächstes ausprobieren möchten.
-
UI-Handbuch: In einem UI-Handbuch werden die Aktionen beschrieben, die in der Platform -Benutzeroberfläche für einen bestimmten Dienst verfügbar sind. Diese Dokumente enthalten Screenshots und Schritte, die sich auf die Interaktion mit Platform über die Benutzeroberfläche konzentrieren. Ähnlich wie bei einem Entwicklerhandbuch werden im UI-Handbuch alle verfügbaren Aktionen und Optionen einschließlich "Fallstricke"erläutert, die vermieden werden können. Dies ist die detaillierteste Ressource für die Arbeit mit der Benutzeroberfläche.