Skip to main content

Consent Configuration Options

The Zeotap iOS SDK provides several configuration options within the CollectOption to manage how user consent is handled. These settings are crucial for ensuring compliance with privacy regulations like GDPR, CCPA, and other regional data protection laws. Understanding these options helps you tailor the SDK's behavior to match your chosen consent strategy, whether you're using a consent management platform, a custom consent solution, or operating under specific regional requirements.

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.
var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .optOut(value: true)  // Disable all tracking
    .build()

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.
var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .useConsent(value: true)  // Enable consent management
    .build()

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.
var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .useConsent(value: true)
    .checkForCMP(value: true)  // Look for CMP data
    .build()

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 (ID 1469) within the consent data. Tracking will only proceed if both the required purpose consents and vendor consent for Zeotap are present.
info

Important: Please ensure that your CMP configuration includes the new Vendor ID 1469 for 1st Party data tracking if your iOS SDK version is 1.3.10 or later. Additionally, include Vendor ID 301 for backward compatibility.

var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .useConsent(value: true)
    .checkForCMP(value: true)
    .checkZeotapVendorConsent(value: true)  // Require Zeotap vendor consent
    .build()

purposesForTracking​

  • Type: [Int] (Array of integers)
  • Default: [1, 3, 4] (Empty array)
  • 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
var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .useConsent(value: true)
    .checkForCMP(value: true)
    .purposesForTracking(value: [1, 3, 5])  // Require consent for specific purposes
    .build()

Combined Usage​

useConsentcheckForCMPsetConsent() callDescription of SDK Behavior
Not SetNot SetOptional (Only called for passing brand consents.)Default Behavior: Consent management is disabled. The SDK assumes consent is granted and performs tracking unless optOut is true.
truefalseRequiredCustom Consent Management: Consent management is enabled, and the SDK relies on manual setConsent() calls to receive consent signals. The tracking behavior is directly controlled by these calls.
truetrueOptional (Only called for passing brand consents.)CMP Integration: Consent management is enabled, and the SDK looks for CMP data to determine consent. Manual setConsent() calls can use to send other consent data.
// Simple consent management with manual control
var collectOptions = CollectOption()
    .writeKey(value: "YOUR_WRITE_KEY")
    .useConsent(value: true)
    .checkForCMP(value: false)
    .build()

Collect.initialize(option: collectOptions)

// Later, when user provides consent

// if user opts in
var consentData = [
    "track": true,
    "identify": true
]
Collect.getInstance()?.setConsent(consent: 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.

Last updated on