Aktivieren und Konfigurieren von Katalogereignissen mit Adobe I/O
Katalogereignisse sind maschinengenerierte Benachrichtigungen, die unterstützte Katalogänderungen beschreiben, die über Catalog Service bereitgestellt werden. Sie ermöglichen ereignisgesteuerte Workflows, wie etwa:
- Externe Caches oder Dienste mit Katalogaktualisierungen synchronisieren.
- Auslösen nachgelagerter Prozesse, wenn sich Produkte, Varianten, Preise oder Kategorien ändern.
- Anwendungsfälle für Experience Edge und Edge Delivery Services, die nahezu in Echtzeit Katalogaktualisierungen erfordern.
Den End-to-End-Pfad von Adobe Commerce zu Ihren Ereigniskonsumenten finden Sie unter Ereignisbereitstellung bis Adobe I/O Events.
Unterstützte Ereignistypen supported-event-types
Katalogereignisse konzentrieren sich auf Storefront-relevante Änderungen, die über Adobe Developer Console verfügbar gemacht werden. Die folgenden Abonnements werden derzeit unterstützt.
Zu jedem Ereignis gehören:
- Eine Ereigniskennung, die den Änderungstyp beschreibt.
- Entitäts- und Umgebungskontext, z. B. Instanz-ID und SKU
- Eine Payload, die die geänderte Entität und relevante Bereichsinformationen beschreibt.
Beispiel für Ereignis-Payloads
ProductUpdated-Ereignis
{
"imsOrgId": "aaa-0",
"instanceId": "instance-9",
"eventCode": "productUpdated",
"sku": "1234",
"links": [
{"type": "variantOf", "sku": "5678"}
],
"scope": [
{ "storeViewCode": "US-us" },
{ "storeViewCode": "FR-fr" },
{ "storeViewCode": "DE-de" }
]
}
PriceUpdated-Ereignis
{
"imsOrgId": "aaa-0",
"instanceId": "instance-9",
"eventCode": "priceUpdated",
"sku": "1234",
"scope": [
{
"websiteCode": "website1",
"customerGroupCode": "customer-group-code1"
},
{
"websiteCode": "website2",
"customerGroupCode": "customer-group-code2"
}
]
}
Versand von Ereignissen über Adobe I/O Events event-delivery-through-adobe-io-events
Adobe I/O Events stellt Katalogereignisse für Ihre Integrationen bereit. Das folgende Diagramm zeigt den allgemeinen Fluss von Katalogänderungen von Adobe Commerce über Catalog Service und Adobe I/O Events zu abonnierten Verbrauchern:
In den folgenden Schritten wird jede Übergabe detaillierter erläutert:
- Adobe Commerce → Catalog Service
Adobe Commerce exportiert Katalogdaten mithilfe der unterstützten SaaS-Datenexporterweiterungen in Catalog Service.
-
Catalog Service-Verarbeitung
- Catalog Service verarbeitet unterstützte Katalogänderungen und bereitet sie für die Ereignisbereitstellung vor.
-
Katalog-Service → Adobe I/O Events
- Katalogereignisse werden in Adobe I/O Events veröffentlicht.
- Nutzerinnen und Nutzer melden sich mit Journaling, Webhooks, Adobe I/O Runtime, Amazon EventBridge oder anderen unterstützten Versandmechanismen an.
Adobe I/O Events bietet:
- Mindestens einmaliger Versand pro Abonnent (doppelte Ereignisse sind möglich).
- Keine Bestellgarantien für alle Sendungen.
Ihre Kunden müssen mit doppelten Ereignissen und nicht ordnungsgemäßer Bereitstellung umgehen. Siehe Idempotenz für Implementierungsanleitungen.
Anwendungsszenarien use-cases
Sie können Katalogereignisse in mehreren Szenarien verwenden.
Statische Site- und Edge-Bereitstellung
- Generieren oder Invalidieren von Katalogseiten und Storefront-Fragmenten, wenn sich Katalogdaten ändern.
- Vermeiden Sie häufiges Abrufen Catalog Service APIs.
Suchindizierung und Caching
- Inkrementelle Aktualisierungen des Triggers in nachgelagerten Suchindizes.
- Aktualisieren Sie Cache-Ebenen oder externe Ansichten des Katalogs, wenn sich Produkt- oder Kategoriedaten ändern.
Integration mit externen Systemen
- Weiterleiten von Katalogänderungen an externe Systeme wie PIM, Preisfindungs-Engines oder andere Branchensysteme.
- Synchronisierung nachgelagerter Anwendungen ohne direkten Datenbankzugriff.
Überwachung und Beobachtbarkeit
Kombinieren Sie Katalogereignisse mit vorhandener Überwachung (z. B. Grafana und Prometheus), um:
- Überwachen des Ereignisdurchsatzes.
- Erkennen von Anomalien im Katalogaktualisierungsvolumen.
Katalogereignisse aktivieren enable-catalog-events
Gehen Sie wie folgt vor, um Katalogereignisse End-to-End zu aktivieren.
- Eine unterstützte Adobe Commerce-Umgebung mit aktiviertem Catalog Service.
- Die Adobe I/O ist für Adobe Commerce konfiguriert.
- Zugriff auf Adobe Developer Console in derselben IMS-Organisation, in der die Commerce-Umgebung bereitgestellt wurde.
- Um die Synchronisierung mit Commerce SaaS-Services zu überprüfen, verwenden Sie die Data Management Dashboard in der Admin Console.
- Product Recommendations v6.0, Live Search v4.1.0+ oder Catalog Service v1.17+ ist für die Dashboard-Überprüfung erforderlich. Adobe empfiehlt, Ihr Commerce-Projekt auf die neuesten unterstützten Versionen dieser Services zu aktualisieren. Verwenden Sie für frühere Service-Versionen Katalogsynchronisierung für die Synchronisierungsüberprüfung.
Überprüfen von Katalogdaten verify-catalog-data
Stellen Sie vor der Konfiguration sicher, dass Catalog Service über aktuelle Katalogdaten aus Ihrer Commerce verfügt. Katalogereignisse hängen davon ab, SaaS Data Export zwei Schritte ausgeführt werden. Bestätigen Sie beide:
-
Bestätigen Sie erfolgreichen Feed-Export aus Commerce.
Öffnen Sie von der Adobe Commerce Admin aus die Seite Daten-FeedSynchronisierungsstatus) (System > Data Transfer > Data Feed Sync Status) und bestätigen Sie, dass der letzte Exportstatus für jeden Catalog Service-Feed erfolgreich ist.
-
Bestätigen Sie über Admin die erfolgreiche Synchronisierung mit verbundenen Commerce-ServicesAdobe Commerce.
Öffnen Sie vom Adobe Commerce Admin aus das Daten-Management-Dashboard (System > Data Transfer > Data Management Dashboard) und überprüfen Sie, ob die synchronisierten Produktdaten die erwarteten Produkte enthalten.
Registrieren und Adobe I/O Events abonnieren register-events
Legen Sie fest, welche Commerce-Ereignisse abonniert werden sollen, und registrieren Sie sie dann im Projekt.
Wenn sich Ihre Instanz nicht in der Auswahlliste befindet, ist sie nicht mit Adobe I/O verbunden. Anweisungen zum Beheben des Problems finden Sie unter Konfigurieren der Adobe I/O -Verbindung in der Adobe Commerce Developer Dokumentation.
-
Melden Sie sich von der Adobe Developer Console aus bei derselben IMS-Organisation an, die für das Commerce-Projekt verwendet wurde.
-
Erstellen Sie ein Projekt für Commerce-Katalogereignisse oder fügen Sie die Ereignis-API einem vorhandenen Projekt hinzu.
-
Wählen Sie APIs and services in der oberen Navigationsleiste aus.
-
Wählen Sie auf der Seite Browse APIs and services die Registerkarte Events aus.
-
Schnelles Auffinden der APIs für Commerce-Katalogereignisse. Geben Sie Katalog in das Suchfeld ein oder filtern Sie nach dem Commerce.
-
Wählen Sie auf der Commerce Catalog Events Karte Project aus.
-
-
Konfigurieren der Ereignisregistrierung.
Wählen Sie die Commerce-Instanz aus, von der Ereignisbenachrichtigungen empfangen werden sollen. Wählen Sie dann Next aus.
-
Wählen Sie die Ereignisse aus, die abonniert werden sollen.
Wählen Sie die unterstützten Ereignisabonnements aus, die Sie erhalten möchten, z. B. Product Update oder Price Update. Wählen Sie dann Next aus.
-
OAuth-Server-zu-Server-Anmeldedaten hinzufügen.
Geben Sie einen Credential name ein. Wählen Sie dann Next aus.
-
Geben Sie einen Event registration name und einen Event registration description ein. Wählen Sie dann Next aus.
-
Akzeptieren Sie auf dem letzten Registrierungsbildschirm den Standardverbraucher, die Journal-API.
Mit der standardmäßigen Journal-API für Privatkunden können Sie die Ereignisregistrierung testen und bestätigen, dass Ereignisse bereitgestellt werden. Wenn Sie bereits einen Webhook oder Adobe I/O Runtime Aktionsbenutzer konfiguriert haben, wählen Sie ihn hier aus. Andernfalls müssen Sie die Ereignisregistrierung später bearbeiten, wenn der Kunde bereit ist.
-
Wählen Sie Complete registration aus.
Konfigurieren des Ereignisverbrauchers configure-consumer
-
Konfigurieren Sie einen Verbraucher, z. B.:
- Ein Webhook-Endpunkt
- Eine Adobe I/O Runtime Aktion
- Ein weiteres unterstütztes Ziel
-
Wenn Sie bei der Registrierung keinen Verbraucher ausgewählt haben, bearbeiten Sie die Ereignisregistrierung, um die Verbraucherdetails hinzuzufügen.
-
Bearbeiten Sie in der Adobe Developer Console Ihr Projekt. Wählen Sie dann die von Ihnen erstellte Ereignisregistrierung aus.
-
Wählen Sie auf der Seite Details zur Ereignisregistrierung Edit Events Registration aus.
-
Wählen Sie Next aus, bis der Bildschirm Verbraucherauswahl angezeigt wird. Wählen Sie dann den konfigurierten Verbraucher aus.
-
Aktualisieren Sie den -Verbraucher auf Ihr konfiguriertes Ziel. Wählen Sie dann Save configured events aus.
-
Validieren des Ereignisflusses validate-event-flow
Katalogereignisse sind für Ihre Umgebung aktiviert. Wenn sich Katalogdaten in Commerce ändern, fließen Aktualisierungen über Catalog Service zu Adobe I/O Events, und Ihr abonnierter Benutzer erhält das entsprechende Katalogereignis. Lesen Sie Beschränkungen und Best Practices bevor Sie Produktionsintegrationen erstellen.
-
Nehmen Sie eine einfache unterstützte Katalogänderung vor, z. B. die Aktualisierung eines Produktnamens oder die Änderung eines Preises.
-
Bestätigen Sie die folgenden Ergebnisse:
- Die Änderung ist über Catalog Service APIs sichtbar.
- Ihr Adobe I/O Events Verbraucher erhält das entsprechende Produkt- oder Preisereignis.
Beschränkungen und Best Practices limits-and-best-practices
Befolgen Sie beim Aufbauen auf Katalogereignissen die folgenden Best Practices.
Idempotenz idempotency
Adobe I/O Events können dasselbe Katalogereignis mehrmals bereitstellen, und Ereignisse für ein einzelnes Produkt können nicht in der richtigen Reihenfolge eingehen. Gestalten Sie Verbraucher als idempotent durch:
- Verwenden von Entitäts-IDs mit einem Feld für Version oder Zeitstempel.
- Doppelte Benachrichtigungen für dieselbe Änderung werden ignoriert.
Durchsatz und Gegendruck
Große Kataloge mit hohen Aktualisierungsraten können ein signifikantes Ereignisvolumen erzeugen. Stellen Sie sicher, dass:
- Verbraucher können Ereignisse bei maximalem Durchsatz verarbeiten.
- Bei Bedarf können Sie Puffer- oder Batch-Vorgänge oder Warteschlangen verwenden.
Sicherheit und Isolation
- Adobe I/O Events erzwingt Mandantenisolation.
- Ihr Unternehmen erhält Ereignisse nur für seine eigenen Umgebungen und Berechtigungen.
Schemaentwicklung
Payloads von Katalogereignissen folgen demselben konzeptionellen Modell wie Catalog Service-APIs. So bleiben Sie vorwärtskompatibel:
- Vermeiden Sie nach Möglichkeit eine strikte Schemadurchsetzung.
- Unbekannte Felder ignorieren, anstatt fehlzuschlagen.
Fehlerbehebung bei Katalogereignissen troubleshoot-catalog-events
Wenn Katalogereignisse fehlen oder sich verzögern, führen Sie die folgenden Schritte aus.
-
Überprüfen Sie die Daten des Katalog-Service
Verwenden Sie die Catalog Service -, um zu bestätigen, dass die Katalogänderung erfolgreich gespeichert wurde.
-
Überprüfen vonSaaS Data Export
Katalogereignisse erfordern aktuelle Daten in Catalog Service. Bestätigen Sie beide Schritte des Exportpfads:
-
Feed-Export aus Commerce - Bestätigen Sie auf der Seite Status der des Daten-Feeds) oder in
var/log/saas-export.log, dass Catalog Service Feeds erfolgreich aus Commerce exportiert wurden. -
Mit verbundenen Commerce SaaS-Services synchronisieren - Bestätigen Sie im Data Management Dashboard, Catalog Sync oder in den Exportprotokollen, dass die Daten erfolgreich mit Catalog Service synchronisiert wurden.
Informationen zur Fehlerbehebung bei Export- und Synchronisierungsaufträgen finden Sie unter Synchronisieren von Daten mit dem SaaSDatenexport und Protokollierung und Fehlerbehebung.
-
-
Validieren Adobe I/O Events Konfiguration
Bestätigen Sie Folgendes:
- Sie sind bei der richtigen IMS-Organisation in Adobe Developer Console angemeldet.
- Der Commerce Catalog Events ist aktiviert.
- Der erwartete Commerce Catalog Events und die Umgebung sind sichtbar.
- Das Abonnement ist aktiv.
- Ihr Endpunkt, Ihre Aktion oder Ihr Journal-Verbraucher kann Testereignisse empfangen und verarbeiten.
-
Adobe-Support kontaktieren
Wählen Sie beim Öffnen eines Support-Tickets den Problemgrund aus, der der Adobe Commerce- entspricht, und geben Sie die folgenden Informationen ein:
- Details zum Katalog-Service (Umgebung, Region).
- Adobe I/O Events Abonnementdetails.
- Ungefähre Zeit und Beschreibung fehlender Ereignisse.
Weitere Hilfe finden Sie unter Support-Tickets.