Für einen erfolgreichen Einsatz mit Live Search
Adobe Commerce Live Search und Catalog Service arbeiten Sie zusammen, um eine leistungsfähige, relevante und intuitive Suchlösung bereitzustellen, mit der Ihre Kunden schnell genau das finden können, was sie benötigen. Insbesondere gilt: Catalog Service oberflächert Ihre Katalogdaten für SaaS-Dienste, z. B. Live Search verwendet werden.
Dieser Artikel enthält schrittweise Anweisungen zur Implementierung von Live Search mit Catalog Service.
Zielgruppe
Dieser Artikel richtet sich an Entwickler oder Systemintegratoren in Ihrem Team, die für die Installation und Konfiguration Ihrer Adobe Commerce-Instanz zuständig sind.
Voraussetzungen
- Adobe Commerce 2.4.4+
- PHP 8.1 / 8.2 / 8.3
- Composer
Unterstützte Plattformen
- Adobe Commerce on Cloud (ECE) : 2.4.4+
- Adobe Commerce On-Premise (EE) : 2.4.4+
Workflow-Übersicht
Onboarding auf hoher Ebene Live Search erfordert, dass Sie:
1. Installieren Sie die Live Search Erweiterung
Live Search wird als Erweiterung von installiert. Adobe Marketplace bis Verfasser. Nach der Installation und Konfiguration Live Search, ADOBE Commerce beginnt mit der Freigabe von Such- und Katalogdaten für SaaS-Dienste. An dieser Stelle Admin -Benutzer können Suchfacetten, Synonyme und Merchandising-Regeln einrichten, anpassen und verwalten.
-
Bestätigen Sie, dass Cron-Aufträge und Indexer laufen.
note important IMPORTANT Aufgrund der Ankündigung zum Ende der Unterstützung für Elasticsearch 7 vom August 2023 wird empfohlen, dass alle Adobe Commerce-Kunden zur OpenSearch 2.x-Suchmaschine migrieren. Informationen zur Migration Ihrer Suchmaschine während eines Produkt-Upgrades finden Sie unter Migration zu OpenSearch im Upgrade-Handbuch. -
Laden Sie die
live-search
-Paket aus Adobe Marketplace. -
Führen Sie Folgendes über die Befehlszeile aus:
code language-bash composer require magento/live-search
Wenn Sie die Variable Live Search Erweiterung auf new Führen Sie zur Deaktivierung der Adobe Commerce-Installation Folgendes aus OpenSearch und zugehörige Module und installieren Live Search. Fahren Sie dann mit Schritt 4 fort.
code language-bash bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch7 Magento_OpenSearch Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
Wenn Sie die Variable Live Search Erweiterung auf eine vorhandene Führen Sie die folgenden Schritte aus, um die Adobe Commerce-Installation vorübergehend zu deaktivieren Live Search -Module, die Storefront-Suchergebnisse bereitstellen. Fahren Sie dann mit Schritt 4 fort:
code language-bash bin/magento module:disable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
Elasticsearch verwaltet weiterhin Suchanforderungen aus dem Store, während die Live Search -Dienst synchronisiert Katalogdaten und indiziert Produkte im Hintergrund.
-
Führen Sie Folgendes aus:
code language-bash bin/magento setup:upgrade
-
Stellen Sie sicher, dass Folgendes Indexer auf "Nach Zeitplan aktualisieren"eingestellt sind:
- Produkt-Feed
- Produktvarianten-Feed
- Katalogattribut-Feed
- Produktpreis-Feed
- Umfang des Website-Daten-Feeds
- Umfang des Daten-Feeds für Kundengruppen
- Kategorien-Feed
- Kategorieberechtigungs-Feed
-
Wenn Sie die Live Search In einer neuen Commerce-Instanz sind Sie fertig und können zum 2. API-Schlüssel konfigurieren Abschnitt. Wenn Sie die Live-Suche in einer vorhandenen Commerce-Instanz installieren, fahren Sie mit dem nächsten Schritt fort.
-
Führen Sie die folgenden Befehle aus, um die Live Search Erweiterung, deaktivieren OpenSearchund ausführen
setup
.code language-bash bin/magento module:enable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
code language-bash bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch6 Magento_Elasticsearch7 Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
code language-bash bin/magento setup:upgrade
2. API-Schlüssel konfigurieren
Der Adobe Commerce-API-Schlüssel und der zugehörige private Schlüssel sind für die Verbindung erforderlich. Live Search auf eine Installation von Adobe Commerce. Der API-Schlüssel wird im Konto der Commerce Lizenzinhaber, der sie für Entwickler oder Systemintegratoren freigeben kann. Der Entwickler kann dann die SaaS-Datenräume im Auftrag des Lizenzinhabers erstellen und verwalten. Wenn Sie bereits über eine Reihe von API-Schlüsseln verfügen, müssen Sie diese nicht neu generieren.
Erfahren Sie, wie Sie Ihre API-Schlüssel im Abschnitt Commerce Services Connector Artikel.
3. Ihre Katalogdaten synchronisieren synchronize-catalog-data
Live Search verschiebt Katalogdaten in die Adobe SaaS-Infrastruktur. Die Daten werden indiziert und die Suchergebnisse werden von diesem Index direkt an die Storefront übermittelt. Je nach Größe und Komplexität kann die Indizierung zwischen 30 Minuten und einigen Stunden dauern.
Um die erste Synchronisierung Ihrer Katalogdaten mit SaaS-Diensten zu starten, führen Sie die folgenden Befehle in dieser Reihenfolge aus:
bin/magento saas:resync --feed productattributes
bin/magento saas:resync --feed products
bin/magento saas:resync --feed scopesCustomerGroup
bin/magento saas:resync --feed scopesWebsite
bin/magento saas:resync --feed prices
bin/magento saas:resync --feed productoverrides
bin/magento saas:resync --feed variants
bin/magento saas:resync --feed categories
bin/magento saas:resync --feed categoryPermissions
Wenn Sie diese Befehle ausführen, beginnt die erste Synchronisierung Ihrer Katalogdaten mit SaaS-Diensten.
cron
wird ausgeführt, um Ihre Daten mit SaaS-Diensten zu synchronisieren.Fortschritt der Synchronisierung überwachen
Sie können die synchronisierten und freigegebenen Daten mit dem Data Management Dashboard. Dieses Dashboard bietet wertvolle Einblicke in die Verfügbarkeit von Produktdaten für Ihre Storefront, sodass sie Ihren Käufern umgehend angezeigt werden können.
Zukünftige Produktaktualisierungen
Nach der ersten Synchronisierung kann es bis zu 15 Minuten dauern, bis inkrementelle Produktaktualisierungen für die Storefront-Suche verfügbar sind. Weitere Informationen finden Sie unter Indizierung - Streaming von Produktaktualisierungen.
4. Überprüfen, ob die Daten exportiert wurden verify-export
So überprüfen Sie, ob die Katalogdaten aus Ihrer Adobe Commerce-Instanz exportiert wurden und synchronisiert werden für Live Search, haben Sie einige Optionen:
-
Suchen Sie in den folgenden Tabellen nach Einträgen:
catalog_data_exporter_products
catalog_data_exporter_product_attributes
-
Verwenden Sie die GraphQL-Playground mit der Standardabfrage, um Folgendes zu überprüfen:
- Die zurückgegebene Produktanzahl entspricht in etwa dem, was Sie für die Store-Ansicht erwarten.
- Facets werden zurückgegeben.
Weitere Hilfe finden Sie unter Live Search Katalog nicht synchronisiert in der Support-Wissensdatenbank.
5. Konfigurieren der Daten
Durch die korrekte Konfiguration Ihrer Produktdaten werden gute Suchergebnisse für Ihre Kunden sichergestellt. In diesem Abschnitt aktivieren Sie die Widgets zur Produktliste und weisen Kategorien und Attribute zu.
Enable Product Listing Widgets
Bei der Installation Live Search 4.0.0+ sind Product Listing Widgets standardmäßig aktiviert. Wenn Widgets aktiviert sind, wird eine andere UI-Komponente für die Suchergebnisseite und die Kategorieseite zum Durchsuchen von Produktlisten-Seiten verwendet. Diese UI-Komponente führt direkte Aufrufe an die Catalog Service-API, was zu schnelleren Antwortzeiten führt.
Wenn Sie Live Search -Version, die älter als 4.0.0 ist, müssen Sie das Widget "Produktliste"manuell aktivieren.
-
Aus dem Admin, gehen Sie zu Stores > Settings>Configuration.
-
under Live Search auswählen Storefront Features.
-
Satz Enable Product Listing Widgets nach
Yes
.
Wenn Sie diese Konfiguration ändern, wird die Meldung Page cache is invalidated
angezeigt. Sie müssen den Magento-Cache leeren, um Ihre Änderung zu speichern.
-
Zugriff auf Cacheverwaltung Seite durch einen der folgenden Schritte:
- Klicken Sie auf Cache Management in der Meldung über dem Arbeitsbereich.
- Im Admin Seitenleiste, navigieren Sie zu System > Tools>Cache Management.
-
Wählen Sie die Konfiguration Cache Type und klicken Flush Magento Cache.
Änderungen an der Storefront werden unmittelbar nach dem Leeren des Caches vorgenommen.
Zuweisen von Kategorien
Zurückgegebene Produkte Live Search muss einer category. In Luma beispielsweise werden Produkte in Kategorien wie "Männer", "Frauen"und "Zahnrad"unterteilt. Unterkategorien sind auch "Tops", "Bottom" und "Watches". Dies ermöglicht eine bessere Granularität beim Filtern.
Durchsuchbare und filterbare Felder
Produkte werden zugewiesen attributes die für die Suche und Filterung verwendet werden können. Attribute sind Dinge wie "Farbe", "Größe", "Materialtyp". Mit diesen Attributen können Benutzer nach "grünen Spitzen"suchen. Jedes Produkt kann über viele Attribute verfügen, die im Commerce Admin.
Jedes dieser Attribute kann als "searchable" im Admin. Wenn diese Attribute als "durchsuchbar"festgelegt sind, können sie von Live Search.
Facets sind Produktattribute, die in Live Search gefilterbar sein. Jedes filterbare Attribut kann als Facette in Live Search Es gibt jedoch Einschränkungen dafür, wie viele Facetten gleichzeitig durchsucht werden können.
Synonyme sind Begriffe, die Sie definieren können, um Benutzer zum richtigen Produkt zu führen. Benutzer, die nach Hosen suchen, können "Hosen"oder "Schläge"eingeben. Sie können Synonyme festlegen, sodass diese Suchbegriffe Benutzer zu den Ergebnissen der "Hosen"führen.
6. Verbindung testen test-connection
Testen Sie mit Ihren Katalogdaten jetzt in SaaS, um sicherzustellen, dass in den folgenden Szenarien Produktdaten zurückgegeben werden:
- Die Search box gibt Ergebnisse korrekt zurück
- Kategoriesuche gibt Ergebnisse korrekt zurück
- Facets sind als Filter auf Suchergebnisseiten verfügbar
Wenn alles ordnungsgemäß funktioniert, Live Search installiert, verbunden und einsatzbereit ist.
Wenn Probleme in der Storefront auftreten, überprüfen Sie die var/log/system.log
-Datei für API-Kommunikationsfehler oder -fehler auf der Dienstseite.
In Live Search durch eine Firewall hinzufügen commerce.adobe.io
in die Zulassungsliste.
7. Benutzerspezifisch für Ihre Storefront
Sie haben die Variable Live Search Erweiterung, Synchronisierung, Validierung und Konfiguration Ihrer Daten. Jetzt möchten Sie sicherstellen, dass die Variable Live Search Widgets entsprechen dem Erscheinungsbild Ihres Stores.
Sie können die Popover- und PLP-Widgets gestalten, indem Sie nach Bedarf benutzerdefinierte CSS-Regeln definieren. Siehe Formatieren von Popover-Elementen und Seiten-Widget "Produktliste".
Wenn Sie die Funktionalität der Widgets erweitern möchten, ist der Quellcode für jedes in einem öffentlichen Repository verfügbar.
In diesem Szenario können Sie das JavaScript für Ihre eigenen Anforderungen anpassen und dann Ihren benutzerdefinierten Code auf Ihrem CDN hosten. Dieses benutzerdefinierte Skript kommuniziert mit dem Live Search und gibt die Ergebnisse wie normal zurück, sodass Sie die Funktionalität des Widgets steuern können.
Aktualisieren Live Search update
Führen Sie vor der Aktualisierung der Live Search-Suche Folgendes über die Befehlszeile aus, um die installierte Live Search-Version zu überprüfen:
composer show magento/module-live-search | grep version
Zu aktualisieren Live Search, führen Sie Folgendes über die Befehlszeile aus:
composer update magento/live-search --with-dependencies
Um auf eine Hauptversion wie 3.1.1 auf 4.0.0 zu aktualisieren, bearbeiten Sie das Stammverzeichnis des Projekts Composer .json
Datei wie folgt:
-
Wenn derzeit installiert
magento/live-search
Version ist3.1.1
und Sie aktualisieren auf Version4.0.0
oder höher führen Sie vor dem Upgrade den folgenden Befehl aus:code language-bash bin/magento module:enable Magento_AdvancedSearch
Informationen zu den derzeit installierten
magento/live-search
-Version, führen Sie den folgenden Befehl aus:code language-bash composer show magento/live-search
-
Öffnen Sie den Stamm
composer.json
Datei und suchen Sie nachmagento/live-search
. -
Im
require
aktualisieren Sie die Versionsnummer wie folgt:code language-json "require": { ... "magento/live-search": "^4.0", ... }
-
Speichern
composer.json
. Führen Sie dann Folgendes über die Befehlszeile aus:code language-bash composer update magento/live-search --with-dependencies
Deinstallation Live Search uninstall
Deinstallation Live Search, siehe Module deinstallieren.
Live Search packages packages
Die Live Search -Erweiterung umfasst die folgenden Pakete:
module-live-search
module-live-search-adapter
- Kategoriesuche - Routen von Anforderungen aus der Storefront oberste Navigation zum Suchdienst hinzu.
- Globale Suche - Routen von Anfragen von der Schnellsuche in der oberen rechten Ecke des Storefront zur Live Search -Dienst.
module-live-search-storefront-popover
Live Search dependencies dependencies
Die folgenden Live Search Abhängigkeiten werden von Composer.
magento/module-saas-catalog
magento/module-saas-category
magento/module-saas-category-permissions
magento/module-saas-product-override
magento/module-saas-product-variant
magento/module-saas-price
magento/module-saas-scopes
magento/module-bundle-product-data-exporter
magento/module-catalog-inventory-data-exporter
magento/module-catalog-url-rewrite-data-exporter
magento/module-configurable-product-data-exporter
magento/module-parent-product-data-exporter
magento/module-gift-card-product-data-exporter
magento/module-bundle-product-override-data-exporter
data-services
services-id
Erweiterte Konzepte
In den folgenden Abschnitten werden erweiterte Themen zur Verwendung von Live Search und Catalog Service.
Endpunkt
Live Search kommuniziert über den Endpunkt unter https://catalog-service.adobe.io/graphql
.
As Live Search keinen Zugriff auf die vollständige Produktdatenbank hat, Live Search GraphQL und Commerce Core GraphQL verfügen nicht über vollständige Parität.
Es wird empfohlen, die SaaS-APIs direkt aufzurufen - insbesondere den Catalog Service-Endpunkt.
- Steigern Sie die Leistung und reduzieren Sie die Prozessorlast durch Umgehen der Commerce-Datenbank/des Graphql-Prozesses.
- Nutzen Sie die Vorteile der Catalog Service Föderation anrufen Live Search, Catalog Service, und Product Recommendations von einem einzelnen Endpunkt aus.
Für einige Anwendungsfälle ist es möglicherweise besser, Catalog Service für Produktdetails und ähnliche Fälle. Siehe refineProduct für weitere Informationen.
Wenn Sie über eine benutzerdefinierte Headless-Implementierung verfügen, überprüfen Sie die Live Search Referenzimplementierungen:
Wenn Sie nicht die Standardkomponenten wie Suchadapter oder Widgets auf Luma oder AEM CIF Widgets verwenden, funktioniert Eventing (Clickstream-Daten, die Adobe Sensei für intelligente Merchandising- und Leistungsmetriken speisen) nicht standardmäßig und erfordert eine benutzerdefinierte Entwicklung, um Headless-Eventing zu implementieren.
Die neueste Version von Live Search bereits verwendet Catalog Service.
Sprachunterstützung
Live Search -Widgets unterstützen die folgenden Sprachen:
Wenn das Widget erkennt, dass die Commerce-Admin-Spracheinstellung (Stores > Einstellungen > Konfiguration > Allgemein > Länderoptionen) mit einer unterstützten Sprache übereinstimmen, wird standardmäßig diese Sprache verwendet. Andernfalls wird für die Widgets standardmäßig Englisch angezeigt.
Administratoren können auch die Sprache der Suchindex, um bessere Suchergebnisse sicherzustellen.
Widget-Code-Repository
Das Widget "Seite der Produktauflistungen"und das Widget "Feld der Live-Suche"können über ihr GitHub-Repository heruntergeladen werden.
Dadurch können Entwickler die Funktionalität und den Stil vollständig anpassen. Diese Benutzer hosten den Code selbst, während sie weiterhin die Live Search -Dienst.
Inventory management
Live Search unterstützt Inventory management Funktionen in Commerce (ehemals "Multi-Source Inventory"oder "MSI"). Um den vollständigen Support zu ermöglichen, müssen Sie update das Abhängigkeitsmodul commerce-data-export
auf Version 102.2.0+.
Live Search gibt einen booleschen Hinweis zurück, ob ein Produkt in Inventory management verfügbar ist, enthält jedoch keine Informationen darüber, welche Quelle über das Lager verfügt.
Preisindex
Live Search-Kunden können die neue SaaS-Preisindexer, was schnellere Preisänderungen und Synchronisierungszeiten ermöglicht.
Preisstützung
Live Search-Widgets unterstützen die meisten, aber nicht alle von Adobe Commerce unterstützten Preistypen.
Derzeit werden Basispreise unterstützt. Folgende erweiterte Preise werden nicht unterstützt:
- Kosten
- Mindestpreis für Werbung
Sehen Sie sich an API-Mesh für komplexere Preisberechnungen.
Das Preisformat unterstützt die Gebietsschema-Konfigurationseinstellung innerhalb der Commerce-Instanz: Stores > Einstellungen > Konfiguration > Allgemein > Allgemein > Lokale Optionen > Gebietsschema.
Headless-Storefront-Unterstützung
Optional müssen Sie möglicherweise die module-data-services-graphql
-Modul, das die bestehende GraphQL-Abdeckung der Anwendung erweitert und Felder enthält, die für die Erfassung von Verhaltensdaten aus Storefront erforderlich sind.
composer require magento/module-data-services-graphql
Dieses Modul fügt GraphQL-Abfragen zusätzliche Kontexte hinzu:
dataServicesStorefrontInstanceContext
dataServicesMagentoExtensionContext
dataServicesStoreConfigurationContext
PWA-Unterstützung
Live Search funktioniert mit PWA Studio, aber die Benutzer sehen möglicherweise leichte Unterschiede im Vergleich zu anderen Commerce-Implementierungen. Grundlegende Funktionen wie Such- und Produktlistenseite funktionieren in Venia, aber einige Permutationen von Graphql funktionieren möglicherweise nicht ordnungsgemäß. Es kann auch Leistungsunterschiede geben.
- Die aktuelle PWA-Implementierung von Live Search benötigt mehr Verarbeitungszeit, um Suchergebnisse zurückzugeben als Live Search mit der nativen Commerce-Storefront.
- Live Search in PWA wird nicht unterstützt Ereignisverarbeitung. Daher funktionieren Suchberichte und intelligentes Merchandising.
- Direktes Filtern auf
description
,name
,short_description
wird von GraphQL nicht unterstützt, wenn PWA, werden jedoch mit einem allgemeineren Filter zurückgegeben.
Verwendung Live Search Mit PWA Studio müssen Integratoren auch:
-
Installieren livesearch-storefront-utils.
-
Legen Sie die
environmentId
imstoreDetails
-Objekt.code language-javascript const storeDetails: StoreDetailsProps = { environmentId: <Storefront_ID>, websiteCode: "base", storeCode: "main_website_store", storeViewCode: "default", searchUnitId: searchUnitId, config: { minQueryLength: 5, pageSize: 8, currencySymbol: "$", }, };
Cookies
Live Search erfasst Benutzerinteraktionsdaten im Rahmen der grundlegenden Funktionalität und Cookies werden zum Speichern dieser Daten verwendet. Beim Erfassen von Benutzerinformationen muss der Benutzer dem Speichern von Cookies zustimmen. Live Search und Product Recommendations den Datenstrom und damit denselben Cookie-Mechanismus teilen. Weitere Informationen dazu finden Sie unter Umgang mit Cookie-Einschränkungen.