DataPhantom-iOS-SDK

安装

将DataPhantom iOS SDK（代号：hcube）添加到您的项目非常简单。选择您最舒适的方法，并按照以下说明操作。

使用Carthage

1. 将以下行添加到您的Cartfile

git "[email protected]:michald/hcube-client-ios.git"

1. 在您的项目目录中运行carthage update。
2. 将HCube.framework从Carthage/Build/中的相应平台目录拖到Xcode项目的“通用”设置的“链接框架和库”部分。
3. 添加#import <HCube/HCube.h>

使用CocoaPods

将HCube-iOS-SDK集成到您的iOS项目中最简单的方法是使用CocoaPods。

1. 将以下行添加到您的Podfile pod "HCube-iOS-SDK"
2. 在您的项目目录中运行pod update
3. 添加#import <HCube-iOS-SDK/HCube.h>

入门

要开始，将HCube.h头文件导入到您的项目pch文件中。这将允许全局包含所有必需的头文件。

如果您正在使用CocoaPods或Carthage，则您的导入应如下所示

// Objective-
#import <HCube-iOS-SDK/HCube.h>

否则，如果您已将MagicalRecord的源文件直接添加到您的Objective-C项目中，则您的导入应为

#import "HCube-iOS-SDK/HCube.h"

接下来，在您的应用程序代理中，在- applicationDidFinishLaunching: withOptions:方法中，您应使用HCube的类方法提供token。

+ (HCube *)provideWithToken:(NSString *)token;

要获取应用程序的token，您应注册您的账户。Token将在左侧菜单的“帐户设置”中可用。然后请将您的token放入函数provideWithToken:中。

[HCube provideWithToken:"1fbm9s3hqevsacvrdbh0i5e63m"];

方法provideWithToken:创建全局HCube.sharedInstance，然后您可以在代码的任何地方使用它来创建额外的属性或跟踪事件等。

+ (HCube *)sharedInstance;

跟踪

用于从您的应用程序收集各种事件的主要事件收集方法。

库初始化后，您可以通过跟踪事件来发送数据。

要具有所有附加的常见属性来跟踪事件，您可以使用-trackEvent:

HCube *hcube = [HCube sharedInstance];
[hcube trackEvent:@"Personal info"];

否则，如果需要与事件一起发送一些额外的属性，则可以调用-trackEvent:properties:以事件名称和属性来跟踪事件。

HCube *hcube = [HCube sharedInstance];
[hcube trackEvent:@"Personal info"
       properties:@{@"FirstName": @"John"}];

标识

允许您唯一地标识用户。

默认情况下，DataPhantom为每个用户生成一个ID。它是一个随机的、唯一的字符串，例如："d1c221f2-5a37-4ec4-a1bc-6e0bded47c7c"；我们将这个ID存储在本地存储中。

通过我们的sdks发送的所有事件都将包含这个unique_id属性。但在某些情况下，您可能希望识别您的访客（比如说他们登录到您的应用程序，或者在匿名交互后再决定注册），您可以使用该方法并为此unique_id分配一个值，该值可以在您的应用程序中使用。

[hcube identify:@"12345-67890-12345-67890"];

合格

允许您使用属性来合格用户，这些属性可以随后与用户执行的事件/操作相关联。

在注册时，例如，如果已经提交了可用于注册用户的许多用户属性，可以使用hcube.qualify方法设置这些属性。

这些值只需要每个用户发送一次（假设您没有像信用这样的属性，这些属性会随着时间的推移而变化），并且它们将自动归因给用户发生的每个事件。

!!! 注意，“实时归因”很重要，因为它可以让我们准确捕捉事件的上下文。

比如说，有一个名为credit的用户属性，如下所示：credit: 100，它的值随着有人在游戏中玩了更多关卡而减少。信用多的用户的行为可能与信用少的用户不同。

// 1) Identify your user.
[hcube identify:@"12345-67890-12345-67890"];

// 3)
[hcube.qualify setProperties:@{@"FirstName": @"John"}];

公共属性

有时，许多事件可能共享一些属性（例如，用户通过向导流程，表单向导的属性）。

获取

您可以使用-getCommonProperties:方法获取所有属性。

[hcube getCommonProperties];

设置

如果您想存储公共属性，请调用-addCommonProperties:或-addCommonPropertiesOnce:

[hcube addCommonProperties:@{@"FirstName": @"John"}];

如果您想一次性设置公共属性（而不重写），应使用-addCommonPropertiesOnce:方法。

[hcube addCommonPropertiesOnce:@{@"FirstName": @"John"}];

删除

您可以通过名称删除属性。

[hcube removeCommonPropertyByName:@"FirstName"];

更新

如果您想按名称更新属性的值，应使用removeCommonPropertyByName:，然后使用addCommonProperties:或addCommonPropertiesOnce:。

清除

要删除所有属性，请调用-clearAllCommonProperties

[hcube clearAllCommonProperties];

日志记录

HCube-iOS-SDK有其自己的记录器。可以通过更改该属性来配置日志记录。

@interface HCube : NSObject
@property (class, getter=isLoggingEnabled) BOOL enableLogging;
@end

注销

当用户从您的应用程序注销或登出时，您应该从HCube中删除所有属性。

许可证

DataPhantom-iOS-SDK在MIT许可证下提供。有关更多信息，请参阅LICENSE文件。