Track User Consent

The setConsent method is used to manage user consent for data collection and processing. This is essential for compliance with privacy regulations like GDPR, CCPA, and other data protection laws.

Syntax

Collect.getInstance()?.setConsent(_ properties: [String: Any], _ callback: ResponseCallback?)

Parameters

Parameter	Type	Required	Description
properties	[String: Any]	Yes	Dictionary of consent properties and their status
callback	ResponseCallback?	Optional	Callback to handle function response

Consent Properties

The consent properties is a object containing key-value pairs. It includes:

Primary Consent Keys

track (boolean)

• true: Allows the SDK to send tracking events (e.g., from setEventProperties, page views).
• false: Prevents the SDK from sending tracking events.

Brand Consent Keys

• Any additional key-value pairs in the object.
• Used for tracking consent related to marketing (e.g., newsletterOptIn, personalizationConsent).
• Passed as query parameters in spl call under z_p.
• Do not directly control SDK tracking or cookie behavior.

note

Brand consents are processed and sent to Zeotap independently of the track and cookieSync settings. Even if primary tracking consent is denied, brand consent information can still be transmitted.

---

Usage Examples

Example 1: Grant Consent

Collect.getInstance()?.setConsent([
    "track": true
])

Example 2: Deny Consent

Collect.getInstance()?.setConsent([
    "track": false
])

Example 3: Passing Brand Consent

Collect.getInstance()?.setConsent([
    "zeotapVendorConsent": true,
    "abcVendorConsent": false
])

Example 4: Passing Brand Consent with primary Consent

Collect.getInstance()?.setConsent([
    "track": true,
    "zeotapVendorConsent": true,
    "abcVendorConsent": false
])

Note

In case of, default consent (optOut: false) or CMP consent (useConsent: true and checkForCMP: true) setting primary consent flag will be ignored even if it was sent as part of setConsent method

Passing Consent with Callback

You can also pass consent with Callback function as shown below. The data parameter is an object that contains status and message which helps to debug the status of the function call.

Collect.getInstance()?.setConsent([
    "track": true,
    "zeotapVendorConsent": true,
    "abcVendorConsent": false
], {data in 
    // Implement function to handle response
    // [status: "SUCCESS", message: "User identities set successfully"]
})

Best Practices

1. Request Consent Early: Ask for consent before collecting any data.

2. Provide Clear Information: Explain what each consent category means and how data will be used.

3. Respect User Choices: Honor the user's consent decisions and don't repeatedly ask.

4. Store Consent Locally: Save consent preferences locally to avoid asking repeatedly.

5. Allow Easy Updates: Provide an easy way for users to change their consent preferences.

6. Default to Denied: When in doubt, default to denying consent rather than assuming consent.