JavaScript API 和服务器端 API

JavaScript API

以下指南将引导您完成设置和使用 JavaScript API。如果您计划进行完整的电子商务集成，请参阅本指南。

注意

要使用下面提供的 Klaviyo 代码片段，您需要使用 您的公共 API 密钥，可以在此处找到 更新 API\_KEY 的占位符。

添加 Klaviyo 片段

要开始跟踪人员，请将以下代码段添加到您网站主模板的右侧，以便它会自动添加到您网站上的每个页面。如果您有开发人员将此脚本添加到您的网站，您可以向他们发送本指南的链接。 ““

**您需要对代码片段进行一处更改**。如果您是电子商务企业，请删除带有“识别”调用的四行。如果您是人们登录的网站或网络应用，请将“{{ email }}”占位符电子邮件替换为包含登录用户电子邮件地址的相应模板变量。我们建议将 Klaviyo 代码放在网站模板的底部或底部附近。如果您使用 Google Analytics 或其他第三方服务，您可以将 Klaviyo 代码直接放在其上方或下方。您可能想知道“使用 Klaviyo 如何影响我网站的性能？”答案是 Klaviyo 根本不会影响您网站的性能。我们的代码仅在您网站的其余部分完成加载后加载。此外，Klaviyo 告诉浏览器缓存我们的 JavaScript，这样您的访问者通常甚至不需要在每次切换页面时下载我们的 JavaScript。

### 检查你的脚本

将 JavaScript 添加到网站后，您可以通过在右侧输入网站的 URL 来检查其设置是否正确。一旦脚本出现在您的网站上，Klaviyo 将开始实时跟踪您网站上的访问和会话。

### API 基础知识

要调用 Klaviyo API 并存储有关人员的信息，您将使用 Klaviyo 脚本自动添加的“_learnq”对象。为了进行 API 调用，Klaviyo 使用一种特殊的语法，即使我们的脚本尚未加载到页面上，您的 API 调用也可以正常工作。您将创建一个数组，其中第一个值是要调用的方法的名称，任何后续值都是要传递给该方法的参数。

### 识别人员

**identify** 方法允许您识别并设置个人的属性。此方法接受属性的字典或散列。当您识别某人时，您必须使用 $email 键包含他们的电子邮件地址，或者使用 $id 键包含唯一标识符，例如他们的用户 ID。一旦您至少包含其中一个标识符，您就可以随意添加所需的任何自定义属性。自定义属性对于跟踪有关个人的事实非常有用。在 Klaviyo 中，您可以根据这些属性创建人员细分。例如，您可能想要跟踪个人的计划类型或注册日期。 Klaviyo 还将了解您使用的不同数据类型，因此请随意使用数字、布尔值和日期。 Klaviyo 有一些特殊的属性，用于显示有关人员的信息。它们是：$first\_name、$last\_name、$phone\_number、$title 和 $organization。除了您跟踪的属性之外，Klaviyo 还会自动确定每个人首先从哪个网站进行归因跟踪，并根据他们访问您网站的位置来确定他们的位置。 **示例代码：**

### 跟踪事件和操作

**跟踪**方法允许您记录人们在您的网站上执行的事件和操作。此方法接受一个字符串，它是您为该事件指定的名称。此方法还接受与该事件关联的可选属性字典或散列。例如，您可以跟踪某人购买商品的时间，并包含有关购买价格以及他们购买的商品的信息。如果您有一个应用程序，其中人们有个人资料，您可以在某人填写个人资料时进行跟踪。如果您计划进行完整的电子商务集成，请参阅本指南。 Klaviyo 的事件跟踪和分析非常灵活，因此您可以对其进行自定义以跟踪对您的业务重要的事情。我们的跟踪方法还可以理解不同的数据类型，因此您可以使用数字、布尔值和日期，我们将根据您发送的数据创建智能图表和图形。 **示例代码：**

## 服务器端 API