DokumentationTarget-Entwicklerhandbuch

Herunterladen, Speichern und Aktualisieren des Regelartefakts über die JSON-Payload

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Entwickler

Dieser Ansatz ist am besten, wenn Ihre Anwendung so strukturiert ist, dass das SDK in jeder Datei initialisiert werden muss, in der SDK-Methoden verwendet werden. Bevor Ihre Webanwendung die JSON-Payload des Regelartefakts während der SDK-Initialisierung verwenden kann, müssen Sie sicherstellen, dass die JSON-Payload heruntergeladen wurde und für Ihre Anwendung verfügbar ist.

Zusammenfassung der Schritte

  1. SDK installieren
  2. Initialisieren des SDK
  3. Speichern und Verwenden der JSON-Payload

1. Installieren des 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. Initialisieren des SDK

  1. Importieren Sie zunächst das SDK. Importieren Sie in dieselbe Datei, von der Sie die Serverstart-Funktion steuern können.

    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. Verwenden Sie zum Konfigurieren des SDK die Methode create .

    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. Sowohl Client als auch organizationId können von Adobe Targetabgerufen werden, indem Sie zu Administration > Implementation navigieren, wie hier dargestellt.

    <!— Fügen Sie image-client-code.png —>
    alt image

3. Speichern und testen Sie die JSON-Payload

Der Mechanismus zum Speichern der JSON-Payload hängt von Ihrer Systemarchitektur ab. Sie können eine lokale Datei, eine Datenbank oder ein Speicherobjektzwischenspeicherungssystem wie Memcached verwenden. Sie müssen in der Lage sein, diese JSON aus Ihrer Anwendung für den Gebrauch zu lesen. In diesem Handbuch verwenden wir eine lokale Datei als Speicher.

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
Durch Initialisierung des Adobe TargetSDK über die JSON-Payload kann Ihr Server Anforderungen sofort mit Entscheidungsaktivitäten auf dem Gerät bereitstellen, da das Adobe TargetSDK nicht warten muss, bis das Regel-Artefakt heruntergeladen wird.

Im Folgenden finden Sie ein Beispiel für die JSON-Funktion zur Payload-Initialisierung.

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