Webtrends SDK 是一个针对 iOS 的分析库。本指南将带您了解初始化过程,从将 SDK 集成到您的项目,到向 Webtrends 发送事件。
### 发行说明 Webtrends iOS SDK 3.2.4 现在支持将测试或目标传递到应用用户打开应用后看到的第一屏。此外,SDK 还添加了加载进度指示器。您现在可以配置进度指示器的超时值。对于想要更多手动控制 SDK 中缓存的 Optimize 测试数据的用户,提供了手动清除数据缓存和设置缓存刷新值的功能。最后,SDK 中添加了部分测试内容渲染。您现在可以跟踪哪些测试部分被查看,并使用这些数据生成 Infinity 报告。更多详细信息请参考 帮助 页面,了解发送的参数及其包含的值。
有关更多信息,请参阅 Webtrends Optimize 页面。有关在您的 iOS 应用程序中实施 Optimize 的详细信息,请参阅 我们的帮助文档。
# 安装 CocoaPods 是 Swift 和 Objective-C Cocoa 项目的依赖管理器。它自动化和简化的将库如 Webtrends SDK 集成到项目中的过程。
Webtrends SDK 使用 CocoaPods 来管理项目集成。它分为两个子 Pod,一个用于 iOS 设备,一个用于 WatchKit 扩展。您可以根据需要单独安装 iOS 库或两个库。
## 步骤 1 – 安装 CocoaPods 如果您从未使用过 CocoaPods,您首先需要安装它。它以 ruby gem 的形式分发,可以从终端按照如下方式进行安装
$ sudo gem install cocoapods
## 步骤 2 – 创建 Podfile Cocoapods 使用一个名为 Podfile
的文件来管理与项目相关的第三方代码。在您的项目基础目录中,请在终端运行以下命令
$ touch Podfile
$ open -a Xcode Podfile
现在,已经创建并打开了 Podfile
,我们将添加我们需要安装的信息。首先,告诉 Podfile SDK 来源于哪里。这一步骤并非绝对必要,但可以确保您接收来自 Webtrends 的验证过的生产代码。请将以下行添加到您的 Podfile
source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/Webtrends/ios-sdk.git'
接下来,通过包含以下适当的代码段选择您应用程序需要的组件
### 我只需要分析 SDK,不需要 Optimize 或 Apple Watch 支持
target 'MyApp' do
pod 'Webtrends-SDK/Core', '~> 3.0'
end
### 我需要分析功能,包括对 Apple Watch 的支持 假设您的 iOS 主应用程序目标名为 MyApp
,而您的 Apple Watch 应用程序目标名为 MyApp Watchkit Extension
...
# You can find the exact names of your targets by running:
#
# xcodebuild -list
#
# from your project's root directory
target 'MyApp' do
pod 'Webtrends-SDK/Core', '~> 3.0'
end
target 'MyApp WatchKit Extension' do
pod 'Webtrends-SDK/Watch', '~> 3.0'
end
### 我只需优化,不需要 Apple Watch 支持 分析(核心)是优化的依赖项。您必须安装核心和优化 Pod。
pod 'Webtrends-SDK/Core', '~>3.0'
pod 'Webtrends-SDK/Optimize', '~>3.0'
### 我需要分析和优化,包括对 Apple Watch 的支持 此配置将安装整个 Webtrends SDK。假设您的 iOS 主应用程序目标名为 MyApp
,而您的 Apple Watch 应用程序目标名为 MyApp Watchkit Extension
...
# You can find the exact names of your targets by running:
#
# xcodebuild -list
#
# from your project's root directory
target 'MyApp' do
pod 'Webtrends-SDK/Core', '~> 3.0'
pod 'Webtrends-SDK/Optimize', '~>3.0'
end
target 'MyApp WatchKit Extension' do
pod 'Webtrends-SDK/Watch', '~> 3.0'
end
## 第 3 步 – 安装 保存 Podfile
后,您可以使用以下命令从项目根目录实际安装 Pods
$ pod install
此过程将在您的根目录中创建一个新的文件,名为 [Project Name].xcworkspace
。从此刻开始,打开项目时使用此文件,而不是之前使用的 .xcodeproj
## 第 4 步 – 设置 webtrends.plist
您可以从这里下载 webtrends.plist
的示例副本 在此处。将文件添加到您的项目中,打开它,并根据您的项目需求进行编辑。
#### 需要的条目 对于分析(tm):
对于优化(tm)
在 webtrends.plist
中有许多配置选项。您可以在 Analytics 高级配置指南 或 Optimize 高级配置指南 中了解更多信息。
## 扩展 Swift 设置
一旦设置了 Webtrends Pod,您需要将 SDK 导入到您的 Swift 基于应用程序的桥接头文件中,以将库集成到您的应用程序中。如果您以前从未使用过桥接头,可以按照 Apple 的 使用 Swift 与 Cocoa 和 Objective-C 指南中的说明手动创建一个。
简而言之,您需要在应用程序项目中创建桥接头,告诉编译器它的位置,并更新搜索路径以在 SDK 中查找头文件。
在您的桥接头中,只需添加以下行即可使整个核心 Webtrends SDK 对您的 Swift 应用程序可用
@import Foundation;
#import "WebtrendsSDK.h"
要实际使用此头文件,我们需要告诉 Swift 编译器其位置,因此打开项目设置并找到 Swift Compiler — Code Generation 部分。更改项目级别的 Objective-C 桥接头设置,并将值更改为指向我们的新头文件(例如,对于名为 'YourApp’ 的项目,更为 'YourApp/Bridging-Header.h')。
最后,告诉编译器在桥接头中可以找到哪些头文件。找到名为 Search Paths 的部分,更改项目级别的 User Header Search Paths 设置,添加对 Pods 目录的递归条目。条目将类似于 Pods/**。
关于为 WatchKit 应用配置桥接头,您可以在Webtrends WatchKit SDK 指南中找到更多信息。
##第 5 步 - 开始记录事件 当您的 webtrends.plist
文件正确设置后,您就可以开始记录事件了。在默认配置下,Webtrends SDK 将自动为您记录大量有用的事件(更多详情请参见自动事件指南)。要手动记录您的事件,请使用在文档中记录的任何 triggerEvent
方法。有关更多信息,请参阅手动事件记录指南。
##示例应用 我们开发了一系列示例应用,展示了如何配置应用程序以使用 Webtrends iOS SDK,并提供了相应的文档。您可以直接从我们的公共示例应用 Github 仓库中克隆或下载这些应用。该仓库包含 Objective-C 和 Swift 的示例应用,并展示了实现的所有主要方面。要开始,请参阅我们的示例应用指南。
##全部文档 Webtrends iOS SDK 的完整文档可在http://help.webtrends.com/en/ios/找到。