JSON ペイロードを使用したルールアーティファクトのダウンロード、保存、更新

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
APIs/SDKs

作成対象：

開発者

この方法が最適なのは、SDK メソッドを使用するファイルごとに SDK を初期化する必要がある方法でアプリケーションが構造化されている場合です。 Web アプリケーションで SDK の初期化中にルールアーティファクトの JSON ペイロードを使用できるようにするには、JSON ペイロードがダウンロードされ、アプリケーションで使用できることを確認する必要があります。

手順の概要

SDK のインストール
SDK の初期化
JSON ペイロードの保存と使用

1. SDK をインストールする

NPM

npm i @adobe/target-nodejs-sdk -P

MVN

<dependency>
    <groupId>com.adobe.target</groupId>
    <artifactId>java-sdk</artifactId>
    <version>1.0</version>
</dependency>

2. SDK の初期化

まず、SDK を読み込みます。サーバーの起動を制御できるのと同じファイルにを読み込みます。

Node.js

   const TargetClient = require("@adobe/target-nodejs-sdk");

Java

   import com.adobe.target.edge.client.ClientConfig;
import com.adobe.target.edge.client.TargetClient;

SDK を設定するには、create メソッドを使用します。

Node.js

   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

   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);

ここに示すように、Administration/Implementation に移動すると、Adobe Target からクライアントと organizationId の両方を取得できます。

<!— image-client-code.png を挿入 – >

3. JSON ペイロードを保存して rse する

JSON ペイロードの保存に使用するメカニズムは、システムアーキテクチャによって異なります。ローカルファイル、データベース、または Memcached などのメモリオブジェクトキャッシュシステムを使用できます。使用するには、アプリケーションからこの JSON を読み取る必要があります。このガイドでは、ローカルファイルをストレージとして使用します。

Node.js

//... 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

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

JSON ペイロードを介して Adobe TargetSDK を初期化すると、Adobe TargetSDK はルールアーティファクトがダウンロードされるのを待つ必要がなくなるので、サーバーはオンデバイス判定アクティビティで直ちにリクエストを処理できる状態になります。

JSON ペイロード初期化機能の例を次に示します。

Node.js

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

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