Adobe隐私JavaScript库概述

作为数据处理者,Adobe会根据贵公司的权限和说明处理个人数据。 作为数据控制者,您可以决定Adobe代表您处理和存储的个人数据。 根据您选择通过Adobe Experience Cloud解决方案发送的信息,Adobe可以存储适用于隐私法规(如General Data Protection Regulation (GDPR)和California Consumer Privacy Act (CCPA))的隐私信息。 有关Experience Cloud解决方案如何收集隐私数据的更多信息,请参阅Adobe Experience Cloud中有关隐私的文档

Adobe隐私JavaScript库 ​允许数据控制者自动检索Experience Cloud解决方案为特定域生成的所有数据主体身份。 通过使用Adobe Experience Platform Privacy Service提供的API,这些身份随后可用于为属于这些数据主体的私有数据创建访问和删除请求。

NOTE
Privacy JS Library通常只需要安装在与隐私相关的页面上,不需要安装在网站或域的所有页面上。

功能

Privacy JS Library提供了几个用于管理Privacy Service中标识的功能。 这些函数只能用于管理存储在浏览器中的特定访客的身份。 不能使用它们直接向Experience Cloud Central Service提交信息。

下表概述了库提供的各种功能:

函数
描述
retrieveIdentities
返回从Privacy Service检索到的匹配标识数组(validIds),以及未找到标识数组(failedIds)。
removeIdentities
从浏览器中删除每个匹配(有效)的标识。 返回匹配标识(validIds)的数组,每个标识都包含isDeletedClientSide布尔值,指示此ID是否已删除。
retrieveThenRemoveIdentities
检索匹配标识的数组(validIds),然后从浏览器中删除这些标识。 虽然此函数与removeIdentities类似,但最好在您使用的Adobe解决方案需要访问请求才能进行删除时使用此函数(例如,在删除请求中提供唯一标识符之前必须检索唯一标识符时)。
NOTE
removeIdentitiesretrieveThenRemoveIdentities仅从浏览器中删除支持它们的特定Adobe解决方案的标识。 例如,Adobe Audience Manager不会删除存储在第三方Cookie中的Demdex ID,而Adobe Target会删除存储其ID的所有Cookie。

由于所有三个函数都表示异步进程,因此必须使用回调或承诺处理任何检索到的身份。

安装

若要开始使用Privacy JS Library,您必须使用以下方法之一将其安装到计算机上:

您还可以通过标记扩展安装库。 有关详细信息,请参阅有关Adobe隐私标记扩展的概述。

实例化Privacy JS Library

所有使用Privacy JS Library的应用都必须实例化新的AdobePrivacy对象,该对象必须配置为特定Adobe解决方案。 例如,Adobe Analytics的实例化将类似于以下内容:

var adobePrivacy = new AdobePrivacy({
    imsOrgID: "{ORG_ID}",
    reportSuite: "{REPORT_SUITE_ID}",
    trackingServer: "{SERVER_URL}",
    clientCode: "{TARGET_CLIENT_CODE}"
});

有关其他Adobe解决方案支持的参数的完整列表,请参阅附录中有关支持的Adobe解决方案配置参数的部分。

代码示例 samples

以下代码示例演示了如何将Privacy JS Library用于多种常见方案,前提是您未使用标记。

Retrieve identities

此示例演示如何从Experience Cloud检索标识列表。

JavaScript

以下代码定义一个函数handleRetrievedIDs,用作回调或承诺以处理retrieveIdentities检索到的标识。

function handleRetrievedIDs(ids) {
    const validIDs = ids.validIDs;
    const failedIDs = ids.failedIDs;
}

// If using callbacks:
adobePrivacy.retrieveIdentities(handleRetrievedIDs);

// If using promises:
adobePrivacy.retrieveIdentities().then(handleRetrievedIDs);
Variable
描述
validIds
包含已成功检索的所有ID的JSON对象。
failedIDs
包含所有未从Privacy Service中检索的ID的JSON对象,否则将无法找到。

结果

如果代码执行成功,validIDs将填充检索到的标识列表。

{
    "company": "adobe",
    "namespace": "ECID",
    "namespaceId": 4,
    "type": "standard",
    "name": "Experience Cloud ID",
    "description": "This is the ID generated by the ID Service.",
    "value": "79352169365966186342525781172209986543"
},
{
    "company": "adobe",
    "namespace": "gsurfer_id",
    "namespaceId": 411,
    "type": "standard",
    "value": "WqmIJQAAB669Ciao"
}

Remove identities

此示例演示了如何从浏览器中删除标识列表。

JavaScript

以下代码定义了一个函数handleRemovedIDs,该函数用作回调或承诺,以处理removeIdentities从浏览器中删除身份后检索到的身份。

function handleRemovedIDs(ids) {
    const validIDs = ids.validIDs;
    const failedIDs = ids.failedIDs;
}

// If using callbacks:
adobePrivacy.removeIdentities(handleRemovedIDs);

// If using promises:
adobePrivacy.removeIdentities().then(handleRemovedIDs)…
Variable
描述
validIds
包含已成功检索的所有ID的JSON对象。
failedIDs
包含所有未从Privacy Service中检索的ID的JSON对象,否则将无法找到。

结果

如果代码执行成功,validIDs将填充检索到的标识列表。

{
    "company": "adobe",
    "namespace": "ECID",
    "namespaceId": 4,
    "type": "standard",
    "name": "Experience Cloud ID",
    "description": "This is the ID generated by the ID Service.",
    "value": "79352169365966186342525781172209986543",
    "isDeletedClientSide": false
},
{
    "company": "adobe",
    "namespace": "AMO",
    "namespaceId": 411,
    "type": "standard",
    "value": "WqmIJQAAB669Ciao",
    "isDeletedClientSide": true
}

后续步骤

通过阅读本文档,您已了解Privacy JS Library的核心功能。 使用库检索标识列表后,您可以使用这些标识创建对Privacy Service API的数据访问和删除请求。 有关详细信息,请参阅Privacy ServiceAPI指南

附录

本节包含有关使用Privacy JS Library的补充信息。

Adobe解决方案配置参数 config-params

以下是受支持的Adobe解决方案所接受的配置参数列表,在实例化AdobePrivacy对象时使用。

所有解决方案

参数
描述
key
标识用户或数据主体的唯一ID。 此属性仅供您自己的内部跟踪之用,不供Adobe使用。

Adobe Analytics

参数
描述
cookieDomainPeriods
域中用于Cookie跟踪的句点数(默认为2,例如.domain.com)。 除非在JavaScript Web信标中指定,否则不要在此处定义它。
dataCenter

Adobe数据收集数据中心。 仅当在JavaScript Web信标中指定它时,才应包含它。 潜在值包括:

  • d1:圣何塞数据中心
  • d2:达拉斯数据中心
reportSuite
JavaScript Web信标中指定的报表包ID(例如,s_code.jsdtm)。
trackingServer
非SSL数据收集域。 仅当在JavaScript Web信标中指定它时,才应包含它。
trackingServerSecure
SSL数据收集域。 仅当在JavaScript Web信标中指定它时,才应包含它。
visitorNamespace
用于对访客进行分组的命名空间。 仅当在JavaScript Web信标中指定它时,才应包含它。

Adobe Audience Manager

参数
描述
aamUUIDCookieName
包含从Adobe Audience Manager返回的唯一用户ID的第一方Cookie的名称。

Adobe Experience Cloud Identity服务(ECID)

参数
描述
imsOrgID
您的组织ID。

Adobe Target

参数
描述
clientCode
在Adobe Target System中标识客户端的客户端代码。
recommendation-more-help
9cbf7061-a312-49f7-aaf8-a10885d53580