Abrufen von Recommendations mit der Bereitstellungs-API
Die Recommendations-APIs von Adobe Target und Adobe Target können für die Bereitstellung von Antworten auf Web-Seiten verwendet werden. Sie können aber auch für Erlebnisse außerhalb von HTML verwendet werden, wie Apps, Bildschirme, Konsolen, E-Mails, Kiosks und andere Anzeigegeräte. Mit anderen Worten: Wenn Target-Bibliotheken und JavaScript nicht verwendet werden können, ermöglicht die Target-Bereitstellungs-API weiterhin den Zugriff auf alle Target-Funktionen, um personalisierte Erlebnisse bereitzustellen.
Um Empfehlungen abzurufen, senden Sie einen POST-Aufruf zur Adobe Target-Bereitstellungs-API mit den entsprechenden Kontextinformationen, die eine Benutzer-ID (zur Verwendung mit profilspezifischen Empfehlungen wie den kürzlich angezeigten Elementen des Benutzers), einen relevanten Mbox-Namen, Mbox-Parameter, Profilparameter oder andere Attribute enthalten können. Die Antwort enthält empfohlene entity.ids (und möglicherweise andere Entitätsdaten) im JSON- oder HTML-Format, die dann auf dem Gerät angezeigt werden können.
Die Bereitstellungs-API für Adobe Target stellt alle vorhandenen Funktionen bereit, die eine Standard-Target-Anfrage bereitstellt.
Die Bereitstellungs-API:
- Ermöglicht den RESTful-Abruf von Erlebnissen oder Angeboten für einen Standort und eine Zielgruppe.
- Erfordert keine Authentifizierung.
- Nur POSTs.
- Verarbeitet keine Cookies oder Umleitungsaufrufe.
- Erfordert oder erkennt keine „Benutzerrollen“. Es ruft einfach Inhalte ab oder meldet Ereignisse an Target Edge-Server.
Gehen Sie wie folgt vor, um mit der Bereitstellungs-API Target-Erlebnisse einschließlich Empfehlungen bereitzustellen:
- Erstellen Sie eine Target-Aktivität (A/B, XT, AP oder Recommendations) mit dem formularbasierten Composer (nicht dem Visual Experience Composer).
- Verwenden Sie die Bereitstellungs-API , um eine Antwort auf die Anfragen zu erhalten, die von der soeben erstellten Target-Aktivität generiert wurden.
<!— F: Warum sind BEIDE Schritte dafür notwendig? Wenn Sie eine formularbasierte Empfehlung für eine Mbox definiert haben, worin besteht dann der Vorteil, dass die Bereitstellungs-API ebenfalls integriert wird, um Ergebnisse abzurufen? Warum können Sie die Ergebnisse nicht einfach mit dem formularbasierten Rec auf dem Zielgerät bereitstellen lassen?..?? A: Siehe den unten stehenden Anwendungsfall … Dies ist der Fall, wenn Sie die ausstehenden Ergebnisse „abfangen“ möchten, um mehr Aufgaben auszuführen, bevor Sie die Ergebnisse anzeigen. Dinge wie Echtzeit-Vergleiche zu Beständen. —>
Erstellen einer Empfehlung mit dem formularbasierten Experience Composer
Um Empfehlungen zu erstellen, die mit der Bereitstellungs-API verwendet werden können, verwenden Sie den formularbasierten Composer.
-
Erstellen und speichern Sie zunächst ein JSON-basiertes Design, das Sie in Ihrer Empfehlung verwenden können. Beispiel-JSON sowie Hintergrundinformationen dazu, wie JSON-Antworten bei der Konfiguration einer formularbasierten Aktivität zurückgegeben werden können, finden Sie in der Dokumentation unter Erstellen von Empfehlungsentwürfen. In diesem Beispiel trägt der Entwurf den Namen Einfaches JSON.
-
Gehen Sie in Target zu Activities > Create Activity > Recommendations und klicken Sie dann auf Form.
-
Wählen Sie eine Eigenschaft aus und klicken Sie auf Next.
-
Definieren Sie den Speicherort, an dem Benutzer die Antwort der Empfehlung erhalten sollen. Im folgenden Beispiel wird ein Speicherort namens api_charter verwendet. Wählen Sie Ihr zuvor erstelltes JSON-basiertes Design mit dem Namen Einfaches JSON.
-
Speichern und aktivieren Sie die Empfehlung. Es wird Ergebnisse generieren. Sobald die Ergebnisse fertig sind können Sie die Bereitstellungs-API verwenden, um sie abzurufen.
Verwenden der Bereitstellungs-API
Die Syntax für die Bereitstellungs-API lautet:
POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery
-
Beachten Sie, dass der Clientcode erforderlich ist. Zur Erinnerung: Ihr Clientcode befindet sich möglicherweise in Adobe Target, indem Sie zu Recommendations > Settings navigieren. Beachten Sie den Client-Code im Abschnitt Recommendations-API-".
-
Nachdem Sie Ihren Client-Code haben, erstellen Sie Ihren Bereitstellungs-API-Aufruf. Das folgende Beispiel beginnt mit den in der Sammlung "-API-Postman bereitgestellten Web Batched Mboxes Delivery API Call und nimmt entsprechende Änderungen vor. Beispiel:
-
Die browser- und address-Objekte wurden aus dem body entfernt, da sie für Anwendungsfälle außerhalb von HTML nicht erforderlich sind
-
api_charter wird in diesem Beispiel als Standortname aufgeführt
-
entity.id wird angegeben, da diese Empfehlung auf Inhaltsähnlichkeit basiert, d. h., es muss ein aktueller Elementschlüssel an Target übergeben werden.
Denken Sie daran, Ihre Abfrageparameter korrekt zu konfigurieren. Geben Sie beispielsweise bei Bedarf{{CLIENT_CODE}}an. <!— F: In der aktualisierten Aufrufsyntax wird entity.id als profileParameter und nicht als mboxParameter aufgeführt, wie dies in älteren Versionen der Fall war. —> <!— F: Altes Bild
-
-
Senden Sie die Anfrage. Dies wird für den Speicherort api_charter ausgeführt, auf dem eine aktive Empfehlung ausgeführt wird, die mit Ihrem JSON-Design definiert wird und eine Liste empfohlener Entitäten ausgibt.
-
Sie erhalten eine Antwort, die auf dem JSON-Design basiert.
Die Antwort enthält die Schlüssel-ID sowie die Entitäts-IDs der empfohlenen Entitäten.
Durch diese Verwendung der Bereitstellungs-API mit Recommendations können Sie zusätzliche Schritte ausführen, bevor Sie dem Besucher Recommendations auf dem Nicht-HTML-Gerät anzeigen. Sie können beispielsweise die Antwort von der Bereitstellungs-API verwenden, um eine zusätzliche Echtzeitsuche nach Entitätsattributdetails (Bestand, Preis, Bewertung usw.) aus einem anderen System (z. B. CMS, PIM oder E-Commerce-Plattform) durchzuführen, bevor die endgültigen Ergebnisse angezeigt werden.
Mit dem in diesem Handbuch beschriebenen Ansatz können Sie jede Anwendung dazu bringen, die Antwort von Target zu nutzen, um personalisierte Empfehlungen zu geben!
Beispielimplementierungen
Die folgenden Ressourcen enthalten Beispiele für verschiedene Implementierungen, die nicht auf HTML ausgerichtet sind. Beachten Sie, dass jede Implementierung aufgrund des Systems und der beteiligten Geräte einzigartig ist.
Verwalten des Recommendations-Setups mit APIs
In den meisten Fällen werden Empfehlungen in der Adobe Target-Benutzeroberfläche konfiguriert und dann über die Target-APIs verwendet oder aufgerufen, beispielsweise aus den in den obigen Abschnitten genannten Gründen. Diese UI-API-Koordination ist üblich. Manchmal möchten die Benutzer jedoch möglicherweise alle Aktionen über APIs durchführen - sowohl die Einrichtung als auch die Verwendung der Ergebnisse. Obwohl dies weniger häufig vorkommt, können Benutzer die Ergebnisse von Recommendations absolut konfigurieren ausführen und vollständig mithilfe der -APIs nutzen.
In einem Abschnitt haben wir gelernt wie Adobe Target Recommendations-Entitäten verwaltet und Server-seitig bereitgestellt werden. Ebenso können Sie mit der Adobe Developer Console Kriterien, Promotions, Sammlungen und Design-Vorlagen verwalten, ohne sich bei Adobe Target anmelden zu müssen. Eine vollständige Liste aller Recommendations-APIs finden Sie hier, aber hier finden Sie eine Zusammenfassung als Referenz.
Referenzdokumentation
Zusammenfassung und Überprüfung
Herzlichen Glückwunsch! Durch den Abschluss dieses Handbuchs haben Sie Folgendes gelernt: