移动sdk:将Bazaarvoice集成到您的原生Android和iOS应用程序中。
安装
Bazaarvoice移动sdk提供了对Bazaarvoice提供的大多数核心产品的访问。必威手机版本要了解更多信息,请参阅Mobile SDK文档主页.
内容
简介
本指南向您展示如何在您的iOS应用程序中安装和配置Bazaarvoice Mobile SDK所需的要求首先为您的应用程序!Bazaarvoice支持XCode 8.0或更高版本。
版本控制
iOS的Mobile SDK提供了对Objective-C和Swift编程语言的支持。SDK进行了版本控制,这样我们就可以发布新功能、bug修复和改进,而不会影响使用旧版本的应用程序的稳定性。
下表总结了主要的版本发布。有关更多信息,请参阅移动SDK的iOS (Objective-C) Github回购.
版本 | 发布日期 | 状态 |
---|---|---|
1 | 2012年7月16日 | 弃用 |
2 | 2013年1月23日 | 弃用 |
3. | 2015年12月21日 | 弃用 |
4 | 2016年5月4日 | 弃用 |
5 | 2016年10月31日 | 支持 |
6 | 2016年11月28日 | 支持 |
7 | 2018年3月6日 | 支持 |
8 | 10月12日 | 最新的 |
下表总结了主要的版本发布。有关更多信息,请参阅iOS移动SDK (Swift) Github回购.
版本 | 发布日期 | 状态 |
---|---|---|
1 | 2020年2月28日 | 最新的 |
- 弃用
- 不应期望这些版本返回数据和/或可能遇到服务降级。特定于这些版本的文档可能不再可用。这些版本不应该被任何应用程序使用。
- 支持
- 受支持的版本会继续得到安全性和错误修复,但是使用这些版本的应用程序应该在可能的情况下升级到最新版本,以利用新特性。新的应用程序不应该使用这些版本。
- 最新的
- 这是最新版本。新的应用程序应该使用该版本的最新版本。
广告商标识符(IDFA)
广告商标识符(IDFA)是苹果分配给用户设备的随机设备标识符。IDFA用于跟踪和识别用户(不透露个人信息)。广告商利用它来跟踪数据,以便提供定制广告。在iOS 13及更早的版本中,IDFA在默认情况下是可用的,除非用户在其iOS设备上的设置中有有限的广告个性化。随着iOS 14的发布,用户需要明确地授予权限才能使用IDFA。添加AppTrackingTransparency
允许您的应用程序添加一个ATT警报,要求用户允许访问和使用标识符,如IDFA。
请求应用程序跟踪透明度授权
如果您使用的是BVSDK 8.4.0及以上版本或BVSwift 1.4.0及以上版本,要显示访问IDFA的应用程序跟踪透明度授权请求,请更新您的信息。Plist添加NSUserTrackingUsageDescription使用描述您的使用情况的自定义消息。下面是一个示例描述文本
NSUserTrackingUsageDescription 您的数据将用于为您提供更好的个性化广告体验。字符串> < /
使用说明出现在应用跟踪透明度对话框中
安装BVSDK
我们支持安装Bazaarvoice SDK的iOS与CocoaPods,迦太基,动态框架,或直接源代码。选择最适合您的开发环境的解决方案。
默认情况下,Cocoapods的每个BV模块都会安装BVCore + BVAnalytics模块。
- 的最新版本CocoaPods.Bazaarvoice支持Cocoapods 1.1.0或更高版本。
- 将您拥有API密钥的pod添加到您的
Podfile
:# each pod是一个子psec,所以你只需要为你正在安装的组件添加行。pod 'BVSDK/BVAnalytics' //由pod 'BVSDK/BVCommon' pod 'BVSDK/BVCommonUI' pod 'BVSDK/BVConversations' pod 'BVSDK/BVConversationsStores' pod 'BVSDK/BVCurationsUI' pod 'BVSDK/ BVSDK/BVNotifications' pod 'BVSDK/BVRecommendations'自动安装
- 在终端上执行如下命令:
$ pod install
- 打开托管
.xcworkspace
在Xcode中打开你的项目。以后,要更新到SDK的最新版本,只需运行:$ pod更新
默认情况下,Cocoapods的每个BV模块都会安装BVCore + BVAnalytics模块。
- 的最新版本CocoaPods.Bazaarvoice支持Cocoapods 1.1.0或更高版本。
- 将您拥有API密钥的pod添加到您的
Podfile
:# each pod是一个子psec,所以你只需要为你正在安装的组件添加行。pod 'BVSwift/BVAnalytics' //由pod 'BVSwift/BVCommon' pod 'BVSwift/BVConversations' pod 'BVSwift/BVCurations' pod 'BVSwift/BVRecommendations'下的任何子模块自动安装
- 在终端上执行如下命令:
$ pod install
- 打开托管
.xcworkspace
在Xcode中打开你的项目。以后,要更新到SDK的最新版本,只需运行:$ pod更新
- 下载最新资料
BVSDK.framework.zip
从我们的GitHub发布页面. - 拖
BVSDK.framework
到Xcode项目的“常规”设置的“嵌入式二进制文件”部分。确保选择“如有需要复制项目”。 - 转到Xcode项目设置的“Build Phases”部分,创建一个新的“Run Script Build Phase”。将以下代码段粘贴到文本字段中:
bash " $ {BUIL必威手机版本T_PRODUCTS_DIR} / $ {FRAMEWORKS_FOLDER_PATH} / BVSDK.framework / integrate-dynamic-framework.sh”
- 下载最新资料
BVSwift.framework.zip
从我们的GitHub发布页面. - 拖
BVSwift.framework
到Xcode项目的“常规”设置的“嵌入式二进制文件”部分。确保选择“如有需要复制项目”。 - 转到Xcode项目设置的“Build Phases”部分,创建一个新的“Run Script Build Phase”。将以下代码段粘贴到文本字段中:
bash " $ {BUIL必威手机版本T_PRODUCTS_DIR} / $ {FRAMEWORKS_FOLDER_PATH} / BVSwift.framework / integrate-dynamic-framework.sh”
- 复制此repo,或下载来自GitHub的最新版本:
- 复制下面的所有源文件夹
/ BVSDK
,除了支持
文件夹,到您的项目。确保选择如有需要,复制项目.
- 复制此repo,或下载来自GitHub的最新版本:
- 复制下面的所有源文件夹
/ BVSWift
,除了支持
文件夹,到您的项目。确保选择如有需要,复制项目.
添加包依赖
我们从1.5.0版本开始支持Bazaarvoice的iOS Swift SDK(BVSwift)的Swift Package Manager集成。要将BVSwift包依赖项添加到Xcode项目,请使用GitHub库并遵循下面列出的步骤
你可以通过以下任何一个步骤将Swift Package Manager依赖添加到你的Xcode项目中:
选择“File > Swift Packages > Add Package Dependency”,输入“BVSwift repository URL”
您也可以选择项目并进入Swift包,单击+按钮,并输入BVSwift存储库URL。
您也可以导航到目标的General窗格,在“框架,库嵌入式内容”部分,单击+按钮,选择添加其他,然后选择添加包依赖项。
配置BVSDK
一旦安装了SDK的源代码,现在就可以初始化BVSDKManager
使用API密钥和环境(登台vs生产)。
下表将为您的SDK生成一个配置文件。您设置的值将生成必要的脚本和Mobile SDK初始化代码,以便快速启动和运行。
每个客户端应用程序都应该有自己的API密钥。如果您需要为对话生成一个新键,请参见请求API密钥的对话.
对于所有其他API密钥,或者如果您不知道您的客户端ID,请联系Bazaarvoice的支持或者你的实现团队。
必威手机版本 | 生产 | 暂存 |
---|---|---|
内容管理 | ||
对话 | ||
商店对话 | ||
产品推荐及广告 | ||
分析语言环境 |
输入客户端ID和至少一个API密钥。
添加正确的导入语句,以便您可以引用正在使用的Mobile SDK模块。
@ import BVSDK;
进口BVSDK
进口BVSwift
初始化BVSDKManager
在XCode项目中。
完成以上步骤后,插入以下代码AppDelegate # applicationDidFinishLaunchingWithOptions
:
暂存
[BVSDKManager配置:BVConfigurationTypeStaging];//配置登台API密钥
生产
[BVSDKManager配置:BVConfigurationTypeProd];//配置Prod API键
初始化BVSDKManager
在XCode项目中。
完成以上步骤后,插入以下代码AppDelegate # applicationDidFinishLaunchingWithOptions
:
暂存
BVSDKManager.configure(.staging) //配置登台API键
生产
BVSDKManager.configure(.prod) //配置Prod API键
初始化BVManager
在XCode项目中。
暂存
BVManager.sharedManager.getConfiguration
生产
BVManager.sharedManager.getConfiguration
以编程方式配置BVSDK
的BVSDKManager
也可以通过编程方式进行配置。通常不推荐使用这种场景,但是,如果需要在同一个应用程序会话中修改API密钥,则可以使用这种方法。
NSDictionary *configDict = @{@" apiKeyConversations": @" YOUR_API_KEY", @"clientId": @" YOUR_CLIENT_ID"};[BVSDKManager configureWithConfiguration:configDict configType:BVConfigurationTypeStaging];
的BVSDKManager
也可以通过编程方式进行配置。通常不推荐使用这种场景,但是,如果需要在同一个应用程序会话中修改API密钥,则可以使用这种方法。配置BVSDKManager
像下面的Swift例子一样,通过编程的方式实现对话API。调用BVSDKManager.configure(…)
当您需要更新正在使用的API密钥和环境时。
let configDict = ["clientId": "YOUR_CLIENT_ID", "apiKeyConversations": "YOUR_API_KEY"];BVSDKManager。配置(withConfiguration: configDict, configType: .staging)
的BVManager
也可以通过编程方式进行配置。
var config: BVConversationsConfiguration = {() -> BVConversationsConfiguration in let analyticsConfig: BVAnalyticsConfiguration = .configuration(locale: locale(标识符:"locale"), configType: .staging(clientId: "clientId"))返回BVConversationsConfiguration。all(clientKey: "passkey", configType: .staging(clientId: "clientId"), analyticsConfig: analyticsConfig)}() //将"locale", "clientId", "passkey"占位符替换为相应的值
这个配置变量需要在所有请求中传递。