准备条件

获取项目ID，请参考查看项目基本信息。

获取URL Scheme，在GrowingIO平台创建对应的应用时会生成URL Scheme。请参考创建应用。

1. 添加跟踪代码

组件化SDK

GrowingIO iOS SDK 包含以下2个组件SDK:

• GrowingCoreKit (组件基础库,具备分析功能)

• GrowingAutoTrackKit (无埋点库)

1. 添加依赖

在工程项目中添加以下库文件。

添加项目依赖库的位置在项目设置target -> 选项卡General -> Linked -> Linked Frameworks and Librarie

添加编译参数，并注意大小写。

2. 添加 URL Scheme

添加URL Scheme 到项目中，以便唤醒您的程序进行圈选。

3. 初始化配置

在 AppDelegate 中引入#import "Growing.h"并添加初始化方法。

#import "Growing.h"
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  ...
  // 启动GrowingIO
​
   [Growing startWithAccountId:@"您的项目ID"];      // 替换为您的项目ID
      // 其他配置
      // 开启Growing调试日志 可以开启日志
      // [Growing setEnableLog:YES];

import UIKit
import GrowingAutoTrackKit
​
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
​
​
​
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        Growing.start(withAccountId: "您的项目ID")
        return true
    }
    
    ...

4.添加激活圈选的代码

在 AppDelegate 中添加激活圈选的代码

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    ...
 if ([Growing handleUrl:url]) // 请务必确保该函数被调用
  {
      return YES;
  }
  return NO;
 ...
}

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    ...
    if (Growing.handle(url)) {
        return true
    }
    return false
    ...
}

常用示例：

若您在 AppDelegate 中实现了以下一个或多个方法，请在已实现的函数中，调用[Growing handleUrl:]

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(id)annotation
- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString*, id> *)options

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool
func application(_ application: UIApplication, handleOpen url: URL) -> Bool
func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Boolw

若以上所有方法均未实现，请实现以下方法并调用[Growing handleUrl:]

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(id)annotatio

func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool

2. 重要配置

1. 设置页面别名

有些时候，当您代码中的原有页面标题不足以支持业务人员对页面进行识别时，您可以使用此接口设置一个容易识别的页面名称来替换页面标题字段。

为处理这种场景，我们提供了取别名的方法，方法如下：

//手动标识该页面的标题，必须在该UIViewController显示之前设置
@property (nonatomic,copy) NSString* growingAttributesPageName;

2. 设置界面元素ID

当您的应用界面改版时，可能会导致无法准确地统计已经圈选的元素。因此，对于应用中的主要流程涉及到的界面元素，建议您为它们设置固定的唯一ID，以保证数据的一致性。

若要为元素设置ID，请在viewWillAppear或者时机更早的方法里添加以下代码：

-(void)viewWillAppear {
    UIView *MyView;
    …
    MyView.growingAttributesUniqueTag = @"my_view";
}

3. 设置元素内容

当您想采集一些可能没有文字的控件（比如UIImageView，UIView）时，也可以给属性growingAttributesValue 赋值作为文字，用来在圈选的时候区分不同的内容。

如果您的 app 上方有横向滚动的 Banner 广告，若要收集 Banner 相关数据，请在响应点击的控件上添加如下代码：

UIView *view;
…
view.growingAttributesValue = 广告的唯一ID;

其中 view 是您的广告元素，请确保两点：

• 对不同广告图，广告的唯一 ID 也不相同

• 响应点击的控件，与设置 ID 的控件是同一个

【例子】当您的横向滚动广告共有3张广告图时，您可以在3个响应点击的View上分别设置不同的广告唯一ID，实现方式：

view1.growingAttributesValue = @"ad1";
view2.growingAttributesValue = @"ad2";
view3.growingAttributesValue = @"ad3";

4. 采集输入框数据

如果您需要采集应用内某个输入框内的文字（例如搜索框），请调用如下接口进行设置：

UIView *view; // view 可以是 UITextField, UITextView, UISearchBar
 ...
view.growingAttributesDonotTrackValue = NO;

view代表要被采集的输入框。 当这个输入框失去焦点（包括应用退到后台），且输入框内容跟获取焦点前相比发生变化时，输入框内文字会被发送回GrowingIO。

5. Facebook广告SDK

如果您使用了 Facebook 广告 SDK，请务必在 main 函数第一行调用以下代码来避免冲突，否则可能造成无法创建项目或者统计准确性问题。注意：APP启动后，将不允许修改采集模式。

[Growing setAspectMode:GrowingAspectModeDynamicSwizzling];

6 采集WebView页面数据

SDK会自动采集H5页面的数据，不需要特殊配置。

7. 采集GPS数据

如果您的应用有相应的权限，SDK将自动采集您的GPS数据。

8. 启用Hashtag识别

您可以在项目中添加以下方法以启用Hashtag识别：

// 设置为 YES, 将启用 HashTag
+ (void)enableHybridHashTag:(BOOL)enable;

9. GDPR数据采集开关

GrowingIO SDK 针对欧盟区的一般数据保护法（GDPR）提供了以下的API共开发者调用。

// 开启GDPR，不采集数据
[Growing disableDataCollect];
​
// 关闭GDPR，采集数据
[Growing enableDataCollect];

10. DeepLink & Universal Link

DeepLink

1. 确认URl Scheme添加正确。

2. 添加自定义参数回调方法：

/**
 deeplink广告落地页参数回调设置
​
 @param handler deeplink广告落地页参数回调, params 为解析正确时回调的参数, processTime为从app被deeplink唤起到handler回调的时间(单位秒), error 为解析错误时返回的参数.
                 handler 默认为空, 客户需要手动设置.
 */
+ (void)registerDeeplinkHandler:(void(^)(NSDictionary *params, NSTimeInterval processTime, NSError *error))handler;

//DeepLink 调用示例
[Growing registerDeeplinkHandler:^(NSDictionary *params, NSTimeInterval processTime, NSError *error) {
        NSLog(@"params : %@", params);
        XCTAssertNotNil(params);
        XCTAssertEqualObjects(params[@"key1"], @"value1");
        XCTAssertEqualObjects(params[@"key2"], @"value2");
 }];

Universal Link

使用Universal Link唤醒App，步骤如下：

1. 配置链接：配置Universal Link、应用宝微下载（可选项）。

2. 请在AppDelegate.m添加以下代码：

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler{
    [Growing handleUrl:userActivity.webpageURL];
    return YES;
}

1. 添加Universal Link参数解析回调方法，此方法与DeepLink方法一致。

11. App Store提交应用注意事项

如果您添加了库AdSupport.framework，GrowingIO则会启用 IDFA，所以在向 App Store 提交应用时，需要：

• 对于问题 Does this app use the Advertising Identifier (IDFA)，选择 YES。

• 对于选项Attribute this app installation to a previously served advertisement，打勾。

• 对于选项Attribute an action taken within this app to a previously served advertisement，打勾。

为什么 GrowingIO 使用 IDFA?

GrowingIO 使用 IDFA 来做来源管理激活设备的精确匹配，让你更好的衡量广告效果。如您不希望启用IDFA，可以选择不引入 AdSupport.framework

关于权限获取

• 对于iOS 14之前，你无需主动获取 广告标识IDFA 的权限

• 对于iOS 14之后，你需要使用如下方法来开启你的 广告标识IDFA 的权限

1. Plist 文件中添加 NSUserTrackingUsageDescription

   <key>NSUserTrackingUsageDescription</key>
   <string>GrowingIO测试demo 需要使用你的广告标识信息以用于数据追踪分析</string> //描述内容请根据App修改

2. 导入框架 #import <AppTrackingTransparency/AppTrackingTransparency.h>

3. 调用获取权限代码

       if (@available(iOS 14, *)) {
           // iOS14及以上版本需要先请求权限
           [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
               switch (status) {
                   case ATTrackingManagerAuthorizationStatusDenied:
                       //用户拒绝向App授权
                       break;
                   case ATTrackingManagerAuthorizationStatusAuthorized:
                       //用户同意向App授权
                       break;
                   case ATTrackingManagerAuthorizationStatusNotDetermined:
                       //用户未做选择或未弹窗
                       break;
                   case ATTrackingManagerAuthorizationStatusRestricted:
                       //用户在系统级别开启了限制广告追踪
                       break;
                   default:
                       break;
               }
           }];
       }

12. 采集推送

在IOS SDK 2.6.3 版本， 支持采集用户点击本应用的通知的题和内容。此功能默认关闭，如需开启，请在 Application 初始化 GrowingIO 中设置，例如：

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 ...
  //开启推送点击采集
  [Growing disablePushTrack:NO];
  ...
  }

查看通知采集数据

支持对于通知的展现和点击事件的采集，GrowingIO 并未增加新的采集事件类型，而是使用了自定义事件发送，所以需要您创建自定义事件和事件级变量，事件级变量标识符为notification_title，notification_content，自定义事件的标识符为notification_show，notification_click如图：

13. 浏览事件的半自动采集配置

SDK版本支持：>=2.8.4

3.自定义数据上传

除上述的用户行为数据（无埋点数据）之外，GrowingIO 还提供了多种 API 接口，供您上传一些自定义的数据指标及维度 ，请参考iOS SDK API > 自定义数据上传API 。

4. 创建应用

在GrowingIO平台的应用创建页面继续完成应用创建的数据检测，检测成功后应用创建成功。

5. 验证SDK是否正常采集数据

GrowingIO为您提供多种验证SDK是否正常采集数据的方式：

方式一：Mobile Debugger​

方式二：在SDK中设置了Debug模式后，在IDE编译器控制台查看数据采集日志。

方式三：数据校验​