Configurado correctamente con Live Search
Adobe Commerce Live Search y Catalog Service trabaje en conjunto para proporcionar una solución de búsqueda eficaz, relevante e intuitiva que permita a sus clientes encontrar exactamente lo que necesitan con rapidez. Específicamente, Catalog Service muestra los datos del catálogo para servicios SaaS, como Live Search para usar.
Este artículo contiene instrucciones paso a paso para implementar Live Search con Catalog Service.
Público
Este artículo está dirigido al desarrollador o integrador de sistemas de su equipo, responsable de instalar y configurar la instancia de Adobe Commerce.
Requisitos
- Adobe Commerce 2.4.4+
- PHP 8.1/8.2/8.3
- Composer
Plataformas compatibles
- Adobe Commerce en la nube (ECE) : 2.4.4+
- Adobe Commerce local (EE) : 2.4.4+
Resumen de flujo de trabajo
En un nivel superior, la incorporación Live Search requiere que:
1. Instale el Live Search extensión
Live Search se instala como una extensión desde Adobe Marketplace mediante Compositor. Después de instalar y configurar Live Search, ADOBE Commerce comienza a compartir datos de catálogo y búsqueda con los servicios SaaS. En este punto, Administrador los usuarios pueden configurar, personalizar y administrar facetas de búsqueda, sinónimos y reglas de comercialización.
-
Confirme que trabajos cron y indexadores se están ejecutando.
note important IMPORTANT Debido al anuncio de fin de soporte de Elasticsearch 7 para agosto de 2023, se recomienda que todos los clientes de Adobe Commerce migren al motor de búsqueda OpenSearch 2.x. Para obtener información sobre la migración del motor de búsqueda durante una actualización de producto, consulte Migración a OpenSearch en el Guía de actualización. -
Descargue la
live-search
paquete desde el Adobe Marketplace. -
Ejecute lo siguiente desde la línea de comandos:
code language-bash composer require magento/live-search
Si va a agregar el Live Search extensión a nuevo Instalación de Adobe Commerce, ejecute lo siguiente para deshabilitar OpenSearch y módulos relacionados, e instale Live Search. A continuación, continúe con el paso 4.
code language-bash bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch7 Magento_OpenSearch Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
Si va a agregar el Live Search extensión a un existente Instalación de Adobe Commerce, ejecute lo siguiente para deshabilitar temporalmente Live Search módulos de que sirven a resultados de búsqueda de tiendas. A continuación, continúe con el paso 4:
code language-bash bin/magento module:disable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
Elasticsearch sigue administrando las solicitudes de búsqueda de la tienda mientras la variable Live Search El servicio sincroniza los datos del catálogo e indexa los productos en segundo plano.
-
Ejecute lo siguiente:
code language-bash bin/magento setup:upgrade
-
Compruebe que lo siguiente indexadores están configuradas como "Actualizar según lo programado":
- Fuente de productos
- Fuente de variante del producto
- Fuente de atributos de catálogo
- Fuente de precios de productos
- Fuente de datos del sitio web Ámbitos
- Fuente de datos de grupos de clientes ámbitos
- Fuente de categorías
- Fuente de permisos de categoría
-
Si va a instalar Live Search en una nueva instancia de Commerce, ha terminado y puede pasar al 2. Configuración de claves API sección. Si va a instalar Live Search en una instancia de Commerce existente, continúe con el siguiente paso.
-
Ejecute los siguientes comandos para habilitar la variable Live Search extensión, deshabilitar OpenSearch, y ejecute
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. Configurar las claves API
La clave de la API de Adobe Commerce y su clave privada asociada son necesarias para conectarse Live Search a una instalación de Adobe Commerce. La clave de API se genera y se mantiene en la cuenta de Commerce titular de la licencia, que puede compartirla con el desarrollador o el integrador de sistemas. A continuación, el desarrollador puede crear y administrar los espacios de datos SaaS en nombre del titular de la licencia. Si ya tiene un conjunto de claves API, no es necesario que las vuelva a generar.
Obtenga información sobre cómo configurar las claves API en la Conector de Commerce Services artículo.
3. Sincronizar los datos del catálogo synchronize-catalog-data
Live Search mueve los datos del catálogo a la infraestructura de SaaS de Adobe. Los datos se indexan y los resultados de búsqueda se envían desde este índice directamente a la tienda. Según el tamaño y la complejidad, la indexación puede tardar entre 30 minutos y un par de horas.
Para comenzar la sincronización inicial de los datos del catálogo con los servicios SaaS, ejecute los siguientes comandos en este orden:
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
Al ejecutar estos comandos, comienza la sincronización inicial de los datos del catálogo con los servicios SaaS.
cron
se ejecuta para sincronizar los datos con los servicios SaaS.Monitorización del progreso de sincronización
Puede ver los datos sincronizados y compartidos mediante el Tablero de administración de datos. Este tablero proporciona información valiosa sobre la disponibilidad de los datos de productos para su tienda, lo que garantiza que se puedan mostrar rápidamente a sus compradores.
Futuras actualizaciones de productos
Después de la sincronización inicial, las actualizaciones incrementales de productos pueden tardar hasta 15 minutos en estar disponibles para la búsqueda de tiendas. Para obtener más información, consulte Indexación: actualizaciones de productos de streaming.
4. Compruebe que los datos se han exportado verify-export
Para comprobar que los datos del catálogo se han exportado desde la instancia de Adobe Commerce y que están sincronizados para Live Search, tiene un par de opciones:
-
Busque entradas en las tablas siguientes:
catalog_data_exporter_products
catalog_data_exporter_product_attributes
-
Utilice el GraphQL playground con la consulta predeterminada para comprobar lo siguiente:
- El recuento de productos devuelto está cerca de lo que se espera en la vista de la tienda.
- Se devuelven las facetas.
Para obtener ayuda adicional, consulte Live Search catálogo no sincronizado en la Base de conocimiento de asistencia.
5. Configurar los datos
Configurar correctamente los datos del producto garantiza buenos resultados de búsqueda para los clientes. En esta sección, se habilitan los widgets de la lista de productos y se asignan categorías y atributos.
Activar widgets de lista de productos
Al instalar Live Search 4.0.0+, Los widgets de lista de productos están habilitados de forma predeterminada. Cuando los widgets están habilitados, se utiliza un componente de interfaz de usuario diferente para la página de resultados de búsqueda y la página de exploración de categorías Lista de productos. Este componente de interfaz de usuario realiza llamadas directas a API del servicio de catálogo, lo que se traduce en tiempos de respuesta más rápidos.
Si tiene un Live Search versión anterior a la 4.0.0 o posterior, debe habilitar manualmente el widget de lista de productos.
-
Desde el Administrador, vaya a Stores > Settings>Configuration.
-
En Live Search, seleccione Storefront Features.
-
Establecer Enable Product Listing Widgets hasta
Yes
.
Cuando cambie esta configuración, el mensaje Page cache is invalidated
aparece. Debe vaciar la caché del Magento para guardar el cambio.
-
Acceda a la Administración de caché haciendo una de las siguientes acciones:
- Haga clic en Cache Management en el mensaje situado encima del espacio de trabajo.
- En el Administrador barra lateral, vaya a System > Tools>Cache Management.
-
Seleccione el Configuración Cache Type y haga clic en Flush Magento Cache.
Los cambios en la tienda son inmediatos después de vaciar la caché.
Asignar categorías
Productos devueltos en Live Search debe asignarse a un categoría. En Luma, por ejemplo, los productos se clasifican en categorías como "Hombres", "Mujeres" y "Equipos". También se configuran subcategorías para "Tops", "Bottom" y "Watches". Esto permite una mejor granularidad al filtrar.
Campos que se pueden buscar y filtrar
Se asignan los productos atributos que se puede utilizar para buscar y filtrar. Los atributos son elementos como "Color", "Tamaño" o "Tipo de material". Con estos atributos, los usuarios pueden buscar "tapas verdes". Cada producto puede tener muchos atributos definidos en la variable Commerce Administrador.
Cada uno de estos atributos se puede definir como "buscable" en el Administrador. Cuando se establece como "en los que se pueden realizar búsquedas", esos atributos están disponibles para su búsqueda Live Search.
Facetas son atributos de producto definidos en Live Search para poder filtrar. Cualquier atributo filtrable puede definirse como una faceta en Live Search pero hay límites a la cantidad de facetas que se pueden buscar al mismo tiempo.
Sinónimos son términos que puede definir para ayudar a guiar a los usuarios hacia el producto correcto. Los usuarios que buscan pantalones pueden escribir "pantalones" o "pantalones". Puede establecer sinónimos para que estos términos de búsqueda lleven a los usuarios a los resultados de "pantalones".
6. Compruebe la conexión test-connection
Con los datos del catálogo ahora en SaaS, pruebe para asegurarse de que los datos del producto se devuelvan en los siguientes casos:
- El Search devuelve los resultados correctamente
- La exploración de categorías devuelve los resultados correctamente
- Las facetas están disponibles como filtros en las páginas de resultados de búsqueda
Si todo funciona correctamente, Live Search está instalado, conectado y listo para usar.
Si encuentra problemas en la tienda, consulte la var/log/system.log
para errores de comunicación de API o errores en el lado de los servicios.
Para permitir Live Search a través de un cortafuegos, añada commerce.adobe.io
a la lista de permitidos.
7. Personalizar para tu tienda
Ha instalado el Live Search extensión, sincronizados, validados y configurados de los datos. Ahora, debe asegurarse de que la variable Live Search Los widgets se ajustan al aspecto y la presentación de la tienda.
Puede aplicar estilo a los widgets de ventana emergente y PLP definiendo reglas CSS personalizadas según sea necesario. Consulte Estilo de elementos emergentes y Widget de página de lista de productos.
Si desea ampliar la funcionalidad de los widgets, el código fuente de cada uno está disponible en un repositorio público.
En esta situación, puede personalizar JavaScript para sus propias necesidades y, a continuación, alojar el código personalizado en su CDN. Este script personalizado se comunica con el Live Search y devuelve los resultados como de costumbre, lo que le permite controlar la funcionalidad del widget.
Actualizando Live Search update
Antes de actualizar Live Search, ejecute lo siguiente desde la línea de comandos para comprobar la versión de Live Search instalada:
composer show magento/module-live-search | grep version
Para actualizar Live Search, ejecute lo siguiente desde la línea de comandos:
composer update magento/live-search --with-dependencies
Para actualizar a una versión principal como de 3.1.1 a 4.0.0, edite la raíz del proyecto Composer .json
como se indica a continuación:
-
Si está instalado
magento/live-search
la versión es3.1.1
o inferior, y está actualizando a la versión4.0.0
O superior, ejecute el siguiente comando antes de la actualización:code language-bash bin/magento module:enable Magento_AdvancedSearch
Para obtener más información sobre el instalado actualmente
magento/live-search
versión, ejecute el siguiente comando:code language-bash composer show magento/live-search
-
Abra la raíz
composer.json
archivo y buscarmagento/live-search
. -
En el
require
, actualice el número de versión como se indica a continuación:code language-json "require": { ... "magento/live-search": "^4.0", ... }
-
Guardar
composer.json
. A continuación, ejecute lo siguiente desde la línea de comandos:code language-bash composer update magento/live-search --with-dependencies
Desinstalación Live Search uninstall
Para desinstalar Live Search, consulte Desinstalación de módulos.
Live Search paquetes packages
El Live Search La extensión de consta de los siguientes paquetes:
module-live-search
module-live-search-adapter
- Navegador de categorías - Enruta las solicitudes desde la tienda navegación superior al servicio de búsqueda.
- Búsqueda global: enruta solicitudes desde el búsqueda rápida situado en la esquina superior derecha de la tienda, junto al Live Search servicio.
module-live-search-storefront-popover
Live Search dependencias dependencies
Lo siguiente Live Search Las dependencias son capturadas por 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
Conceptos avanzados
Las secciones siguientes proporcionan temas más avanzados al utilizar Live Search y Catalog Service.
Extremo
Live Search se comunica a través del punto final en https://catalog-service.adobe.io/graphql
.
Como Live Search no tiene acceso a la base de datos de productos completa, Live Search GraphQL y Commerce Core GraphQL no tendrán paridad completa.
Se recomienda llamar a las API de SaaS directamente, específicamente al extremo del servicio de catálogo.
- Obtenga rendimiento y reduzca la carga del procesador omitiendo el proceso de Graphql/base de datos de Commerce
- Aproveche las ventajas de Catalog Service federación a la que llamar Live Search, Catalog Service, y Product Recommendations desde un único punto final.
En algunos casos de uso, quizá sea mejor llamar a Catalog Service para obtener detalles del producto y casos similares. Consulte refineProduct para obtener más información.
Si tiene una implementación personalizada sin encabezado, consulte la Live Search implementaciones de referencia:
AEM CIF Si no utiliza los componentes predeterminados, como el adaptador de búsqueda o los widgets en Luma, o los widgets de la, los eventos (datos del flujo de navegación que alimentan a Adobe Sensei para las métricas de rendimiento y comercialización inteligentes) no funcionarán de forma predeterminada y requieren desarrollo personalizado para implementar eventos sin encabezado.
La versión más reciente de Live Search ya utiliza Catalog Service.
Compatibilidad de idiomas
Live Search los widgets admiten los siguientes idiomas:
Si el widget detecta que la configuración de idioma del administrador de Commerce (Tiendas > Configuración > Configuración > General > Opciones de país) coincide con un idioma admitido; el valor predeterminado es ese idioma. De lo contrario, los widgets se muestran en inglés de forma predeterminada.
Los administradores también pueden establecer el idioma de índice de búsqueda, para garantizar mejores resultados de búsqueda.
Repositorio de código Widget
El widget de página de lista de productos y el widget de campo de Live Search están disponibles para su descarga en el repositorio de github.
Esto permite a los desarrolladores personalizar completamente la funcionalidad y el estilo. Estos usuarios alojan el código ellos mismos sin dejar de aprovechar el Live Search servicio.
Inventory management
Live Search admite Inventory management en Commerce (anteriormente conocido como Inventario de varias fuentes o MSI). Para habilitar la compatibilidad total, debe actualizar el módulo de dependencia commerce-data-export
a la versión 102.2.0+.
Live Search devuelve un valor booleano que indica si un producto está disponible en Inventory management, pero no contiene información sobre el origen que tiene las existencias.
Indexador de precios
Los clientes de Live Search pueden usar el nuevo Indexador de precios SaaS, que ofrece actualizaciones de precios y tiempos de sincronización más rápidos.
Tarifa soportada
Los widgets de Live Search admiten la mayoría de los tipos de precio admitidos por Adobe Commerce, pero no todos.
Actualmente, se admiten precios básicos. Los precios avanzados que no son compatibles son:
- Coste
- Precio Mínimo Anunciado
Observe lo siguiente API Mesh para cálculos de precios más complejos.
El formato de precio admite la configuración regional en la instancia de Commerce: Tiendas > Configuración > Configuración > General > General > Opciones locales > Configuración regional.
Compatibilidad con tienda sin encabezado
De forma opcional, es posible que tenga que instalar el module-data-services-graphql
que amplía la cobertura de GraphQL existente de la aplicación para incluir los campos necesarios para la recopilación de datos de comportamiento de la tienda.
composer require magento/module-data-services-graphql
Este módulo agrega contextos adicionales a las consultas de GraphQL:
dataServicesStorefrontInstanceContext
dataServicesMagentoExtensionContext
dataServicesStoreConfigurationContext
soporte de PWA
Live Search funciona con PWA Studio, pero los usuarios pueden ver pequeñas diferencias en comparación con otras implementaciones de Commerce. La funcionalidad básica, como la página de búsqueda y la lista de productos, funciona en Venia, pero es posible que algunas permutaciones de Graphql no funcionen correctamente. También puede haber diferencias de rendimiento.
- La implementación PWA actual de Live Search requiere más tiempo de procesamiento para devolver resultados de búsqueda que Live Search con la tienda nativa de Commerce.
- Live Search el PWA in no admite gestión de eventos. Como resultado, los informes de búsqueda y la comercialización inteligente funcionarán.
- Filtrado directamente en
description
,name
,short_description
no es compatible con GraphQL cuando se utiliza con PWA, pero se devuelven con un filtro más general.
Para usar Live Search con PWA Studio, los integradores también deben:
-
Instalar livessearch-storefront-utils.
-
Configure las variables
environmentId
en elstoreDetails
objeto.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 recopila datos de interacción del usuario como parte de su funcionalidad base y se utilizan cookies para almacenar estos datos. Al recopilar cualquier información de usuario, el usuario debe aceptar almacenar cookies. Live Search y Product Recommendations compartir el flujo de datos y, por lo tanto, el mismo mecanismo de cookies. Obtenga más información al respecto en Controlar restricciones de cookies.