bloomreach / bloomreach-connector-magento
Bloomreach 连接器,用于自动完成、集合和产品搜索
Requires
- php: ~7.4.0||~8.0.0||~8.1.0||~8.2.0||~8.3.0
README
连接器模块提供连接到 Bloomreach 搜索商品以及其他 API 和像素集成的选项。
安装 Magento
- 确保您已安装 Docker 并保持最新状态
- 访问 https://marketplace.magento.com 并创建账户或登录该门户
- 导航至
https://marketplace.magento.com/customer/accessKeys/
- 准备一个密钥以供使用(如果需要,请创建一个新的密钥。密钥名称不重要)
然后运行
npm i npm run magento-install
-
您将被提示输入用户名和密码:用户名 = 从 marketplace.magento.com 获取的公钥 密码 = 从 marketplace.magento.com 获取的私钥
-
稍后您将被要求输入系统密码。
完成所有步骤后,服务器应已运行。
故障排除
有关通过 Docker 设置 Magento 的所有视频讨论如下:https://courses.m.academy/courses/set-up-magento-2-development-environment-docker/lectures/9064350
- 许多问题可以通过重新安装来解决
npm run magento-uninstall npm run magento-install
- 如果您有 chmod 失败,则可能是您的 Adobe 密钥输入不正确。请记住不要使用您的账户用户名/密码,而是使用公钥和私钥作为用户名/密码。
- 凭证失败后,它们将缓存在您的本地机器上。您可以在以下位置找到凭证:
~/.composer/auth.json
。修改那里的值以使其正确,以便安装脚本能够正常工作。
- 凭证失败后,它们将缓存在您的本地机器上。您可以在以下位置找到凭证:
- 如果您的演示数据未加载:尝试运行
# Note, the . at the beginning makes it easier to cd into the folder first or # bash will interpret the . as an execute command instead of the path. cd .magento bin/magento sampledata:deploy
或重新安装
开发
安装 Magento 后,您可以通过以下方式开始开发
# Ensure docker desktop is running
npm run dev
当您看到消息时,进程将完成
开发服务器已启动。
这将启动您的 Magento 实例并在本地机器上使 https://magento.test
可用。这还将自动将更改分发到您的 Magento 服务器,以便在本地环境中查看。
大多数更改将自动显示,但某些更改可能需要以下 Magento 命令
cd .magento # Run when you change any dependency injected parameters in your classes bin/magento setup:di:compile # Run when all else fails bin/magento setup:upgrade # Run when you think something should be there but isn't loading in the browser bin/magento cache:flush
开发完成后,如果退出开发脚本不成功,您可以通过以下方式确保停止 Magento 服务器和资源
bin/stop
注意:您可以使用相反的方法运行服务器而无需任何特殊的 npm 命令
bin/start
首先配置应用程序
要集成此扩展的任何选项,您需要填写应用程序配置设置。为此,您可以按照以下步骤触发索引。
- 步骤 1:登录管理员界面,如果尚未登录
- 步骤 2:转到商店->配置
- 步骤 3:找到“Bloomreach”部分
- 步骤 4:在 Bloomreach 部分下点击“设置”标签
- 步骤 5:填写所有选项:您可以从 Bloomreach 账户获取这些设置值。
- 账户 ID
- 域名密钥:
这可能因您的每个商店视图而异,如果您在 Magento 中启用了多个区域设置并且也在 Bloomreach 中配置了多个区域设置。
- 认证密钥
- 跟踪 Cookie
- 搜索端点:使用此高亮显示的内容,并用域名替换
<your_domain_name>
http://<your_domain_name>/catalogsearch/result/
- 自动完成端点:使用此高亮显示的内容,并用域名替换
<your_domain_name>
http://<your_domain_name>/search/ajax/suggest/
触发索引
当您在Bloomreach中对目录进行了任何更改,那么您可能需要重新索引这些更改以反映在您的网站上。为此,您可以按照以下步骤触发索引。
- 步骤 1:登录管理员界面,如果尚未登录
- 步骤 2:转到商店->配置
- 步骤 3:找到“Bloomreach”部分
- 步骤4:在Bloomreach部分下点击“索引”选项卡
- 步骤5:现在点击名为“触发索引”的按钮
搜索模块选项
自动完成
启用客户使用快速、安全的方式来搜索产品,并获得无缝体验。要启用它,您可以从管理员面板进行配置。
- 步骤 1:登录管理员界面,如果尚未登录
- 步骤 2:转到商店->配置
- 步骤 3:找到“Bloomreach”部分
- 步骤4:在Bloomreach部分下点击“搜索”选项卡
- 步骤5:在这里,您可以通过将“启用自动完成”设置为“是”来配置自动完成
- 步骤6:现在输入或交叉验证您的前端快速搜索输入选择器(id/css路径)
- 步骤7:在这里,您可以选择默认显示在快速搜索结果弹出窗口中的术语、产品和类别的数量。
- 步骤8:保存配置并清理/刷新缓存。
网站搜索
用更高效、更快的搜索结果替换现有的搜索结果页面。您可以按照上述“自动完成”中的步骤进行配置,这两个配置组都在同一页面上。
-
步骤9:您可以在自动完成的同一页面上配置网站搜索,即网站搜索结果页面,以Bloomreach搜索页面进行快速、高效的搜索。
-
步骤10:通过将“启用网站搜索”设置为“是”来启用网站搜索
-
步骤11:除非您确切知道要做什么,否则不要更改“CSS选择器”值
-
步骤12:配置其他选项,如:显示产品数量、显示变体、显示分层导航等。
-
步骤13:保存配置并清除/刷新缓存。
类别
用Bloomreach产品列表页面替换现有的产品列表页面/类别查看页面。
它的工作方式与网站搜索类似,具有与网站搜索相同的选项。导航到Bloomreach部分的“类别”选项卡
-
步骤1:通过将“启用类别”设置为“是”来启用类别
-
步骤2:除非您确切知道要做什么,否则不要更改“CSS选择器”值
-
步骤3:配置其他选项,如:显示产品数量、显示变体、显示分层导航等。
-
步骤4:保存配置并清除/刷新缓存。
像素
您只需在像素选项卡下将“是”设置为即可启用Bloomreach像素。像素收集客户的行为数据,例如他们在网站上查看的内容(类别、产品)、添加到购物车的商品以及转换(订单)。
###像素主要收集以下事件的数据,当您
- 访问主页或任何CMS页面
- 访问类别页面
- 访问产品页面
- 搜索任何内容并进入搜索结果页面
- 添加任何产品到购物车
- 快速查看任何产品(默认未集成,可以手动完成。见下文)
- 下单后进入订单成功页面
###Bloomreach收集的数据
- 页面URL
- 用户ID(已登录客户的唯一ID加密散列)
- 产品ID
- 产品SKU
- 产品名称
- 订单总价
- 订单项目信息(SKU、订单数量、名称、单价)
- 事件类型
作为管理员,这些数据非常有用,可以为您提供客户需求的洞察,您可以使用这些洞察向客户提供更多相关信息和产品,并将用于个性化推荐小部件。(将在下一节中介绍)
此外,已经为添加到购物车事件集成了像素,您可以在以下路径的模板中找到它:Bloomreach/Connector/view/frontend/templates/product/,这里有2个文件
- list.phtml
- view/addtocart.phtml
查看为添加到购物车事件添加的代码,看起来像这样
<button type="submit"
data-blm-add-to-cart
data-blm-add-to-cart-sku="<?= $block->escapeHtml($_product->getSku()) ?>"
data-blm-add-to-cart-prod-id="<?= /* @noEscape */ $_product->getId() ?>"
data-blm-add-to-cart-prod-name="<?= $block->escapeHtml($_product->getName()) ?>"
title="<?= $block->escapeHtmlAttr($buttonTitle) ?>"
class="action primary tocart"
id="product-addtocart-button">
<span><?= $block->escapeHtml($buttonTitle) ?></span>
</button>
正如您可能知道,在Magento中默认没有快速查看功能,因此未添加。虽然如果您已集成任何第三方快速查看扩展,则可以添加快速查看按钮事件。要集成快速查看事件,您可以覆盖第三方列表文件或添加快速查看按钮的任何文件。然后,请将以下属性添加到该快速查看按钮/锚点。
data-blm-quickview
data-blm-quickview-sku="Chair123"
data-blm-quickview-prod-id="60765"
data-blm-quickview-prod-name="Weathered Gray Wood Jozy Dining Chairs Set of 2"
注意:将sku、产品ID和产品名称替换为产品对象的相应getter。
可能看起来像这样,类似的东西
<button type="button"
data-blm-quickview
data-blm-quickview-sku="<?= $block->escapeHtml($_product->getSku()) ?>"
data-blm-quickview-prod-id="<?= /* @noEscape */ $_product->getId() ?>"
data-blm-quickview-prod-name="<?= $block->escapeHtml($_product->getName()) ?>"
title="<?= $block->escapeHtmlAttr($buttonTitle) ?>"
class="action quick-view">
###注意:您可以在Chrome中安装Bloomreach像素验证器以验证这些事件
推荐小部件
允许管理员将小部件添加到任何CMS页面、块或页面的任何部分。它有各种选项
-
类别
-
关键词
-
个性化
-
针对特定项目等,在插入此小部件时可以选中。
-
步骤1:要启用小部件,您可以导航到位于Bloomreach部分下的推荐标签
-
步骤2:将启用推荐小部件设置为是
-
步骤3:保存配置并清除/刷新缓存。
-
步骤4:在任意CMS页面或块中插入小部件,并查看前端效果。
注意:请确保您已经在Bloomreach主控制台中创建了这些小部件规则,您将在那里获得小部件ID,这是在Magento中加载任何小部件所需的。在Bloomreach主控制台中,每种小部件类型都将有不同的小部件ID。