adobe.target.sendNotifications(options)
Erstellt für:
- Entwickler
Diese Funktion sendet eine Benachrichtigung an Target Edge, wenn ein Erlebnis ohne Verwendung von adobe.target.applyOffer()
oder adobe.target.applyOffers()
gerendert wird.
Schlüssel | Typ | Erforderlich? | Beschreibung |
---|---|---|---|
consumerId | Zeichenfolge | Nein | Der Standardwert ist die globale Mbox des Kunden, falls nicht angegeben. Dieser Schlüssel wird verwendet, um die ID für zusätzliche Daten zu generieren, die für die A4T-Integration verwendet wird. |
Anfrage | Objekt | Ja | Siehe Anforderungstabelle unten. |
Zeitüberschreitung | Nummer | Nein | Zeitüberschreitung der Abfrage. Wenn nicht angegeben, wird die standardmäßige at.js-Zeitüberschreitung verwendet. |
Anfrage
Feldname | Typ | Erforderlich? | Einschränkung | Beschreibung |
---|---|---|---|---|
Request > notifications | Array von Objekten | Ja | Benachrichtigungen für den angezeigten Inhalt, angeklickte Selektoren und/oder besuchte Ansichten oder Mboxes. | |
Request > notifications > address | Objekt | Nein | ||
Request > notifications > address > url | Zeichenfolge | Nein | URL, über die die Benachrichtigung ausgelöst wurde. | |
Request > notifications > address > referringUrl | Zeichenfolge | Nein | Die Referenz-URL, über die die Benachrichtigung ausgelöst wurde. | |
Request > notifications > parameters | Zeichenfolge | Nein |
Die folgenden Namen sind für Parameter nicht zulässig:
Beachten Sie Folgendes:
| |
Request > notifications > profileParameters | Zeichenfolge | Nein |
Die folgenden Namen sind für Parameter nicht zulässig:
Beachten Sie Folgendes:
| |
Request > notifications > order | Objekt | Nein | Objekt, das die Bestelldetails beschreibt. | |
Request > notifications > order
| Zeichenfolge | Nein | <= 250 Zeichen. | Bestell-ID. |
Request > notifications > order
| Zeichenfolge | Nein | >= 0 | Bestellsumme. |
Request > notifications > order
| Zeichenfolgen-Array | Nein |
| Bestellprodukt-IDs. |
Request > notifications > product | Objekt | Nein | ||
Request > notifications > product > id | Zeichenfolge | Nein | <= 128 Zeichen; darf nicht leer sein. | Produkt-ID. |
Request > notifications > product > categoryId | Zeichenfolge | Nein | <= 128 Zeichen; darf nicht leer sein. | Kategorie-ID. |
Request > notifications > id | Zeichenfolge | Ja | <= 200 Zeichen. | Die Benachrichtigungs-ID wird in der Antwort zurückgegeben und gibt an, dass die Benachrichtigung erfolgreich verarbeitet wurde. |
Request > notifications > impressionId | Zeichenfolge | Nein | <= 128 Zeichen. | Die Impressions-ID wird verwendet, um die aktuelle Benachrichtigung mit einer vorherigen Benachrichtigung oder Ausführungsanforderung zu verknüpfen. Stimmen beide überein, generieren die zweite sowie andere nachfolgende Anforderungen keine neue Impression für die Aktivität oder das Erlebnis. |
Anforderung > Benachrichtigungen > Typ | Zeichenfolge | Ja | „Klick“ oder „Anzeige“ wird unterstützt. | Benachrichtigungstyp. |
Request > notifications > timestamp | Nummer<int64> | Ja | Zeitstempel der Benachrichtigung in Millisekunden, die seit Beginn der UNIX-Epoche verstrichen sind. | |
Request > notifications > tokens | Zeichenfolgen-Array | Ja | Eine Liste der Token für angezeigte Inhalte oder angeklickte Selektoren basierend auf dem Typ der Benachrichtigung. | |
Request > notifications > mbox | Objekt | Nein | Benachrichtigungen für die Mbox. | |
Request > notifications > mbox
| Zeichenfolge | Nein |
Keine leeren Werte zulässig. Zulässige Zeichen: Siehe Hinweis in dieser Tabelle. | Name der Mbox. |
Request > notifications > mbox
| Zeichenfolge | Nein | Mbox-Statustoken. | |
Request > notifications > view | Objekt | Nein | ||
Request > notifications > view
| Ganzzahl <int64> | Nein | Ansicht-ID Die ID, die der Ansicht zugewiesen wurde, als die Ansicht über die Ansicht-API erstellt wurde. | |
Request > notifications > view
| Zeichenfolge | Nein | <= 128 Zeichen | Name der Ansicht. |
Request > notifications > view
| Zeichenfolge | Nein | <= 512 Zeichen. | Ansichtsschlüssel. Der Schlüssel, der mit der Ansicht über die API festgelegt wurde. |
Request > notifications > view
| Zeichenfolge | Nein | Token für den Ansichtsstatus. |
Hinweis: Die folgenden Zeichen sind nicht für Request > notifications > mbox > name
zulässig:
- '-, ./=`:;&!@#$%^&*()+|?~[]{}'
sendNotifications()-Aufruf nach dem Rendern vorgeladener Mboxes
function createTokens(options) {
return options.map(e => e.eventToken);
}
function createNotification(mbox, type, tokens) {
const id = 11111; // here we should use a random ID like UUID
const timestamp = Date.now();
const { name, state, parameters, profileParameters, order, product } = mbox;
const result = {
id,
type,
timestamp,
parameters,
profileParameters,
order,
product
};
result.mbox = { name, state };
result.tokens = tokens;
return result;
}
adobe.target.getOffers({
request: {
prefetch: {
mboxes: [
{
index: 0,
name: "a1-serverside-ab"
}
]
}
}
})
.then(response => {
const mboxes = response.prefetch.mboxes;
const notifications = mboxes.map(mbox => {
const type = "display";
const tokens = createTokens(mbox.options);
return createNotification(mbox, type, tokens);
});
adobe.target.sendNotifications({
request: { notifications }
});
})
getOffers()
nur mit Vorabruf und sendNotifications()
, muss die Analytics nach Ausführung von sendNotifications()
ausgelöst werden. Dadurch soll sichergestellt werden, dass die von sendNotifications()
generierte SDID mit der an Analytics und Target gesendeten SDID übereinstimmt.