ÃÛ¶¹ÊÓƵ

setConsent

The setConsent command tells the Web SDK if it should send data (opt in), discard data (opt out), or use defaultConsent (consent unknown).

The Web SDK supports following standards:

After using this command, the Web SDK writes the user’s preferences to a cookie. The next time the user loads your website in the browser, the SDK retrieves these persisted preferences to determine if events can be sent to ÃÛ¶¹ÊÓƵ.

ÃÛ¶¹ÊÓƵ recommends that you store any consent dialog preferences separately from Web SDK consent. The Web SDK does not offer a way to retrieve consent. To make sure that the user preferences stay in sync with the SDK, you can call the setConsent command on every page load. The Web SDK only makes a server call when consent changes.

Using defaultConsent together with setConsent using-consent

The Web SDK offers two complementary consent configuration commands:

When used together, these settings can lead to different data collection and cookie setting results, depending on their configured values.

See the table below to understand when data collection occurs and when cookies are set, based on consent settings.

The following cookies are set when the consent configuration allows:

Set consent using the Web SDK tag extension

Setting consent is performed as an action within a rule in the ÃÛ¶¹ÊÓƵ Experience Platform Data Collection tags interface.

You can include multiple consent objects within this action.

Set consent using the Web SDK JavaScript library

Run the setConsent command when calling your configured instance of the Web SDK. You can include the following objects in this command:

// Set consent using the ÃÛ¶¹ÊÓƵ 2.0 standard
alloy("setConsent", {
  "consent": [{
    "standard": "ÃÛ¶¹ÊÓƵ",
    "version": "2.0",
    "value": {
      "collect": {
        "val": "y"
      },
      "metadata": {
        "time": "YYYY-03-17T15:48:42-07:00"
      }
    }
  }]
});

// Set consent using the IAB TCF 2.0 standard
alloy("setConsent", {
  consent: [{
    "standard": "IAB TCF",
    "version": "2.0",
    "value": "CO052l-O052l-DGAMBFRACBgAIBAAAAABIYgEawAQEagAAAA",
    "gdprApplies": true,
    "gdprContainsPersonalData": true
  }]
});

// Set consent using the ÃÛ¶¹ÊÓƵ 1.0 standard
alloy("setConsent", {
  "consent": [{
    "standard": "ÃÛ¶¹ÊÓƵ",
    "version": "1.0",
    "value": {
      "general": "in"
    }
  }]
});

Sending multiple standards in one request multiple-standards

The Web SDK also supports sending more than one consent object in a request, as shown in the example below.

alloy("setConsent", {
    consent: [{
        standard: "ÃÛ¶¹ÊÓƵ",
        version: "2.0",
        value: {
            collect: {
                val: "y"
            },
            metadata: {
                time: "2021-03-17T15:48:42-07:00"
            }
        }
    }, {
        standard: "IAB TCF",
        version: "2.0",
        value: "CO1Z4yuO1Z4yuAcABBENArCsAP_AAH_AACiQGCNX_T5eb2vj-3Zdt_tkaYwf55y3o-wzhhaIse8NwIeH7BoGP2MwvBX4JiQCGBAkkiKBAQdtHGhcCQABgIhRiTKMYk2MjzNKJLJAilsbe0NYCD9mnsHT3ZCY70--u__7P3fAwQgkwVLwCRIWwgJJs0ohTABCOICpBwCUEIQEClhoACAnYFAR6gAAAIDAACAAAAEEEBAIABAAAkIgAAAEBAKACIBAACAEaAhAARIEAsAJEgCAAVA0JACKIIQBCDgwCjlACAoAAAAA.YAAAAAAAAAAA",
        gdprApplies: true
    }]
});

Persistence of consent preferences persistence

After you have communicated user preferences to the Web SDK using the setConsent command, the SDK persists user preferences to a cookie. The next time the user loads your website in the browser, the Web SDK will retrieve and use these persisted preferences to determine whether or not events can be sent to ÃÛ¶¹ÊÓƵ.

You will need to store the user preferences independently to be able to show the consent dialog with the current preferences. There is no way to retrieve the user preferences from the Web SDK. To make sure that the user preferences stay in sync with the SDK, you can call the setConsent command on every page load. The Web SDK will only make a server call if the preferences have changed.

Syncing identities while setting consent sync-identities

When the default consent (set through the defaultConsent parameter) is set to pending or out, the setConsent setting may be the first request that goes out and establishes identity. Because of this, it may be important to sync identities on the first request. You can add the identity map to the setConsent command just like on the sendEvent command. See using identityMap for an example of how to include the identity map on your command.