文档Target开发人员指南

通过JSON有效负载下载、存储和更新规则构件

Last update: Thu Jul 27 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined

如果应用程序的结构方式要求SDK在使用SDK方法的每个文件中初始化，则此方法将最为有效。 在SDK初始化期间，Web应用程序可以使用规则工件的JSON有效负载之前，您应确保已下载JSON有效负载并且可供应用程序使用。

步骤摘要

  1. 安装SDK
  2. 初始化SDK
  3. 存储和使用JSON有效负载

1.安装SDK

npm
code language-javascript line-numbers 
npm i @adobe/target-nodejs-sdk -P
MVN
code language-javascript line-numbers 
<dependency>
    <groupId>com.adobe.target</groupId>
    <artifactId>java-sdk</artifactId>
    <version>1.0</version>
</dependency>

2.初始化SDK

  1. 首先，导入SDK。 导入到用于控制服务器启动的同一文件。

    Node.js

    code language-javascript line-numbers 
       const TargetClient = require("@adobe/target-nodejs-sdk");

    Java

    code language-javascript line-numbers 
       import com.adobe.target.edge.client.ClientConfig;
import com.adobe.target.edge.client.TargetClient;

  2. 要配置SDK，请使用创建方法。

    Node.js

    code language-javascript line-numbers 
       const CONFIG = {
    client: "<your target client code>",
    organizationId: "your EC org id",
    decisioningMethod: "on-device",
    pollingInterval : 300000,
    events: {
        artifactDownloadSucceeded: onArtifactDownloadSucceeded,
        artifactDownloadFailed: onArtifactDownloadFailed
    }
};

const TargetClient = TargetClient.create(CONFIG);

function onArtifactDownloadSucceeded(event) {
    //Adobe Target SDK has now downloaded the JSON Artifact/Payload
    console.log(event.artifactLocation) // Location from where the Artifact is downloaded.
    console.log(event.artifactPayload) // JSON Payload which we can store locally.
}

function onArtifactDownloadFailed(event) {
    //Adobe Target SDK has failed to download the JSON Artifact/Payload.
    console.log(event.artifactLocation) // Location from where the Artifact is downloaded.
    console.log(event.error.message) // Error message
}

    Java

    code language-javascript line-numbers 
       package com.adobe.target.edge.client.model.ondevice.OnDeviceDecisioningHandler;

ClientConfig config = ClientConfig.builder()
    .client("<you target client code>")
    .organizationId("<your EC org id>")
    .onDeviceDecisioningHandler(
      new OnDeviceDecisioningHandler() {
        void onDeviceDecisioningReady() {
          // On-Device Decision is ready.
        }
        void artifactDownloadSucceeded(byte[] artifactData) {
          // Store artifactData to local disk.
          // ...
        }
      }
    )
    .build();
TargetClient targetClient = TargetClient.create(config);

  3. 客户端和 organizationId 可以从中检索 Adobe Target导航到 管理 > 实现，如下所示。

    <! — 插入image-client-code.png —>
    替代图像

3.存储和重设JSON有效负载

用于存储JSON有效负载的机制取决于您的系统架构。 您可以使用本地文件、数据库或内存对象缓存系统，如Memcached。 您需要能够从应用程序读取此JSON以供使用。 在本指南中，我们使用本地文件作为存储。

Node.js
code language-javascript line-numbers 
//... Code removed for brevity

function onArtifactDownloadSucceeded(event) {
    const jsonPath = 'src/config/target-rules.json'
    fs.writeFile(jsonPath, JSON.stringify(event.artifactPayload), 'utf8', (err) => {
        if (err) {
            throw err;
        };
        console.log(`The artifact from '${event.artifactLocation}' is now saved to '${jsonPath}'`);
    });
}


function onArtifactDownloadFailed(event) {
  console.log(`The local decisioning artifact failed to download from '${event.artifactLocation}' with the following error message: ${event.error.message}`);
}

//... Code removed for brevity
Java
code language-javascript line-numbers 
MboxRequest mbox = new MboxRequest().name("homepage").index(0);
TargetDeliveryRequest request = TargetDeliveryRequest.builder()
    .context(new Context().channel(ChannelType.WEB))
    .execute(new ExecuteRequest().mboxes(Arrays.asList(mbox)))
    .build();
TargetDeliveryResponse response = targetClient.getOffers(request);
NOTE
通过初始化 Adobe Target通过JSON有效负载的SDK，您的服务器可以立即为设备上决策活动提供请求，因为 Adobe TargetSDK无需等待规则工件被下载。

以下示例演示了JSON有效负载初始化功能。

Node.js
code language-javascript line-numbers 
const express = require("express");
const cookieParser = require("cookie-parser");
const TargetClient = require("@adobe/target-nodejs-sdk");
const CONFIG = {
    client: "<your target client code>",
    organizationId: "your EC org id",
    decisioningMethod: "on-device",
    pollingInterval : 300000,
    events: {
        clientReady : startWebServer,
        artifactDownloadSucceeded : onArtifactDownloadSucceeded,
        artifactDownloadFailed : onArtifactDownloadFailed
    },
};

function onArtifactDownloadSucceeded(event) {
    const jsonPath = 'src/config/target-rules.json'
    fs.writeFile(jsonPath, JSON.stringify(event.artifactPayload), 'utf8', (err) => {
        if (err) {
            throw err;
        };
        console.log(`The artifact from '${event.artifactLocation}' is now saved to '${jsonPath}'`);
    });
}

function onArtifactDownloadFailed(event) {
  console.log(`The on-device decisioning artifact failed to download from '${event.artifactLocation}' with the following error message: ${event.error.message}`);
}

const app = express();
const targetClient = TargetClient.create(CONFIG);

app.use(cookieParser());

function saveCookie(res, cookie) {
  if (!cookie) {
    return;
  }

  res.cookie(cookie.name, cookie.value, {maxAge: cookie.maxAge * 1000});
}

const getResponseHeaders = () => ({
  "Content-Type": "text/html",
  "Expires": new Date().toUTCString()
});

function sendSuccessResponse(res, response) {
  res.set(getResponseHeaders());
  saveCookie(res, response.targetCookie);
  res.status(200).send(response);
}

function sendErrorResponse(res, error) {
  res.set(getResponseHeaders());
  res.status(500).send(error);
}

function startWebServer() {
    app.get('/*', async (req, res) => {
    const targetCookie = req.cookies[TargetClient.TargetCookieName];
    const request = {
        execute: {
        mboxes: [{
            address: { url: req.headers.host + req.originalUrl },
            name: "on-device-homepage-banner" // Ensure that you have a LIVE Activity running on this location
        }]
        }};

    try {
        const response = await targetClient.getOffers({ request, targetCookie });
        sendSuccessResponse(res, response);
    } catch (error) {
        console.error("Target:", error);
        sendErrorResponse(res, error);
    }
    });

    app.listen(3000, function () {
    console.log("Listening on port 3000 and watching!");
    });
}
Java
code language-javascript line-numbers 
import com.adobe.target.edge.client.ClientConfig;
import com.adobe.target.edge.client.TargetClient;
import com.adobe.target.delivery.v1.model.ChannelType;
import com.adobe.target.delivery.v1.model.Context;
import com.adobe.target.delivery.v1.model.ExecuteRequest;
import com.adobe.target.delivery.v1.model.MboxRequest;
import com.adobe.target.edge.client.entities.TargetDeliveryRequest;
import com.adobe.target.edge.client.model.TargetDeliveryResponse;

@Controller
public class TargetController {

  private TargetClient targetClient;

  TargetController() {
    // You should instantiate TargetClient in a Bean and inject the instance into this class
    // but we show the code here for demonstration purpose.
    ClientConfig config = ClientConfig.builder()
        .client("<you target client code>")
        .organizationId("<your EC org id>")
        .onDeviceDecisioningHandler(
          new OnDeviceDecisioningHandler() {
            void onDeviceDecisioningReady() {
              // On-Device Decision is ready.
            }
            void artifactDownloadSucceeded(byte[] artifactData) {
              // Store artifactData to local disk.
              // ...
            }
          }
        )
        .build();
    targetClient = TargetClient.create(config);
  }

  @GetMapping("/")
  public String homePage() {
    MboxRequest mbox = new MboxRequest().name("homepage").index(0);
    TargetDeliveryRequest request = TargetDeliveryRequest.builder()
        .context(new Context().channel(ChannelType.WEB))
        .execute(new ExecuteRequest().mboxes(Arrays.asList(mbox)))
        .build();
    TargetDeliveryResponse response = targetClient.getOffers(request);
    // ...
  }
}
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3