Instellen voor succes met Live Search
Adobe Commerce Live Search en Catalog Service werken samen om een krachtige, relevante en intuïtieve zoekoplossing te bieden, zodat uw klanten snel precies kunnen vinden wat ze nodig hebben. Catalog Service bevat met name de catalogusgegevens die u wilt gebruiken voor SaaS-services, zoals Live Search .
Dit artikel bevat stapsgewijze instructies voor het implementeren van Live Search met Catalog Service .
Publiek
Dit artikel is bedoeld voor de ontwikkelaar of systeemintegrator in uw team die verantwoordelijk is voor de installatie en configuratie van uw Adobe Commerce-exemplaar.
Vereisten
- Adobe Commerce2.4.4+
- PHP 8.1 / 8.2 / 8.3
- Composer
Ondersteunde platforms
- Adobe Commerce on Cloud (ECE) : 2.4.4+
- Adobe Commerce on-prem (EE) : 2.4.4+
Workflowoverzicht
Op een hoog niveau is het vereist dat u: Live Search
1. Installeer de extensie Live Search
Live Search is geïnstalleerd als uitbreiding van Adobe Marketplacedoor Composer. Nadat u Live Search hebt geïnstalleerd en geconfigureerd, begint Adobe Commerce met het delen van zoek- en catalogusgegevens met SaaS-services. Op dit punt, Admin kunnen de gebruikers opstelling, aanpassen, en onderzoeksfacetten, synoniemen, en handelswijzigingsregels beheren.
-
Bevestig dat gewassenbanenen indexeerderslopen.
note important IMPORTANT Gezien de Elasticsearch 7 eindeaankondiging voor augustus 2023, wordt aanbevolen dat alle Adobe Commerce-klanten naar de OpenSearch 2.x zoekmachine migreren. Voor informatie over het migreren van uw onderzoeksmotor tijdens een productverbetering, zie Migrerend aan OpenSearchin de Gids van de Verbetering. -
Download het
live-search
pakket van de Marketplace van de Adobe. -
Voer de volgende handelingen uit vanaf de opdrachtregel:
code language-bash composer require magento/live-search
Als u de Live Search uitbreiding aan a nieuwe installatie van Adobe Commerce toevoegt, stel het volgende in werking om OpenSearch en verwante modules onbruikbaar te maken, en te installeren Live Search. Ga vervolgens verder met stap 4.
code language-bash bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch7 Magento_OpenSearch Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
Als u de Live Search uitbreiding aan een bestaande installatie van Adobe Commerce toevoegt, stel het volgende in werking om de Live Search modules tijdelijk onbruikbaar te maken die de resultaten van het storefrontonderzoek dienen. Ga vervolgens verder met stap 4:
code language-bash bin/magento module:disable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
Elasticsearch blijft zoekverzoeken van de winkel beheren terwijl de Live Search -service catalogusgegevens en indexproducten op de achtergrond synchroniseert.
-
Voer de volgende handelingen uit:
code language-bash bin/magento setup:upgrade
-
Verifieer dat de volgende indexeerdersaan "Update door Programma"worden geplaatst:
- Productfeed
- Diervoeders voor productvarianten
- Feed voor cataloguskenmerken
- Diervoeders productprijzen
- Websitegegevensfeed
- Scopes Klantengroepen Gegevensfeed
- Diervoeders voor categorieën
- Diervoeders voor categorierechten
-
Als u Live Search op een nieuwe instantie van Commerce installeert, wordt u gedaan en kunt overslaan aan 2. Vorm API sleutelssectie. Ga door met de volgende stap als u Live Search installeert op een bestaand Commerce-exemplaar.
-
Voer de volgende opdrachten uit om de extensie Live Search in te schakelen, OpenSearch uit te schakelen en
setup
uit te voeren.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-sleutels configureren
De Adobe Commerce API-sleutel en de bijbehorende persoonlijke sleutel zijn vereist om Live Search te verbinden met een installatie van Adobe Commerce. De API-sleutel wordt gegenereerd en onderhouden in de account van de Commerce -licentienemer, die deze kan delen met de ontwikkelaar of de systeemintegrator. De ontwikkelaar kan vervolgens de SaaS-gegevensruimten maken en beheren namens de licentiehouder. Als u al een set API-sleutels hebt, hoeft u deze niet opnieuw te genereren.
Leer hoe te om uw API sleutels in het 1} artikel van de Schakelaar van de Diensten van Commerce te vormen.
3. Synchroniseer uw catalogusgegevens synchronize-catalog-data
Live Search verplaatst catalogusgegevens naar de SaaS-infrastructuur van de Adobe. De gegevens worden geïndexeerd en de zoekresultaten worden vanuit deze index rechtstreeks aan de winkel geleverd. Afhankelijk van de grootte en complexiteit kan het indexeren 30 minuten tot een paar uur duren.
Voer de volgende opdrachten in deze volgorde uit om te beginnen met de eerste synchronisatie van uw catalogusgegevens naar SaaS-services:
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
Wanneer u deze opdrachten uitvoert, begint de eerste synchronisatie van de catalogusgegevens met de SaaS-services.
cron
wordt uitgevoerd om uw gegevens te synchroniseren met SaaS-services.Synchronisatievoortgang controleren
U kunt de gegevens bekijken die worden gesynchroniseerd en worden gedeeld gebruikend het Dashboard van het Beheer van Gegevens. Dit dashboard biedt waardevolle inzichten in de beschikbaarheid van productgegevens voor uw winkel, zodat deze direct aan uw klanten kunnen worden weergegeven.
U kunt synchronisatiebevelen ook in werking stellen en het synchronisatieproces problemen oplossen gebruikend Commerce CLIen de logboeken van de gegevensuitvoer.
Updates voor toekomstige producten
Na de eerste synchronisatie kan het tot 15 minuten duren voordat de incrementele productupdates beschikbaar komen voor het zoeken naar een winkel. Om meer te leren, zie Indexeren - het stromen de Updates van het Product.
4. Controleer of de gegevens zijn geëxporteerd verify-export
U hebt een aantal opties om te controleren of de catalogusgegevens uit uw Adobe Commerce-exemplaar zijn geëxporteerd en voor Live Search zijn gesynchroniseerd:
-
Zoek naar ingangen in de volgende lijsten:
catalog_data_exporter_products
catalog_data_exporter_product_attributes
-
Gebruik playground van GraphQLmet de standaardvraag om het volgende te verifiëren:
- Het aantal geretourneerde producten ligt dicht bij wat u voor de winkelweergave verwacht.
- Facetten worden geretourneerd.
Voor extra hulp, zie Live Search niet gesynchroniseerde catalogusin de Kennisbank van de Steun.
5. Vorm de gegevens
Als u uw productgegevens correct configureert, bent u verzekerd van goede zoekresultaten voor uw klanten. In deze sectie schakelt u de widgets voor productlijsten in en wijst u categorieën toe.
Widgets productlijst inschakelen
Wanneer u Live Search 4.0.0+ installeert, worden de Widgets van de Lijst van het Product door gebrek toegelaten. Wanneer widgets zijn ingeschakeld, wordt een andere UI-component gebruikt voor de pagina met zoekresultaten en voor de pagina met productaanbiedingen in de categorie. Deze component UI doet directe vraag aan de Dienst API van de Catalogus, die in snellere reactietijden resulteert.
Als u een Live Search -versie hebt die ouder is dan 4.0.0+, moet u de widget Productaanbieding handmatig inschakelen.
-
Van Admin, ga Stores > Settings>Configuration.
-
Selecteer onder Live Search de optie Storefront Features .
-
Stel Enable Product Listing Widgets in op
Yes
.
Wanneer u deze configuratie wijzigt, verschijnt het bericht Page cache is invalidated
. U moet het Geheime voorgeheugen van het Magento leegmaken om uw verandering te bewaren.
-
Heb toegang tot de pagina van het Beheer van het Geheime voorgeheugendoor één van het volgende te doen:
- Klik op de koppeling Cache Management in het bericht boven de werkruimte.
- Voor Admin sidebar, ga System > Tools>Cache Management.
-
Selecteer de Configuratie Cache Type en klik Flush Magento Cache.
Wijzigingen in de winkel worden direct na het leegmaken van de cache aangebracht.
Categorieën toewijzen
De producten die in Live Search zijn teruggekeerd moeten aan a worden toegewezen categorie. In Luma worden producten bijvoorbeeld ingedeeld in categorieën zoals "Mannen", "Vrouwen" en "Luma". Subcategorieën worden ook ingesteld voor Tops, Bottoms en Watches. Hierdoor wordt de korreligheid bij het filteren verbeterd.
6. Test de verbinding test-connection
Met uw catalogusgegevens nu in SaaS, test om ervoor te zorgen de productgegevens in de volgende scenario's zijn teruggekeerd:
- Het vak Search retourneert de juiste resultaten
- Met bladeren door categorie worden de resultaten correct geretourneerd
- Factoren zijn als filters beschikbaar op pagina's met zoekresultaten
Als alles correct werkt, wordt Live Search geïnstalleerd, aangesloten en klaar te gebruiken.
Als u problemen tegenkomt in de winkel, controleert u het bestand var/log/system.log
op API-communicatiefouten of -fouten aan de kant van de service.
Als u Live Search wilt toestaan via een firewall, voegt u commerce.adobe.io
toe aan de lijst van gewenste personen.
7. Aanpassen voor je winkel
U hebt de extensie Live Search geïnstalleerd, gesynchroniseerd, gevalideerd en geconfigureerd. Nu wilt u ervoor zorgen dat de Live Search -widgets overeenkomen met de vormgeving van uw winkel.
U kunt de popover- en PLP-widgets opmaken door desgewenst aangepaste CSS-regels te definiëren. Zie het Stijlen Popover Elementenen van de Lijst van het Product de Widget van de Pagina.
Als u de functionaliteit van de widgets wilt uitbreiden, is de broncode voor elke widget beschikbaar in een openbare reactie.
In dit scenario, kunt u JavaScript voor uw eigen behoeften aanpassen en dan uw douanecode ontvangen op uw CDN. Dit aangepaste script communiceert met de service Live Search en retourneert de resultaten zoals normaal, zodat u de functionaliteit van de widget kunt beheren.
Live Search bijwerken update
Voer voordat u Live zoeken bijwerkt de volgende handelingen uit vanaf de opdrachtregel om de geïnstalleerde versie van Live Search te controleren:
composer show magento/module-live-search | grep version
Voer de volgende handelingen uit vanaf de opdrachtregel om Live Search bij te werken:
composer update magento/live-search --with-dependencies
Als u een update wilt uitvoeren naar een belangrijke versie zoals 3.1.1 en 4.0.0, bewerkt u het hoofdbestand Composer .json
van het project als volgt:
-
Als de momenteel geïnstalleerde
magento/live-search
versie3.1.1
of lager is en u een upgrade uitvoert naar versie4.0.0
of hoger, voert u de volgende opdracht uit vóór de upgrade:code language-bash bin/magento module:enable Magento_AdvancedSearch
Voer de volgende opdracht uit voor informatie over de momenteel geïnstalleerde versie van
magento/live-search
:code language-bash composer show magento/live-search
-
Open het hoofdbestand
composer.json
en zoek naarmagento/live-search
. -
Werk in de sectie
require
het versienummer als volgt bij:code language-json "require": { ... "magento/live-search": "^4.0", ... }
-
Opslaan
composer.json
. Voer vervolgens de volgende handelingen uit vanaf de opdrachtregel:code language-bash composer update magento/live-search --with-dependencies
Live Search verwijderen uninstall
Om Live Search te desinstalleren, verwijs naar modules van de Desinstallatie.
Live Search pakketten packages
De extensie Live Search bestaat uit de volgende pakketten:
module-live-search
module-live-search-adapter
- de doorblader van de Categorie - Routes verzoekt van de storefront hoogste navigatieaan de onderzoeksdienst.
- Globaal onderzoek - Routes verzoekt van de snelle onderzoekdoos in het hoger-recht van de storefront aan de Live Search dienst.
module-live-search-storefront-popover
Live Search afhankelijkheden dependencies
De volgende Live Search afhankelijkheden worden vastgelegd door 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
Geavanceerde concepten
De volgende secties bieden geavanceerdere onderwerpen wanneer u Live Search en Catalog Service gebruikt.
Endpoint
Live Search communiceert via het eindpunt op https://catalog-service.adobe.io/graphql
.
Aangezien Live Search geen toegang heeft tot de volledige productdatabase, hebben Live Search GraphQL en Commerce core GraphQL geen volledige pariteit.
Het wordt geadviseerd om SaaS APIs direct te roepen - specifiek het eindpunt van de Dienst van de Catalogus.
- Verhoog de prestaties en verlaag de processorbelasting door het Commerce-database/Graphql-proces te omzeilen
- Haal voordeel uit de Catalog Service -federatie om Live Search , Catalog Service en Product Recommendations vanaf één eindpunt aan te roepen.
In sommige gevallen is het beter om Catalog Service op te roepen voor productdetails en vergelijkbare gevallen. Zie refineProductvoor meer informatie.
Als u een aangepaste implementatie zonder kop hebt, checkt u de Live Search referentie-implementaties uit:
Als u niet de standaardcomponenten, zoals de Adapter of widgets van het Onderzoek op Luma, of AEM widgets gebruikt, zal de gebeurtenis (klikstroomgegevens die Adobe Sensei voor Intelligente Merchandising en prestatiesmetriek van de voer voorzien) niet uit de doos werken en zal de douaneontwikkeling vereisen om hoofdloze gebeurtenis uit te voeren.
De meest recente versie van Live Search gebruikt Catalog Service al.
Taalondersteuning
Live Search -widgets ondersteunen de volgende talen:
Als widget ontdekt dat de taal die van Commerce Admin (plaatst opslaat > Montages > Configuratie > Algemene > de Opties van het Land) een gesteunde taal aanpast, blijft het aan die taal in gebreke. Anders worden de widgets standaard ingesteld op Engels.
Admins kan de taal van de onderzoeksindexook plaatsen, helpen betere onderzoeksresultaten verzekeren.
Widget-codeopslagplaats
De widget pagina met productlijsten en de widget veld Live zoeken kunnen beide worden gedownload van hun kleine opslagplaats.
Op deze manier kunnen ontwikkelaars de functionaliteit en opmaak volledig aanpassen. Deze gebruikers hosten de code zelf terwijl het voordeel van de Live Search dienst blijft.
Extensie Gegevens
Nadat Live zoeken is ingeschakeld, worden met de extensie Gegevens exporteren Commerce-gegevens gesynchroniseerd tussen de Commerce-toepassing en Live zoeken. Dit proces zorgt ervoor dat de meest recente Commerce-gegevens beschikbaar zijn in de winkel. In Admin, kunt u synchronisatiestatus controleren gebruikend het dashboard van het Beheer van Gegevens. U kunt het gegevensexportproces beheren en problemen oplossen met de Commerce CLI en de logboeken. Voor details, zie de Gids van de Uitvoer van Gegevens.
Inventory management
Live Search steunt Inventory managementmogelijkheden in Commerce (weet vroeger als Voorraad Multi-Source, of MSI). Om volledige steun toe te laten, moet u 🔗 de gebiedsdeelmodule commerce-data-export
aan versie 102.2.0+ bijwerken.
Live Search retourneert een Booleaanse waarde die aangeeft of een product beschikbaar is in Inventory management, maar die geen informatie bevat over de bron die de voorraad heeft.
Prijsindexering
De actieve klanten van het Onderzoek kunnen SaaS prijsindexeerdergebruiken, die snellere de updates van de prijsverandering en synchronisatietijd verstrekt.
Prijsondersteuning
Live zoekwidgets bieden ondersteuning voor de meeste, maar niet voor alle typen prijzen die door Adobe Commerce worden ondersteund.
Momenteel worden de basisprijzen ondersteund. Geavanceerde prijzen die niet worden ondersteund zijn:
- Kosten
- Minimale geadverteerde prijs
Kijk naar API Netvoor complexere prijsberekeningen.
Het prijsformaat steunt de scèneconfiguratie die binnen de instantie van Commerce plaatst: Slaat > Montages > Configuratie > Algemeen > Algemene > Lokale Opties > Scène op.
Ondersteuning voor headless Storefront
U kunt desgewenst de module module-data-services-graphql
installeren die de bestaande GraphQL-dekking van de toepassing uitbreidt, zodat deze velden bevat die vereist zijn voor het verzamelen van gedragsgegevens van de winkel.
composer require magento/module-data-services-graphql
Deze module voegt extra contexten aan de vragen van GraphQL toe:
dataServicesStorefrontInstanceContext
dataServicesMagentoExtensionContext
dataServicesStoreConfigurationContext
B2B-ondersteuning
Live Search steunt functionaliteit B2Bmet extra beperkingen.
PWA-ondersteuning
Live Search werkt met PWA Studio, maar gebruikers zien mogelijk kleine verschillen ten opzichte van andere Commerce-implementaties. De basisfunctionaliteit zoals zoeken en pagina met productlijsten werkt in Venia, maar sommige permutaties van Graphql werken mogelijk niet correct. Er kunnen ook prestatieverschillen zijn.
- De huidige PWA-implementatie van Live Search vereist meer verwerkingstijd om zoekresultaten te retourneren dan Live Search met de native Commerce-storefront.
- Live Search in PWA steunt gebeurtenis behandelingniet. Zodoende zullen zoekverslagen en intelligente koophandel werken.
- Het filtreren direct op
description
,name
,short_description
wordt niet gesteund door GraphQL wanneer gebruikt met PWA, maar zij zijn teruggekeerd met een meer algemene filter.
Als u Live Search met PWA Studio wilt gebruiken, moeten integrators ook:
-
Installeer livessearch-storefront-utils.
-
Stel de waarde
environmentId
in hetstoreDetails
-object in.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 verzamelt gegevens over gebruikersinteractie als onderdeel van de basisfunctionaliteit en cookies worden gebruikt om deze gegevens op te slaan. Wanneer de gebruiker om het even welke gebruikersinformatie verzamelt, moet de gebruiker ermee instemmen om koekjes op te slaan. Live Search en Product Recommendations delen de gegevensstroom en dus hetzelfde cookiemechanisme. Lees meer over het in de Beperkingen van de Koekjescookie.