Einstein Recommendations

Einstein Recommendations API 有两个主要功能:接收活动和输出推荐。通过使用 Zone 组件,我们的客户还可以在不更改任何代码的情况下灵活地切换 Recommender。

此 API 文档主要面向 Salesforce Commerce Cloud 客户。

要启用对 Einstein Recommendations API 的访问,请转至 Einstein Configurator,然后在 API 页面中输入您的 Commerce Cloud Account Manager 客户端 ID。使用站点管理员访问权限,您可以在 Account Manager 页面创建必要的客户 ID。有关更多信息,请参阅添加 API 客户端 ID

启用后,只要传递了正确的客户端 ID,API 就可以在所有环境中运行,包括生产环境 (Production) 、准备环境 (Staging)、开发环境 (Development) 和 Sandbox 实例。

每个 API 调用都必须传递用于 API 密钥身份验证的 x-cq-client-id 标头。

在客户端或服务器端实现我们的 API 需要进行一些权衡。为确保您对客户端 ID 保密,我们建议您在服务器端实施我们的 API 以提高安全性。客户端实施存在将您的客户端 ID 暴露给不良行为者的风险。

如果在服务器端实现,获取推荐的请求以及某些用户活动(如 viewProduct、viewReco 和 clickReco)需要考虑缓存。例如,在用户查看缓存产品页面的情况下,仍应发送 viewProduct 活动。重要的是 Einstein 接收所有事件,并且不缓存推荐。

此 Einstein Recommendations API 不是为电子邮件推荐用例而设计的。它不支持在电子邮件中嵌入 Einstein Recommendations。

我们的服务是全球分布,可横向扩展,并且可以根据流量自动扩展和缩减,因此无需进行负载测试。我们建议您避免任何负载测试,因为它会影响推荐结果。

为了帮助为每个购物者生成相关的产品推荐,Einstein Recommendations API 提供用于购物者识别的参数。

为避免潜在的恶意活动,用户标识符参数必须是非连续的。参数不应包括序列、模式、IP 地址、电子邮件地址、姓名或与特定人员相关的任何内容。所有用户标识符参数必须通过散列或其他方法遵守《通用数据保护条例》(GDPR)。

  • cookieId(必需)- 匿名购物者的唯一标识符。通常,cookieId 是第一方 cookie 的值。
    • 从传统 Commerce Cloud 网店发出 API 请求时,传递 cqcid cookie 值以匹配传统网店上的自动活动跟踪。有关详细信息,请参阅基于浏览器的本地数据存储
    • 使用 Salesforce Commerce API 时,传递可用的 USID 值作为令牌检索过程的一部分。有关更多信息,请参阅 Shopper Login and API Access Service 文档。
    • 使用 OCAPI 时,使用访客登录响应中的 visit_id 值来匹配自动活动。有关详细信息,请参阅 OCAPI 客户文档
  • userId(鼓励)- 登录购物者的唯一标识符。此参数使 Einstein 能够跨多个设备链接相同的登录用户。
    • 从传统 Commerce Cloud 网店发出 API 请求时,传递 cquid cookie 值以匹配传统网店上的自动活动跟踪。有关详细信息,请参阅基于浏览器的本地数据存储
    • 使用 Salesforce Commerce API 时,使用注册登录响应中的 hashed_login 值来匹配自动活动。有关更多信息,请参阅 Shopper Login and API Access Service 文档。
    • 使用 OCAPI 时,使用注册登录响应中的 hashed_login 值来匹配自动活动。有关详细信息,请参阅 OCAPI 客户文档

通过 Einstein API 使用的 Recommender 的标准绩效报告与您的数字网站上使用的其他 Recommender 的标准绩效报告相同。您可以在 Einstein Reports and Dashboard 上查看报告(请参阅本文档以了解有关 Einstein Reports and Dashboard 的更多信息)。

为了使单独的报告和故障排除更容易,我们建议您为 Einstein API 创建单独的 Recommender。例如,将 Recommender 命名为“pdp-mobile-API”表示该 Recommender 用于移动应用程序的产品详细信息页面。

报告指标基于活动。如果使用 Einstein Recommendations API 的应用程序无法发送活动,则 API Recommender 的所有指标都显示为零 (0)。

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.