Storage

Learn about the different device-level properties that are stored by the Braze SDK.

Device properties

By default, Braze will collect the following device-level properties to allow device, language, and time zone-based message personalization:

AD_TRACKING_ENABLED
ANDROID_VERSION
CARRIER
IS_BACKGROUND_RESTRICTED
LOCALE
MODEL
NOTIFICIATION_ENABLED
RESOLUTION
TIMEZONE

note:

AD_TRACKING_ENABLED and TIMEZONE aren’t collected if they are null or blank. GOOGLE_ADVERTISING_ID is not collected automatically by the SDK and must be passed in via setGoogleAdvertisingId.

Device Carrier (see note on the CTCarrier deprecation)
Device Locale
Device Model
Device OS Version
Push Authorization Status
Push Display Options
Push Enabled
Device Resolution
Device Time Zone

note:

The Braze SDK does not collect IDFA automatically. Apps may optionally pass IDFA to Braze by implementing the methods directly below. Apps must obtain explicit opt-in to tracking by the end user through the App Tracking Transparency framework before passing IDFA to Braze.

To set the advertising tracking state, use set(adTrackingEnabled:).
To set the identifier for advertiser (IDFA), use set(identifierForAdvertiser:).

BROWSER
BROWSER_VERSION
LANGUAGE
OS
RESOLUTION
TIME_ZONE
USER_AGENT

By default, all properties are enabled. However, you can choose to enable or disable them manually. Keep in mind, some Braze SDK features require specific properties (such as local time zone delivery and time zone), so be sure to test your configuration before releasing to production.

For example, you can specify the Android OS version and device locale to be allowlisted. For more information, see the setDeviceObjectAllowlistEnabled() and setDeviceObjectAllowlist() methods.

new BrazeConfig.Builder()
    .setDeviceObjectAllowlistEnabled(true)
    .setDeviceObjectAllowlist(EnumSet.of(DeviceKey.ANDROID_VERSION, DeviceKey.LOCALE));

For example, you can specify time zone and locale collection to be allowlisted. For more information, see the devicePropertyAllowList property of the configuration object.

swift
objective-c

configuration.devicePropertyAllowList = [.timeZone, .locale]

configuration.devicePropertyAllowList = @[
    BRZDeviceProperty.timeZone,
    BRZDeviceProperty.locale
];

For example, you can specify the device language to be allowlisted. For more information, see refer to the devicePropertyAllowlist option for InitializationOptions.

import * as braze from"@braze/web-sdk";
braze.initialize("API-KEY", {
    baseUrl: "BASE-URL",
    devicePropertyAllowlist: [ braze.DeviceProperties.LANGUAGE ] // list of `DeviceProperties` you want to collect
});

tip:

To learn more about automatically-collected device properties, see SDK Data Collection.

Storing cookies (web only)

After initializing the Web Braze SDK it’ll create and store cookies with a 400-day expiration that automatically renews on new sessions.

The following cookies are stored:

Cookie Description Size

ab.storage.userId.[your-api-key] Used to determine whether the currently logged-in user has changed and to associate events with the current user. Based on the size of the value passed to changeUser

ab.storage.sessionId.[your-api-key] Randomly-generated string used to determine whether the user is starting a new or existing session to sync messages and calculate session analytics. ~200 bytes

ab.storage.deviceId.[your-api-key] Randomly-generated string used to identify anonymous users, and to differentiate users’ devices and enables device-based messaging. ~200 bytes

ab.optOut Used to store a user’s opt-out preference when disableSDK is called ~40 bytes

ab._gd Temporarily created (and then deleted) to determine the root-level cookie domain, which allows the SDK to work properly across sub-domains. n/a

Disabling cookies

To disable all cookies, use the noCookies option when initializing the Web SDK. This will prevent you from associating anonymous users who navigate across sub-domains and will result in a new user on each subdomain.

import * as braze from"@braze/web-sdk";
braze.initialize("API-KEY", {
    baseUrl: "BASE-URL",
    noCookies: true
});

To stop Braze tracking in general, or to clear all stored browser data, see the disableSDK and wipeData SDK methods, respectively. These two methods can be useful should a user revoke consent or you want to stop all Braze functionality after the SDK has already been initialized.

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Edit this page on GitHub

New Stuff!