targetGlobalSettings()

Last update: Wed Dec 13 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
at.js

创建对象：

Developer

您可以使用覆盖at.js库中的设置 targetGlobalSettings()，而不是在中配置它们 Target 用户界面或使用REST API。

设置

您可以覆盖以下设置：

aepSandboxId

类型：字符串
默认值：空
描述：用于发送的可选参数 Adobe Experience Platform 要共享的沙盒ID Adobe Experience Platform 在非默认沙盒中创建的目标 Target. 如果 aepSandboxId 为非null， aepSandboxName 还必须提供。

aepSandboxName

类型：字符串
默认值：空
描述：用于发送的可选参数 Adobe Experience Platform 要共享的沙盒名称 Adobe Experience Platform 在非默认沙盒中创建的目标 Target. 如果 aepSandboxName 为非null， aepSandboxId 还必须提供。

artifectlocation

类型：字符串
默认值：无
描述：指向的完全限定url 设备上决策规则构件

bodyHiddenStyle

类型：字符串
默认值：正文
描述：仅在以下情况下使用 globalMboxAutocreate === true 以尽可能减少闪烁的可能性。

有关更多信息，请参阅 at.js如何管理闪烁.

bodyHidingEnabled

类型：布尔型
默认值： true
描述：用于控制闪烁 target-global-mbox 用于提供在可视化体验编辑器中创建的选件，也称为可视化选件。

clientCode

类型：字符串
默认值：通过UI设置的值。
描述：表示客户端代码。

cookieDomain

类型：字符串
默认值：如果可能，设置为顶级域。
描述：表示保存Cookie时使用的域。

crossDomain

类型：字符串
默认值：通过UI设置的值。
描述：指示是否启用跨域跟踪。允许的值取决于您的at.js版本。对于at.js v1.x，指定跨域功能是否 disabled (浏览器在您的域中设置Cookie（仅限第一方Cookie）)， x only (浏览器在中设置Cookie Target（仅限的域），或同时选择两者 enabled （浏览器同时设置第一方和第三方Cookie）。对于at.js v2.10及更高版本，指定跨域功能是否 enabled （浏览器同时设置第一方和第三方Cookie）或 disabled （浏览器不设置第三方Cookie）。

cspScriptNonce

类型：请参阅内容安全策略下。
默认值：请参阅内容安全策略下。
描述：请参阅内容安全策略下。

cspStyleNonce

类型：请参阅内容安全策略下。
默认值：请参阅内容安全策略下。
描述：请参阅内容安全策略下。

dataProviders

类型：请参阅数据提供程序下。
默认值：请参阅数据提供程序下。
描述：请参阅数据提供程序下。

决策方法

类型：字符串
默认值：服务器端
其他值：设备端、混合
描述：请参阅下面的决策方法。

决策方法

通过设备上决策， Target 引入了一个名为“决策方法”的新设置，用于指示at.js如何交付您的体验。此 decisioningMethod 具有三个值：仅限服务器端、仅限设备上和混合。时间 decisioningMethod 在中设置 targetGlobalSettings()，它充当所有用户的默认决策方法 Target 决策。

仅服务器端：

仅服务器端是默认的决策方法，当在Web资产上实施和部署at.js 2.5及更高版本时，此方法为现成可用的。

仅将服务器端用作默认配置意味着所有决策都是在 Target 边缘网络，它涉及阻止服务器调用。此方法可能会增加延迟，但它也会带来显着好处，例如让您能够应用 Target的机器学习功能包括 Recommendations， Automated Personalization (AP)，和自动定位活动。

此外，通过使用以下方式增强您的个性化体验 Target的用户配置文件（跨会话和渠道持久保留）可为您的业务带来强大的成果。

最后，服务器端仅允许您使用Adobe Experience Cloud并微调可通过Audience Manager和Adobe Analytics区段定位的受众。

仅限设备端：

“仅限设备端”是必须在at.js 2.5及更高版本中设置的决策方法，而“设备端”决策只能在整个网页中使用。

设备上决策能够以惊人的速度提供您的体验和个性化活动，因为决策是由缓存的规则工件做出的，该工件包含您所有符合设备上决策资格的活动。

要详细了解哪些活动符合设备上决策的条件，请参阅受支持的功能部分。

仅当所有需要决策页面的性能都非常关键时，才应使用此决策方法 Target. 此外，请记住，选择此决策方法后，您的 Target 不符合设备上决策资格的活动将不会交付或执行。 at.js库2.5及更高版本配置为仅查找缓存的规则工件以做出决策。

混合：

混合决策方法必须在at.js 2.5及更高版本中设置，如果设备上决策和活动都需要网络调用，则 Adobe Target 必须执行Edge network。

当您同时管理设备上决策活动和服务器端活动时，在考虑如何部署和配置时可能会有点复杂和繁琐 Target 页面上。混合决策方法， Target 知道何时必须对进行服务器调用 Adobe Target Edge Network用于需要服务器端执行的活动，以及何时只执行设备端决策。

JSON规则工件包含元数据，用于通知at.js mbox是正在运行的服务器端活动还是设备上决策活动。这种决策方法可确保通过设备上决策快速完成您想要交付的活动，并且对于需要更强大的ML驱动型个性化的活动，这些活动会通过 Adobe Target 边缘网络。

defaultContentHiddenStyle

类型：字符串
默认值：可见性：隐藏
描述：仅用于封装使用类名为“mboxDefault”的DIV且通过执行的mbox mboxCreate()， mboxUpdate()，或 mboxDefine() 以隐藏默认内容。

defaultContentVisibleStyle

类型：字符串
默认值：可见性：可见
描述：仅用于封装使用类名为“mboxDefault”的DIV且通过执行的mbox mboxCreate()， mboxUpdate()，或 mboxDefine() 用于显示应用的选件（如果有）或默认内容。

deviceIdLifetime

类型：数字
默认值：63244800000毫秒= 2年
描述：时间量 deviceId 保留在Cookie中。

NOTE

deviceIdLifetime设置可在at.js版本2.3.1或更高版本中覆盖。

已启用

类型：布尔型
默认值： true
描述：启用时，使用 Target 检索体验的请求和渲染体验的DOM操作会自动执行。此外， Target 可以通过手动执行调用 getOffer(s) / applyOffer(s).

禁用后， Target 不会自动或手动执行请求。

globalMboxAutoCreate

类型：数字
默认值：通过UI设置的值。
描述：指示是否应触发全局mbox请求。

imsOrgId

类型：字符串
默认值： true
描述：表示IMS组织ID。

optinEnabled

类型：布尔型
默认值： false
描述： Target 通过Adobe Experience Platform提供选择加入功能支持，以协助支持您的同意管理策略。选择加入功能让客户可自行决定如何以及何时触发 Target 标记。还有一个选项，即通过Adobe Experience Platform预批准 Target 标记之前。启用在中使用选择加入的功能 Target at.js库，添加 optinEnabled=true 设置。在Adobe Experience Platform中，您必须从扩展安装视图的GDPR选择加入下拉列表中选择“启用”。请参阅 Adobe Experience Platform文档以了解更多详细信息。有关此设置在隐私和数据保护法规(包括欧盟的《通用数据保护条例》(GDPR)和《加州消费者隐私法案》(CCPA))方面的更多信息，请参阅隐私和数据保护法规.

optoutEnabled

类型：布尔型
默认值： false
描述：指示是否 Target 应调用访客API isOptedOut() 函数。这是启动设备图形的一部分。

overrideMboxEdgeServer

类型：布尔型
默认值： true（从at.js版本1.6.2开始为true）
描述：指示我们是否应该使用 <clientCode>.tt.omtrdc.net 域或 mboxedge<clusterNumber>.tt.omtrdc.net 域。

如果此值为true， mboxedge<clusterNumber>.tt.omtrdc.net 域将被保存到Cookie中。当前未使用 CNAME 使用at.js 1.8.2和at.js 2.3.1之前的at.js版本时。如果您遇到问题，请考虑更新at.js 更新为支持的版本。

overrideMboxEdgeServerTimeout

类型：数字
默认值：1860000 => 31分钟
描述：指示包含的Cookie生命周期 mboxedge<clusterNumber>.tt.omtrdc.net 值。

pageloadenabled

类型：布尔型
默认值： true
描述：启用后，会自动检索在页面加载时必须返回的体验。

pollingInterval

类型：数字
默认值：300000（以毫秒为单位的五分钟）
描述：at.js获取设备上决策构件新版本并更新缓存的时间间隔。 300000是允许的最小值 pollingInterval.

secureOnly

类型：布尔型
默认值： false
描述：指示at.js是应仅使用HTTPS，还是可以根据页面协议在HTTP和HTTPS之间进行切换。当设置为true时，secureOnly还会将Secure和SameSite属性设置为mbox Cookie。

selectorsPollingTimeout

类型：数字
默认值：5000毫秒= 5秒
描述：在at.js 0.9.6中， Target 引入了这项新设置，可以通过覆盖此设置 targetGlobalSettings.

此 selectorsPollingTimeout 设置表示客户端愿意等待多长时间，让选择器标识的所有元素都显示在页面上。

通过可视化体验编辑器 (VEC) 创建的活动具有包含选择器的选件。

serverDomain

类型：字符串
默认值：通过UI设置的值。
描述：表示 Target 边缘服务器。

serverState

类型：请参阅混合个性化下。
默认值：请参阅混合个性化下。
描述：请参阅混合个性化下。

telemetryEnable

类型：布尔型
默认值： true
描述：启用后，Adobe将收集SDK功能使用情况和性能遥测数据。不收集个人数据。

timeout

类型：数字
默认值：通过UI设置的值。
描述：表示 Target 边缘请求超时。

viewsenabled viewsenabled

类型：布尔型
默认值： true
描述：启用后，将在页面加载时自动检索视图。时间 triggerView 调用，浏览器中会显示适用的视图。如果禁用此选项，则在页面加载时不会检索视图，并且 triggerView 什么也不做。 at.js 2.x。

visitorApiTimeout

类型：数字
默认值：2000毫秒= 2秒
描述：表示访客API请求超时。

使用情况

此函数可在加载at.js之前或在以下位置定义：管理 > 实现 > 编辑at.js设置 > 代码设置 > 库标题.

“库标头”字段允许您输入自由格式的 JavaScript。自定义代码应与以下示例类似：

window.targetGlobalSettings = {
   timeout: 200, // using custom timeout
   visitorApiTimeout: 500, // using custom API timeout
   enabled: document.location.href.indexOf('https://www.adobe.com') >= 0 // enabled ONLY on adobe.com
};

数据提供程序 data-providers

通过此设置，客户可以从第三方数据提供商（如Demandbase、BlueKai和自定义服务）收集数据，并将这些数据传递到 Target 作为mbox参数。支持通过异步和同步请求从多个提供程序收集数据。使用这种方法可以轻松管理默认页面内容的闪烁，同时包含每个提供程序的独立超时时间以限制对页面性能的影响

NOTE

数据提供程序需要使用at.js 1.3或更高版本。

以下视频包含更多信息：

视频

描述

在 Adobe Target 中使用数据提供程序

数据提供程序是一项功能，允许您轻松地将数据从第三方传递到 Target。第三方可以是气象服务、DMP，甚至是您自己的 Web 服务。然后，您可以使用这些数据来构建受众、定位内容并丰富访客配置文件。

在 Adobe Target 中实施数据提供程序

实施详细信息以及如何使用Adobe的示例 Target的dataProviders功能，用于从第三方数据提供程序检索数据，并将其传递到 Target 请求。

window.targetGlobalSettings.dataProviders 设置是一个数据提供程序数组。

每个数据提供程序具有以下结构：

键值

类型

描述

name

字符串

提供程序的名称。

version

字符串

提供程序版本。此键值将用于提供程序的版本演变。

timeout

数值

如果这是网络请求，则表示提供程序超时。此键值是可选的。

provider

函数

包含提供程序数据提取逻辑的函数。

函数有一个必需的参数： callback. callback 参数是一个函数，只有在成功获取数据或发生错误时才应调用该函数。

callback 应有两个参数：

error：指示是否发生错误。如果一切正常，则应将此参数设置为空。
params：一个JSON对象，表示将在 Target 请求。

以下示例显示数据提供程序使用同步执行的位置：

var syncDataProvider = {
  name: "simpleDataProvider",
  version: "1.0.0",
  provider: function(callback) {
    callback(null, {t1: 1});
  }
};

window.targetGlobalSettings = {
  dataProviders: [
    syncDataProvider
  ]
};

在at.js处理之后 window.targetGlobalSettings.dataProviders， Target 请求将包含一个新参数： t1=1.

如果要添加到中的参数，以下是示例 Target 请求是从第三方服务中获取的，例如Bluekai、Demandbase等：

var blueKaiDataProvider = {
   name: "blueKai",
   version: "1.0.0",
   provider: function(callback) {
      // simulating network request
     setTimeout(function() {
       callback(null, {t1: 1, t2: 2, t3: 3});
     }, 1000);
   }
}

window.targetGlobalSettings = {
   dataProviders: [
      blueKaiDataProvider
   ]
};

在at.js处理之后 window.targetGlobalSettings.dataProviders， Target 请求将包含其他参数： t1=1， t2=2 和 t3=3.

以下示例使用数据提供程序收集天气API数据，并将其作为参数发送到 Target 请求。此 Target 请求将具有其他参数，例如 country 和 weatherCondition.

var weatherProvider = {
      name: "weather-api",
      version: "1.0.0",
      timeout: 2000,
      provider: function(callback) {
        var API_KEY = "caa84fc6f5dc77b6372d2570458b8699";
        var lat = 44.426767399999996;
        var lon = 26.1025384;
        var url = "//api.openweathermap.org/data/2.5/weather?";
        var data = {
          lat: lat,
          lon: lon,
          appId: API_KEY
        }

        $.ajax({
          type: "GET",
                url: url,
          dataType: "json",
          data: data,
          success: function(data) {
            console.log("Weather data", data);
            callback(null, {
              country: data.sys.country,
              weatherCondition: data.weather[0].main
            });
          },
          error: function(err) {
            console.log("Error", err);
            callback(err);
          }
        });
      }
    };

    window.targetGlobalSettings = {
      dataProviders: [weatherProvider]
    };

使用 dataProviders 设置时请考虑以下事项：

如果数据提供程序异步添加到 window.targetGlobalSettings.dataProviders，则将并行执行。访客 API 请求将与添加到 window.targetGlobalSettings.dataProviders 的函数并行执行，以将等待时间最小化。
at.js 不会尝试缓存数据。如果数据提供程序仅提取一次数据，则应确保数据已缓存，并且在调用提供程序函数时为第二次调用提供缓存的数据。

内容安全策略

at.js 2.3.0及更高版本支持在应用交付时，在附加到页面DOM的SCRIPT和STYLE标记上设置内容安全策略nonce Target 选件。

SCRIPT和STYLE nonce应设置为 targetGlobalSettings.cspScriptNonce 和 targetGlobalSettings.cspStyleNonce 相应地，在加载at.js 2.3.0和更高版本之前。请参阅以下示例：

...
<head>
 <script nonce="<script_nonce_value>">
window.targetGlobalSettings = {
  cspScriptNonce: "<csp_script_nonce_value>",
  cspStyleNonce: "<csp_style_nonce_value>"
};
 </script>
 <script nonce="<script_nonce_value>" src="at.js"></script>
...
</head>
...

之后 cspScriptNonce 和 cspStyleNonce 指定设置后，at.js 2.3.0及更高版本会在应用时附加到DOM的所有SCRIPT和STYLE标记上将它们设置为nonce属性 Target 选件。

混合个性化

serverState 是at.js 2.2和更高版本中提供的设置，当对进行混合集成时，可以使用该设置优化页面性能 Target 已实施。混合集成意味着您在客户端上同时使用at.js 2.2和更高版本，以及交付API或 Target 用于交付体验的服务器端上的SDK。 serverState 让 at.js 2.2 和更高版本可直接从在服务器端获取并作为所提供的页面的一部分返回客户端的内容应用体验。

先决条件

您必须对以下对象进行混合集成 Target.

服务器端：您必须使用投放API 或 Target SDK.
客户端：您必须使用 at.js版本2.2或更高版本.

代码示例

要更好地了解其工作方式，请查看以下您在服务器上具有的代码示例。此代码假定您使用的是 Target Node.js SDK.

// First, we fetch the offers via Target Node.js SDK API, as usual
const targetResponse = await targetClient.getOffers(options);
// A successfull response will contain Target Delivery API request and response objects, which we need to set as serverState
const serverState = {
  request: targetResponse.request,
  response: targetResponse.response
};
// Finally, we should set window.targetGlobalSettings.serverState in the returned page, by replacing it in a page template, for example
const PAGE_TEMPLATE = `
<!doctype html>
<html>
<head>
  ...
  <script>
    window.targetGlobalSettings = {
      overrideMboxEdgeServer: true,
      serverState: ${JSON.stringify(serverState, null, " ")}
    };
  </script>
  <script src="at.js"></script>
</head>
...
</html>
`;
// Return PAGE_TEMPLATE to the client ...

示例 serverState 用于视图预取的对象JSON如下所示：

{
 "request": {
  "requestId": "076ace1cd3624048bae1ced1f9e0c536",
  "id": {
   "tntId": "08210e2d751a44779b8313e2d2692b96.21_27"
  },
  "context": {
   "channel": "web",
   "timeOffsetInMinutes": 0
  },
  "experienceCloud": {
   "analytics": {
    "logging": "server_side",
    "supplementalDataId": "7D3AA246CC99FD7F-1B3DD2E75595498E"
   }
  },
  "prefetch": {
   "views": [
    {
     "address": {
      "url": "my.testsite.com/"
     }
    }
   ]
  }
 },
 "response": {
  "status": 200,
  "requestId": "076ace1cd3624048bae1ced1f9e0c536",
  "id": {
   "tntId": "08210e2d751a44779b8313e2d2692b96.21_27"
  },
  "client": "testclient",
  "edgeHost": "mboxedge21.tt.omtrdc.net",
  "prefetch": {
   "views": [
    {
     "name": "home",
     "key": "home",
     "options": [
      {
       "type": "actions",
       "content": [
        {
         "type": "setHtml",
         "selector": "#app > DIV.app-container:eq(0) > DIV.page-container:eq(0) > DIV:nth-of-type(2) > SECTION.section:eq(0) > DIV.container:eq(1) > DIV.heading:eq(0) > H1.title:eq(0)",
         "cssSelector": "#app > DIV:nth-of-type(1) > DIV:nth-of-type(1) > DIV:nth-of-type(2) > SECTION:nth-of-type(1) > DIV:nth-of-type(2) > DIV:nth-of-type(1) > H1:nth-of-type(1)",
         "content": "<span style=\"color:#FF0000;\">Latest</span> Products for 2020"
        }
       ],
       "eventToken": "t0FRvoWosOqHmYL5G18QCZNWHtnQtQrJfmRrQugEa2qCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q==",
       "responseTokens": {
        "profile.memberlevel": "0",
        "geo.city": "dublin",
        "activity.id": "302740",
        "experience.name": "Experience B",
        "geo.country": "ireland"
       }
      }
     ],
     "state": "J+W1Fq18hxliDDJonTPfV0S+mzxapAO3d14M43EsM9f12A6QaqL+E3XKkRFlmq9U"
    }
   ]
  }
 }
}

将页面加载到浏览器中后，at.js将应用所有 Target 优惠来源 serverState 立即，不触发任何针对 Target 边缘。此外，at.js只会预先隐藏针对其 Target 在内容获取的服务器端提供了选件，从而积极地影响页面加载性能和最终用户体验。

重要说明

使用时，请考虑以下事项 serverState：

目前，at.js v2.2仅支持通过serverState为以下对象交付体验：
- VEC创建的活动，在页面加载时执行。
- 预获取的视图。
  
  如果SPA使用 Target 视图和 triggerView() 在at.js API中，at.js v2.2会缓存在服务器端预取的所有视图的内容，并在通过触发每个视图后立即应用这些内容 triggerView()，无需触发任何其他内容提取调用 Target.
- 注意：目前，不支持在服务器端检索的mbox serverState.
应用时 serverState 选件，at.js会考虑 pageLoadEnabled 和 viewsEnabled 设置，例如页面加载选件，如果 pageLoadEnabled 设置为false。

要打开这些设置，请启用切换功能 管理>实施>编辑>已启用页面加载.
如果您使用 serverState 和使用 <script> 标记时，请确保您的HTML内容使用 <\/script> 而不是 </script>. 如果您使用 </script>，则浏览器会解译 </script> 作为内联SCRIPT的结尾，它可能会破坏HTML页面。

其他资源

要了解更多信息，如何 serverState 有效，请查看以下资源：

recommendation-more-help

6906415f-169c-422b-89d3-7118e147c4e3