概览

KlaviyoObjC 是一个 SDK，用于 Objective C 编写，以便用户将 Klaviyo 的事件跟踪功能集成到 iOS 应用中。我们还提供 Swift 编写的 SDK。这两个 SDK 在功能上完全相同。

要求

iOS >= 8.0

安装选项

1. Cocoaapods (推荐)
2. 下载空白、预配置的项目，然后从头开始。

KlaviyoObjC 通过CocoaPods 提供。要安装它，只需将以下行添加到您的 Podfile 中

pod "KlaviyoObjC"

用法示例：事件跟踪

要运行示例项目，请克隆仓库，然后首先在 Example 目录中运行 pod install。确保使用 Klaviyo SDK 的任何 .m 文件都包含导入调用。

#import "KlaviyoObjC/Klaviyo.h"

要添加 Klaviyo 的跟踪功能，只需几行代码即可。首先，在您的应用程序代理文件（在 application:didFinishLaunchingWithOptions 下）中，添加以下行以设置 Klaviyo

[Klaviyo setupWithPublicAPIKey:@"YOUR_PUBLIC_API_KEY"]

以下代码示例展示了如何在您的应用程序中实现事件或用户跟踪。

    NSMutableDictionary *customerProperties = [NSMutableDictionary new];
    customerProperties[@"$firstName"] = @"John";
    customerProperties[@"$lastName"] = @"Smith";
    [[Klaviyo sharedInstance] trackPersonWithInfo: customerProperties];
    [[Klaviyo sharedInstance] trackEvent:@"Logged In"];

参数说明

可以带有 1-4 个参数的 track 函数

eventName 您想要跟踪的事件的名称。可以是要字符串。至少必须提供这个参数来跟踪事件。

customer_properties（可选，但推荐） 这是属于执行您正在记录的操作的人的属性的 NSMutableDictionary。如果您不包含 $email 或 $id 键，则用户将通过 $anonymous 键进行跟踪。

properties（可选） 这是特定于事件的属性的 NSMutableDictionary。在上面的示例中，我们包括了购买的商品和总价。

eventDate（可选） 这是事件发生的时间戳（一个 NSDate）。只有当您正在跟踪过去的事件时才需要包括此参数。如果您正在跟踪实时活动，则可以忽略此参数。

请注意，trackPersonWithInfo 只接受表示客户属性的字典作为参数。这与可以接受多个参数的 trackEvent 不同。

特殊属性

如上例所示，可以使用特殊的人物和事件属性。这与Klaviyo 分析API类似。这些是用于识别用户或事件的特殊属性。它们是

KLPersonEmailDictKey 
KLPersonFirstNameDictKey
KLPersonLastNameDictKey
KLPersonPhoneNumberDictKey
KLPersonTitleDictKey
KLPersonOrganizationDictKey
KLPersonCityDictKey
KLPersonRegionDictKey
KLPersonCountryDictKey
KLPersonZipDictKey
KLEventIDDictKey
KLEventValueDictKey

最后，如果您只想用trackEvent中的eventName参数调用，而不希望它导致匿名用户跟踪，您可以使用setUpUserEmail来配置您的用户电子邮件地址。通过一次性调用这个命令，通常在应用程序登录时，Klaviyo可以跟踪所有随后的事件，将它们与给定的用户相关联。但是，您也可以在任何时候通过传递客户属性字典来覆盖此功能。

[[Klaviyo sharedInstance] setUpUserEmail:@"[email protected]"]; 

作者

Katy Keuper，[email protected]

许可协议

KlaviyoObjC遵循MIT许可协议。有关更多信息，请参阅LICENSE文件。