文档Experience PlatformWeb SDK指南

setConsent

Last update: Tue Mar 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

此 setConsent 命令告知Web SDK是应发送数据（选择启用）、丢弃数据（选择禁用）还是使用 defaultConsent （同意未知）。

Web SDK支持以下标准：

使用此命令后，Web SDK会将用户的首选项写入Cookie。 下次用户在浏览器中加载您的网站时，SDK将检索这些保留的首选项，以确定是否可将事件发送到Adobe。

Adobe建议您将任何同意对话框首选项与Web SDK同意分开存储。 Web SDK不提供检索同意的方法。 要确保用户首选项与SDK保持同步，您可以调用 setConsent 命令进行加载。 Web SDK仅在同意更改时进行服务器调用。

使用Web SDK标记扩展设置同意

在Adobe Experience Platform数据收集标记界面中，将同意设置作为规则中的一项操作。

  1. 登录 experience.adobe.com 使用您的Adobe ID凭据。
  2. 导航到 数据收集 > 标记.
  3. 选择所需的标记属性。
  4. 导航到 规则，然后选择所需的规则。
  5. 下 操作，选择现有操作或创建操作。
  6. 设置 扩展名 下拉字段至 Adobe Experience Platform Web SDK，并设置 操作类型 到 设置同意.
  7. 在右侧设置所需字段，包括 标准 和 一般同意.
  8. 单击 保留更改，然后运行发布工作流程。

您可以在此操作中包含多个同意对象。

使用Web SDK JavaScript库设置同意

运行 setConsent 命令。 您可以在此命令中包含以下对象：

  • consent[]：数组 consent 对象。 同意对象的格式有所不同，具体取决于您选择的标准和版本。
  • identityMap：一个对象，可控制如何生成ECID以及同意信息绑定到哪些ID。 Adobe建议在以下情况下包含此对象： setConsent 在其他命令之前运行，例如 sendEvent.
  • edgeConfigOverrides：包含 数据流配置覆盖.
Adobe2.0

  • standard：您选择的同意标准。 将此属性设置为 "Adobe" 用于Adobe2.0标准。

  • version：表示同意标准版本的字符串。 将此属性设置为 "2.0" 用于Adobe2.0标准。

  • value：包含同意值的对象。

    • value.collect.val：同意值。 有效值为 "y" （选择启用）和 "n" （选择禁用）。
    • value.metadata.time：用户设置同意值的时间戳。
code language-js 
alloy("setConsent", {
  "consent": [{
    "standard": "Adobe",
    "version": "2.0",
    "value": {
      "collect": {
        "val": "y"
      },
      "metadata": {
        "time": "YYYY-03-17T15:48:42-07:00"
      }
    }
  }]
});
IAB TCF 2.0
  • standard：您选择的同意标准。 将此属性设置为 "IAB TCF" 适用于IAB TCF 2.0标准。
  • version：表示同意标准版本的字符串。 将此属性设置为 "2.0" 适用于IAB TCF 2.0标准。
  • value：包含同意值的字符串。
  • gdprApplies：一个布尔值，用于确定GDPR是否适用于此同意值。 其默认值为 true。
  • gdprContainsPersonalData：一个布尔值，用于确定与此用户关联的事件数据是否包含个人数据。 其默认值为 false。
code language-js 
alloy("setConsent", {
  consent: [{
    "standard": "IAB TCF",
    "version": "2.0",
    "value": "CO052l-O052l-DGAMBFRACBgAIBAAAAABIYgEawAQEagAAAA",
    "gdprApplies": true,
    "gdprContainsPersonalData": true
  }]
});
Adobe1.0
  • standard：您选择的同意标准。 将此属性设置为 "Adobe" 对于Adobe1.0标准。
  • version：表示同意标准版本的字符串。 将此属性设置为 "1.0" 对于Adobe1.0标准。
  • value.general：同意值。 有效值为 "in" （选择启用）和 "out" （选择禁用）。
code language-js 
// Set consent using the Adobe 1.0 standard
alloy("setConsent", {
  "consent": [{
    "standard": "Adobe",
    "version": "1.0",
    "value": {
      "general": "in"
    }
  }]
});
recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636