DocumentazioneGuida per gli sviluppatori di Target

adobe.target.sendNotifications(options)

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

Creato per:

  • Developer

Questa funzione invia una notifica a Target edge quando viene eseguito il rendering di un’esperienza senza utilizzare adobe.target.applyOffer() o adobe.target.applyOffers().

NOTE
Questa funzione è stata introdotta in at.js 2.1.0 e sarà disponibile per tutte le versioni successive alla versione 2.1.0.
Chiave
Tipo
Obbligatorio
Descrizione
consumerId
Stringa
No
Il valore predefinito è la mbox globale del client, se non specificato. Questa chiave si utilizza per generare l’ID dati supplementare utilizzato per l’integrazione A4T.
Richiesta
Oggetto
Sì
Vedi la tabella Richieste di seguito.
timeout
Numero
No
Timeout richiesta. Se non specificato, si utilizza il timeout predefinito di at.js.

Richiesta

Nome campo
Tipo
Obbligatorio
Limitazione
Descrizione
Request > notifications
Array di oggetti
Sì
Notifiche per il contenuto visualizzato, i selettori su cui è stato fatto clic e/o le visualizzazioni o le mbox visitate.
Request > notifications > address
Oggetto
No
Request > notifications > address > url
Stringa
No
URL da cui è stata avviata la notifica.
Request > notifications > address > referringUrl
Stringa
No
URL di riferimento da cui è stata avviata la notifica.
Request > notifications > parameters
Stringa
No

I seguenti nomi non sono consentiti per i parametri:

  • orderId
  • orderTotal
  • productPurchasedIds

Considera i seguenti aspetti:

  • Limite massimo di parametri: 50.
  • Il nome del parametro non può restare vuoto.
  • Lunghezza massima del nome del parametro: 128.
  • Il nome del parametro non può iniziare con “profile”.
  • Lunghezza massima del valore parametro: 5000.
Request > notifications > profileParameters
Stringa
No

I seguenti nomi non sono consentiti per i parametri:

  • orderId
  • orderTotal
  • productPurchasedIds

Considera i seguenti aspetti:

  • Limite massimo di parametri: 50.
  • Il nome del parametro non può restare vuoto.
  • Lunghezza massima del nome del parametro: 128.
  • Il nome del parametro non può iniziare con “profile”.
  • Lunghezza massima del valore parametro: 5000.
Request > notifications > order
Oggetto
No
Oggetto che descrive i dettagli dell’ordine.

Request > notifications > order

id

Stringa
No
<= 250 caratteri.
ID ordine.

Request > notifications > order

total

Stringa
No
>= 0
Totale ordine.

Request > notifications > order

purchasedProductIds

Array di stringa
No
  • Non sono consentiti valori vuoti.
  • Lunghezza massima di ogni ID prodotto: 50.
  • Lunghezza massima degli ID dei prodotti, separati da virgole e concatenati: 250.
ID dei prodotti di un ordine.
Request > notifications > product
Oggetto
No
Request > notifications > product > id
Stringa
No
<= 128 caratteri; non può essere vuoto.
ID prodotto.
Request > notifications > product > categoryId
Stringa
No
<= 128 caratteri; non può essere vuoto.
ID categoria.
Request > notifications > id
Stringa
Sì
<= 200 caratteri.
L’ID della notifica viene restituito nella risposta e indica che la notifica è stata elaborata correttamente.
Request > notifications > impressionId
Stringa
No
<= 128 caratteri.
L’ID dell’impression viene utilizzato per unire (collegare) la notifica corrente con una notifica precedente o per eseguire una richiesta. Se entrambi corrispondono, la seconda e altre richieste successive non genereranno una nuova impression per l’attività o l’esperienza.
Request > notifications > type
Stringa
Sì
è supportato il tipo "click" o "display".
Tipo di notifica.
Request > notifications > timestamp
Numero<int64>
Sì
Marca temporale della notifica, in millisecondi trascorsi dall’epoca UNIX.
Request > notifications > tokens
Array di stringa
Sì
Elenco di token per i contenuti visualizzati o i selettori su cui è stato fatto clic, in base al tipo di notifica.
Request > notifications > mbox
Oggetto
No
Notifiche per la mbox.

Request > notifications > mbox

name

Stringa
No

Non sono consentiti valori vuoti.

Caratteri consentiti: vedi la nota in calce alla tabella.

Nome Mbox.

Request > notifications > mbox

state

Stringa
No
Token dello stato della mbox.
Request > notifications > view
Oggetto
No

Request > notifications > view

id

Intero <int64>
No
ID visualizzazione. ID assegnato alla visualizzazione al momento della creazione della stessa tramite l’API per le visualizzazioni.

Request > notifications > view

name

Stringa
No
<= 128 caratteri.
Nome della visualizzazione.

Request > notifications > view

key

Stringa
No
<= 512 caratteri.
Chiave visualizzazione. Chiave impostata per la visualizzazione tramite l’API.

Request > notifications > view

state

Stringa
No
Token dello stato della visualizzazione.

Nota: i seguenti caratteri sono non consentito per Request > notifications > mbox > name:

- '-, ./=`:;&!@#$%^&*()+|?~[]{}'

Chiamata sendNotifications() dopo il rendering delle mbox preacquisite

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 }
  });
})
NOTE
Se sta usando Adobe Analytics, getOffers() solo con preacquisizione e sendNotifications(), il Analytics la richiesta deve essere attivata dopo sendNotifications() viene eseguito. Lo scopo è garantire che il codice SDID generato da sendNotifications() corrisponde al codice SDID inviato a Analytics e Target.
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3