关于项目
Piano Analytics Apple SDK 允许您收集 Piano Analytics 解决方案的受众测量数据。它可与 iOS、watchOS、tvOS 及 iOS 扩展应用一起使用。
此 SDK 使实施 Piano Analytics 尽可能简单,同时保持解决方案的所有灵活性。通过在您的应用程序中使用此小型库并使用 专用且已记录的方法,您将能够发送强大的事件。
它还包括 隐私标签方法,允许您根据您参照的法规对标签进行完美管理。
入门
- 在您的项目中安装我们的库(见下文),您有几个选择
- 使用 NPM
- 使用我们的 CDN(仅限浏览器)
- 克隆 GitHub 项目以构建您将托管的应用程序文件(仅限浏览器)
- 如果您想在构建的文件中配置您的库而无需附加标签(例如:在构建的文件中配置您的网站和收集域名),则可以使用此方法。但是,如果您使用构建工具(webpack 等),我们建议使用 NPM 方法。
- 查看 文档 以获取功能概述和代码示例
使用 Cocoapods
如果您是 Cocoapods 的初学者,请参阅 CocoaPods 文档
-
使用相应的行更新您的 Podfile
# iOS Application pod "PianoAnalytics/iOS", ">=3.0" # tvOS Application pod "PianoAnalytics/tvOS", ">=3.0" # watchOS Application pod "PianoAnalytics/watchOS", ">=3.0" # iOS Application pod "PianoAnalytics/appExtension", ">=3.0"
为了避免由 CocoaPods 引起的冲突,可以使用独立的 pod
target 'MyProject' do pod "PianoAnalytics-AppExtension", ">=3.0" use_frameworks! end
如果您没有其他 pod,则您的 Podfile 应该类似于以下内容
target 'MyProject' do pod "PianoAnalytics/iOS", ">=3.0" use_frameworks! end
-
保存您的 Podfile
-
运行
pod install
(返回顶部)
使用 Swift 包管理器
-
在您的应用程序中点击文件 > 添加包...
-
在右上角的搜索框中粘贴公共存储库的 URL
https://github.com/at-internet/piano-analytics-apple
-
选择 piano-analytics-apple 包
-
单击“添加包”
(返回顶部)
使用 Carthage
-
使用以下行更新 Cartfile
github "at-internet/piano-analytics-apple" ~> 3.0
-
保存您的 Cartfile
-
使用相应平台运行
carthage update --platform iOS
(如果失败,您可能需要使用--use-xcframeworks
选项) -
从 Build/PianoAnalytics.xcframework 中添加依赖项到“框架,库和嵌入式内容”
(返回顶部)
使用
-
在应用程序初始化时配置您的网站和收集域名
import PianoAnalytics ... pa.setConfiguration(ConfigurationBuilder() .withCollectDomain("log.xiti.com") .withSite(123456789) .build() )
-
发送事件
pa.sendEvent(Event("page.display", data: [ "page": "page name", // Event properties "page_chapter1": "chapter 1", "page_chapter2": "chapter 2", "page_chapter3": "chapter 3" ]))
有关更多示例,请参阅文档
(返回顶部)
贡献
请放心使用此GitHub项目进行贡献,我们会查看所有合并请求或问题。请注意,在接收(或拒绝)时,我们会始终关闭合并请求,因为任何修改必须由我们独家完成(因此,如果我们认为它有用,我们会实现您的合并请求)。另外,GitHub上的问题和请求可能需要更长的时间我们来处理,因为我们有专门的支持工具为客户服务。所以建议您只使用GitHub工具进行技术目的:)
许可协议
本软件按照MIT许可协议发布。
(返回顶部)
联系方式
AtInternet钢琴公司 - [email protected]
(返回顶部)