安装SDK

有三种受支持的方法可以使用Adobe Experience Platform Web SDK：

  1. 首选使用Adobe Experience Platform Web SDK的方法是通过数据收集UI或Experience PlatformUI。
  2. Adobe Experience Platform Web SDK还可在内容交付网络(CDN)上使用。
  3. 使用导出EcmaScript 5和EcmaScript 2015 (ES6)模块的NPM库。

选项1：安装标记扩展

有关标记扩展的文档，请参阅 标记文档

选项2：安装预建的独立版本

CDN上提供了预建版本。 您可以直接在页面上的CDN上引用库，也可以将其下载并托管在您自己的基础架构上。 它以缩小和未缩小的格式提供。 未缩小的版本有助于进行调试。

URL结构： https://cdn1.adoberesources.net/alloy/[版本]非缩小版本的/alloy.min.js或alloy.js。

例如：

添加代码

预建的独立版本要求直接将一个“基础代码”添加到页面中。 将以下“基本代码”复制并粘贴到尽可能高的位置 <head> HTML的标记：

<script>
  !function(n,o){o.forEach(function(o){n[o]||((n.__alloyNS=n.__alloyNS||
  []).push(o),n[o]=function(){var u=arguments;return new Promise(
  function(i,l){n[o].q.push([i,l,u])})},n[o].q=[])})}
  (window,["alloy"]);
</script>
<script src="https://cdn1.adoberesources.net/alloy/2.14.0/alloy.min.js" async></script>

“基础代码”创建一个名为的全局函数 alloy. 使用此函数与SDK进行交互。 如果要将全局函数命名为其他名称，请更改 alloy 名称，如下所示：

<script>
  !function(n,o){o.forEach(function(o){n[o]||((n.__alloyNS=n.__alloyNS||
  []).push(o),n[o]=function(){var u=arguments;return new Promise(
  function(i,l){n[o].q.push([i,l,u])})},n[o].q=[])})}
  (window,["mycustomname"]);
</script>
<script src="https://cdn1.adoberesources.net/alloy/2.14.0/alloy.min.js" async></script>

在此示例中，将重命名全局函数 mycustomname，而不是 alloy.

重要

要避免出现潜在问题，请使用至少包含一个非数字字符且不会与上已存在的属性名称冲突的名称 window.

此基础代码除了创建全局函数之外，还加载外部文件中包含的其他代码(alloy.js)托管在服务器上。 默认情况下，将异步加载此代码，以使您的网页尽可能高性能。 这是推荐的实施。

支持Internet Explorer

此SDK使用promise ，这是一种通信异步任务完成情况的方法。 此 承诺 除以下内容外，所有Target浏览器均本机支持SDK使用的实施 Internet Explorer. 要在以下位置使用SDK： Internet Explorer，您必须拥有 window.Promise 多填充.

以确定您是否已 window.Promise 复合：

  1. 在中打开您的网站 Internet Explorer.
  2. 打开浏览器的调试控制台。
  3. 类型 window.Promise 进入控制台，然后按Enter。

如果 undefined 显示，您可能已经复合 window.Promise. 确定是否 window.Promise ，方法是在完成上述安装说明后加载您的网站。 如果SDK抛出错误，提及有关promise的内容，则您可能没有进行复合 window.Promise.

如果您已确定，则必须进行多边形填充 window.Promise，请在之前提供的基础代码上方包含以下脚本标记：

<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.min.js"></script>

此标记加载一个脚本，用于确保 window.Promise 是有效的Promise实施。

注意

如果选择加载其他Promise实施，请确保该实施支持 Promise.prototype.finally.

同步加载JavaScript文件

如一节中所述 添加代码，您复制并粘贴到网站HTML中的基础代码将加载外部文件。 外部文件包含SDK的核心功能。 在此文件加载时尝试执行的任何命令都会排入队列，然后在文件加载后进行处理。 异步加载文件是性能最佳的安装方法。

但是，在某些情况下，您可能希望同步加载文件\（稍后将记录有关这些情况的更多详细信息\）。 此操作会阻止浏览器解析和渲染HTML文档的其余部分，直到加载和执行外部文件为止。 通常建议不要在向用户显示主要内容之前再延迟一次，但根据具体情况，这样做可能会有意义。

要以同步方式而不是异步方式加载文件，请删除 async 属性来自第二个 script 标记如下所示：

<script>
  !function(n,o){o.forEach(function(o){n[o]||((n.__alloyNS=n.__alloyNS||
  []).push(o),n[o]=function(){var u=arguments;return new Promise(
  function(i,l){n[o].q.push([i,l,u])})},n[o].q=[])})}
  (window,["alloy"]);
</script>
<script src="https://cdn1.adoberesources.net/alloy/2.14.0/alloy.min.js"></script>

选项3：使用NPM包

Adobe Experience Platform Web SDK还作为NPM包提供。 NPM 是JavaScript的包管理器。 通过安装NPM包，您可以控制Adobe Experience Platform Web SDK JavaScript的构建过程。 NPM包会公开应在浏览器中运行的EcmaScript版本5模块或EcmaScript版本2015 (ES6)模块。

npm install @adobe/alloy

Adobe Experience Platform Web SDK的NPM包会公开 createInstance 函数。 此函数用于创建实例。 传递到函数的name选项可控制日志记录中使用的前缀。 以下是使用该包的示例。

将软件包用作ECMAScript 2015 (ES6)模块

import { createInstance } from "@adobe/alloy";
const alloy = createInstance({ name: "alloy" });
alloy("config", { ... });
alloy("sendEvent", { ... });
注意

NPM包依赖于CommonJS模块；因此，在使用捆绑程序时，请确保捆绑程序支持CommonJS模块。 一些捆绑包，例如 汇总，需要 插件 提供CommonJS支持。

将软件包用作ECMAScript 5模块

var alloyLibrary = require("@adobe/alloy");
var alloy = alloyLibrary.createInstance({ name: "alloy" });
alloy("config", { ... });
alloy("sendEvent", { ... });

支持Internet Explorer

Adobe Experience Platform SDK使用promise ，这是一种通信异步任务完成情况的方法。 此 承诺 除以下内容外，所有Target浏览器均本机支持SDK使用的实施 Internet Explorer. 要在以下位置使用SDK： Internet Explorer，您必须拥有 window.Promise 多填充.

一个可用来填充promise的库是promise-polyfill。 请参阅 promise-polyfill文档 有关如何使用NPM安装的更多信息。

注意

如果选择加载其他Promise实施，请确保该实施支持 Promise.prototype.finally.

在此页面上