Skip to content

Other SDK customizations

Braze log level

The default log level for the Braze iOS SDK is minimal, or 8 in the following chart. This level suppresses most logging so that no sensitive information is logged in a production-released application.

See the following list of available log levels:

Log levels

Level Description
0 Verbose. All log information will be logged to the iOS console.
1 Debug. Debug and higher log information will be logged to the iOS console.
2 Warning. Warning and higher log information will be logged to the iOS console.
4 Error. Error and higher log information will be logged to the iOS console.
8 Minimal. Minimal information will be logged to the iOS console. The SDK’s default setting.

Verbose logging

You can configure log level to any available value. However, setting log level to verbose, or 0, can be very useful for debugging issues with your integration. This level is only intended for development environments and should not be set in a released application.

Setting log level

Log level can be assigned either at compile time or at runtime:

Add a dictionary named Braze to your Info.plist file. Inside the Braze dictionary, add the LogLevel string subentry and set the value to 0.

Example Info.plist contents:

1
2
3
4
5
<key>Braze</key>
<dict>
  <key>LogLevel</key>
  <string>0</string>
</dict>

Add the ABKLogLevelKey inside the appboyOptions parameter passed to startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Set its value to the integer 0.

1
2
3
4
5
6
NSMutableDictionary *appboyOptions = [NSMutableDictionary dictionary];
appboyOptions[ABKLogLevelKey] = @(0);
[Appboy startWithApiKey:@"YOUR-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];
1
2
3
4
let appboyOptions: [AnyHashable: Any] = [
  ABKLogLevelKey : 0
]
Appboy.start(withApiKey: "YOUR-API-KEY", in:application, withLaunchOptions:launchOptions, withAppboyOptions:appboyOptions)

Optional IDFA collection

IDFA Collection is optional within the Braze SDK and disabled by default. IDFA Collection is only required within Braze if you intend to utilize our install attribution integrations. If you opt to store your IDFA, we will store it free of charge, so you may take advantage of these options immediately upon release without additional development work.

As a result, we recommend continuing to collect the IDFA if you meet any of the following criteria:

  • You are attributing app installation to a previously served advertisement
  • You are attributing an action within the application to a previously served advertisement

iOS 14.5 AppTrackingTransparency

Apple requires users to opt-in through a permission prompt to collect IDFA.

To collect IDFA, in addition to implementing Braze’s ABKIDFADelegate protocol, your application will need to request authorization from the user using Apple’s ATTrackingManager in the app tracking transparency framework. Refer to Apple’s user privacy article for more information.

The prompt for app tracking transparency authorization requires an Info.plist entry to explain your usage of the identifier:

1
2
<key>NSUserTrackingUsageDescription</key>
<string>To retarget ads and build a global profile to better serve you things you would like.</string>

Implementing IDFA collection

Follow these steps to implement IDFA Collection:

Step 1: Implement ABKIDFADelegate

Create a class that conforms to the ABKIDFADelegate protocol:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#import "IDFADelegate.h"
#import <AdSupport/ASIdentifierManager.h>
#import <AppTrackingTransparency/AppTrackingTransparency.h>

@implementation IDFADelegate

- (NSString *)advertisingIdentifierString {
  return [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];
}

- (BOOL)isAdvertisingTrackingEnabledOrATTAuthorized {
  if (@available(iOS 14, *)) {
    return [ATTrackingManager trackingAuthorizationStatus] == ATTrackingManagerAuthorizationStatusAuthorized;
  }
  return [[ASIdentifierManager sharedManager] isAdvertisingTrackingEnabled];
}

@end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import Appboy_iOS_SDK
import AdSupport
import AppTrackingTransparency

class IDFADelegate: NSObject, ABKIDFADelegate {
   func advertisingIdentifierString() -> String {
    return ASIdentifierManager.shared().advertisingIdentifier.uuidString
  }

  func isAdvertisingTrackingEnabledOrATTAuthorized() -> Bool {
    if #available(iOS 14, *) {
      return ATTrackingManager.trackingAuthorizationStatus ==  ATTrackingManager.AuthorizationStatus.authorized
    }
    return ASIdentifierManager.shared().isAdvertisingTrackingEnabled
  }
}
Step 2: Set the delegate during Braze initialization

In the appboyOptions dictionary passed to startWithApiKey:inApplication:withAppboyOptions:, set the ABKIDFADelegateKey key to an instance of your ABKIDFADelegate conforming class.

Approximate iOS SDK size

The approximate iOS SDK framework file size is 30MB, and the approximate .ipa (addition to app file) size is between 1MB and 2MB.

Braze measures the size of our iOS SDK by observing the SDK’s effect on .ipa size, per Apple’s recommendations on app sizing. If you are calculating the iOS SDK’s size addition to your application, we recommend following Getting an app size report to compare the size difference in your .ipa before and after integrating the Braze iOS SDK. When comparing sizes from the app thinning size report, we also recommend looking at app sizes for thinned .ipa files, as universal .ipa files will be larger than the binaries downloaded from the App Store and installed onto user devices.

WAS THIS PAGE HELPFUL?
New Stuff!