SDK 101

Before you begin to integrate the Braze SDKs, you may find yourself wondering what exactly you’re building and integrating. Further, you may find yourself curious about how you can customize it further to meet your needs. This article can help you answer all of your SDK questions.

Feature Set Defaults

If you follow our integration guides to implement our SDKs, you will be able to take advantage of our default data collection.

Device Properties

These properties are collected by the Web SDK upon proper integration.

Name Description
BROWSER The name of the browser.
BROWSER_VERSION The version of the browser.
OS The name of the operating system.
RESOLUTION The screen resolution of the device.
LANGUAGE The language the browser is set to use.
TIME_ZONE The time zone of the device.
USER_AGENT The user agent string of the browser.
See the Mozilla developer docs for more information.

These properties are collected by the Android SDK upon proper integration.

Name Description
ANDROID_VERSION
os_version
The version of the Android OS installed on the device.
CARRIER The mobile carrier.
MODEL The specific hardware of the device.
RESOLUTION Device resolution as “x".
LOCALE The default locale of the device. The format of this key is “en_US” or “language_COUNTRY”.
TIMEZONE
time_zone
The device time zone.
NOTIFICATIONS_ENABLED
remote_notification_enabled
Whether this app has notifications enabled.

These properties are collected by the iOS SDK upon proper integration.

Name Description
Device Resolution
ABKDeviceOptionResolution
The device’s reported resolution.
Device Carrier
ABKDeviceOptionCarrier
The reported mobile carrier.
Device Locale
ABKDeviceOptionLocale
The default locale of the device.
Device Model
ABKDeviceOptionModel
Device resolution as “x".
Device OS Version
ABKDeviceOptionOSVersion
The version of the iOS OS installed on the device.
Device IDFV
ABKDeviceOptionIDFV
Device identifier for vendors.
Device IDFA
ABKDeviceOptionIDFA
Device identifier for advertisers.
Device Push Enabled
ABKDeviceOptionPushEnabled
Whether this app has push notifications enabled.
Device Timezone
ABKDeviceOptionTimezone
The reported timezone of the device.
Device Push Authorization Status
ABKDeviceOptionPushAuthStatus
Whether this app has push authorization for the device.
Device Ad Tracking Enabled
ABKDeviceAdTrackingEnabled
Whether this app has Ad Tracking enabled.

Blocking Data Collection

It is possible, though not suggested, to block the automatic collection of certain data from your SDK integrations. As we stated above, not fully integrating our SDKs can reduce the capabilities of personalization and targeting.

For example, if you choose not to fully integrate for location on one of the SDKs, you will not be able to personalize your messaging based on language or location. If you choose not to integrate for timezone, you might not be able to send messages within a user’s timezone. If you choose to not integrate for specific device visual information, message content might not be optimized for that device.

We highly recommend fully integrating the SDKs to take full advantage of our product’s capabilties.

Web SDK

You may either simply not integrate certain parts of the SDK, or use stopWebTracking for a user. This method will sync data logged prior to when stopWebTracking() was called, and will cause all subsequent calls to the Braze Web SDK for this page and future page loads to be ignored. If you wish to resume data collection at a later point in time, you can use the resumeWebTracking() method in the future to resume data collection. You can learn more about this in our Disabling Web Tracking article.

Android SDK

You can use setDeviceObjectWhitelist to configure to only send a subset of the device object keys or values according to a set whitelist.

iOS SDK

You can use ABKDeviceWhitelistKey; to specify a whitelist for device fields that are collected by the SDK. Fields are defined in ABKDeviceOptions. To turn off all fields, set the value of this key to ABKDeviceOptionNone.

WAS THIS PAGE HELPFUL?
New Stuff!