User Properties

User properties are key-value pairs attached to SDK requests. They are split into:

Whitelisted properties (wp)
Blacklisted properties (bp)

Whitelisted Properties (`wp`)

AudienceLabSDK.setUserProperty(
    key: "subscription_tier",
    value: "premium",
    set: .whitelisted
)

AudienceLabSDK.unsetUserProperty(
    key: "subscription_tier",
    set: .whitelisted
)

AudienceLabSDK.clearUserProperties(.whitelisted)

Blacklisted Properties (`bp`)

AudienceLabSDK.setUserProperty(
    key: "external_id",
    value: "user-123",
    set: .blacklisted
)

AudienceLabSDK.unsetUserProperty(
    key: "external_id",
    set: .blacklisted
)

AudienceLabSDK.clearUserProperties(.blacklisted)

Special Handling for `email` and `phone`

When email or phone is set as a blacklisted property, the SDK automatically normalizes and SHA-256 hashes the value before persisting or sending it.

AudienceLabSDK.setUserProperty(
    key: "email",
    value: "player@example.com",
    set: .blacklisted
)

AudienceLabSDK.setUserProperty(
    key: "phone",
    value: "+358 40 123 4567",
    set: .blacklisted
)

Property Constraints

Constraint	Limit
Max properties per set	50
Max key length	64 characters
Max string value length	256 characters
Max serialized size	2,048 bytes

Reserved Keys

Keys starting with _ are reserved for backend-managed whitelisted properties and should not be set manually.

Reading Stored Properties

let wp = AudienceLabSDK.getWhitelistedUserProperties()
let bp = AudienceLabSDK.getBlacklistedUserProperties()

Whitelisted Properties (wp)

Blacklisted Properties (bp)