useConsent configuration option is false, which is its default value).
How it Works
In this default mode, the SDK’s tracking and data collection activities are primarily controlled by theoptOut configuration option.
-
optOut: false(Default):- If you initialize the SDK without specifying
useConsent: trueoroptOut: true, the SDK assumes it has permission to operate fully. - It will track user activities (screen views, events).
- It will process and store user identities provided via
setUserIdentities. - It will send user properties and page properties.
- If you initialize the SDK without specifying
-
optOut: true:- If you explicitly set
optOut: trueduring initialization, the SDK will be significantly restricted, effectively acting as a global “do not track” for the SDK in your app. - No tracking events will be sent to Zeotap.
- User identification calls will be ignored.
- All data collection functions will be disabled.
- If you explicitly set
Interaction with setConsent API
When the SDK is operating in this default mode (useConsent: false), calls to the setConsent() function have limited effect:
- The
trackparameter within thesetConsentobject is ignored. Setting it totrueorfalsewill have no impact on the SDK’s tracking behavior, which remains governed by theoptOutoption. - However, any Brand Consents included in the
setConsentcall (e.g.,{ "myBrandConsent": true }) will still be processed, stored, and sent with subsequent events under thez_pquery parameter of tracking requests.
Example
Default Mode with OptOut
Brand Consent in Default Mode
When to Use Default Mode
Recommended for:- Apps that don’t operate under strict privacy regulations
- Internal/enterprise apps with pre-agreed data collection terms
- Apps in regions without explicit consent requirements
- Development and testing environments
- Apps distributed in EU/GDPR regions
- Apps subject to CCPA or similar privacy laws
- Consumer-facing apps that prioritize user privacy
- Apps that need granular consent management
Related Documentation
- Consent Configuration Options: Detailed configuration options for consent management
- Set Consent API: API reference for managing user consent
- Choosing a Consent Strategy: Guide to choosing the right consent approach