Consent Configuration Options

​

optOut

• Type: Boolean
• Default: false
• Description: This is the flag to completely disable or enable data collection in the app if no consent configuration was setup.
  • false (Default): The SDK operates normally and collects data.
  • true: Completely disables all data collection. No events are tracked, and no data is sent to Zeotap servers.

CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .optOut(true)  // Disable all tracking
    .build();

Collect.init(options);

​

useConsent

• Type: Boolean
• Default: false
• Description: This is the primary flag to enable or disable data collection based on custom consent management of the application.
  • false (Default): The SDK operates in its default mode. Tracking behavior is primarily controlled by the optOut flag. The SDK assumes consent unless explicitly opted out.
  • true: Activates custom consent. The SDK will now expect and respect consent signals provided by the app before performing tracking actions. It will either look for CMP data (if checkForCMP is true) or wait for setConsent calls. Events may be queued until consent is determined.

CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .useConsent(true)  // Enable consent management
    .build();

Collect.init(options);

​

checkForCMP

• Type: Boolean
• Default: false
• Description: This option is only relevant when useConsent is set to true. It tells the SDK to honor CMP (Consent Management Platform) data to set the consent for tracking.
  • false (Default): The SDK will rely solely on explicit calls to the setConsent() function to receive consent signals. This is used for custom consent implementations.
  • true: The SDK will look for CMP (Consent Management Platform) data that might be stored by other CMPs or consent frameworks. If found, it will use the signals provided to determine consent for tracking based on the configured purposes.

CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .useConsent(true)
    .checkForCMP(true)  // Look for CMP data
    .build();

Collect.init(options);

​

checkZeotapVendorConsent

• Type: Boolean
• Default: false
• Description: Adds an additional layer of validation when using a CMP (useConsent: true and checkForCMP: true).
  • false (Default): The SDK only checks for consent against the configured purposesForTracking.
  • true: In addition to checking purpose consents, the SDK will also explicitly check if consent has been granted for Zeotap as a vendor within the consent data. Tracking will only proceed if both the required purpose consents and vendor consent for Zeotap are present.

CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .useConsent(true)
    .checkForCMP(true)
    .checkZeotapVendorConsent(true)  // Require Zeotap vendor consent
    .build();

Collect.init(options);

​

purposesForTracking

• Type: List<Integer>
• Default: [1, 3, 4]
• Description: Specifies the list of purpose IDs for which the user must have granted consent in order for the SDK to perform tracking actions (e.g., sending events via setEventProperties, automatic lifecycle events). This option is only used when useConsent: true and checkForCMP: true. The SDK checks if consent is granted for all purposes listed in this array.
  • Example TCF Purposes:
    • 1: Store and/or access information on a device
    • 3: Create a personalized profile
    • 4: Select personalized content

CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .useConsent(true)
    .checkForCMP(true)
    .purposesForTracking(Arrays.asList(1, 3, 5))  // Require consent for specific purposes
    .build();

Collect.init(options);

​

Combined Usage

​

Consent Configuration Examples

​

Basic Consent Management

// Simple consent management with manual control
CollectOptions options = CollectOptions.builder(this)
    .credential("YOUR_WRITE_KEY")
    .useConsent(true)
    .checkForCMP(false)
    .build();

Collect.init(options);

// Later, when user provides consent
Map<String, Object> consentData = new HashMap<>();
consentData.put("track", true);
consentData.put("identify", true);

Collect.getInstance().setConsent(consentData);

​

Best Practices

1. Choose the Right Strategy: Select the consent strategy that matches your legal requirements and user experience goals.
2. Provide Clear Information: Always explain to users what data you’re collecting and why.
3. Honor User Choices: Respect user consent decisions and provide easy ways to change them.
4. Regular Audits: Regularly review and audit your consent implementation to ensure compliance.
5. Test Thoroughly: Test all consent scenarios, including edge cases and state transitions.

​

Related Documentation

• Write Key Configuration: Learn how to configure your write key
• Set Consent API: API reference for consent management
• Consent Strategy Guide: Choose the right consent approach