Lytics iOS SDK
安装
您可以通过将其作为包依赖项添加到 Xcode 项目中来将 Lytics SDK 添加到项目中。
- 从 文件 菜单中选择 添加包...
- 在包存储库 URL 文本字段中输入
https://github.com/lytics/ios-sdk
并单击 添加包 - 将 Lytics 包产品添加到您的应用程序目标中
用法
配置
在使用 Lytics SDK 之前,您必须使用您的 API 令牌 初始化 SDK。如果您使用 AppDelegate
,则建议在 AppDelegate.application(_:didFinishLaunchingWithOptions:)
中执行此操作。
import Lytics
import UIKit
class AppDelegate: NSObject, UIApplicationDelegate {
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
Lytics.shared.start(apiToken: "YOUR-VALID-LYTICS-API-TOKEN") { configuration in
...
}
return true
}
}
如果您正在使用 SwiftUI,您可以在 App
初始化器中初始化 SDK。
import Lytics
import SwiftUI
@main
struct MyApp: App {
init() {
Lytics.shared.start(apiToken: "YOUR-VALID-LYTICS-API-TOKEN") { configuration in
...
}
}
var body: some Scene {
...
}
}
发送数据
Lytics 事件方法是一般化的,允许您定义自己的 Codable
类型,并以完全的类型安全性与 SDK 一起使用。
struct MyIdentifier: Codable {
var userID: String
var email: String?
}
struct MyConsent: Codable {
var document: String
var consented: Bool
}
struct MyProperties: Codable {
var eventID: Int
var artist: Artist
}
身份事件
跟踪身份事件提供了一个界面,用于更新设备上存储的当前用户的属性以及向下游集合 API 发射身份事件。
Lytics.shared.identify(
name: "login",
identifiers: MyIdentifier(
userID: "this-users-known-id",
email: "[email protected]"))
同意事件
同意事件提供了一个界面,用于配置和发射表示应用程序用户明确同意的特殊事件。此事件执行任何正常事件所做的所有操作,并为开发者的选择提供特殊的有效负载来提供同意详情。
Lytics.shared.consent(
name: "ios consent",
consent: MyConsent(
document: "termsAndConditions",
consented: true))
跟踪自定义事件
跟踪自定义事件提供了一个界面,用于在客户的应用程序中配置和发射自定义事件(例如,进行了购买或登录)。
Lytics.shared.track(
name: "Buy Tickets",
properties: MyProperties(
eventID: event.id,
artist: event.artist))
屏幕事件
屏幕事件提供了一个界面,用于配置和发射表示屏幕或页面视图的特殊事件。应将其视为 track 方法的扩展。
Lytics.shared.screen(name: "Dashboard")
广告 ID
在收集 IDFA 之前,您必须首先将 NSUserTrackingUsageDescription
添加到您的应用程序的 Info.plist
。然后,您可以调用 Lytics.shared.requestTrackingAuthorization()
来让 iOS 请求访问 IDFA 的权限。请注意,如果用户在系统隐私设置中关闭了“允许应用程序请求跟踪”,则不会显示警报,并且授权可以在任何时候撤销。