Consegnare offerte tramite Batch Decisioning API deliver-offers-batch

Il Batch Decisioning API consente alle organizzazioni di utilizzare la funzionalità di decisioning per tutti i profili in un determinato pubblico in una chiamata. Il contenuto dell’offerta per ogni profilo del pubblico viene inserito in un set di dati Adobe Experience Platform dove è disponibile per flussi di lavoro batch personalizzati.

Con il Batch Decisioning API, puoi popolare un set di dati con le offerte migliori per tutti i profili in un pubblico Adobe Experience Platform, per ambiti decisionali. Ad esempio, un’organizzazione potrebbe voler eseguire Batch Decisioning in modo che possano inviare offerte a un fornitore di consegna dei messaggi. Tali offerte vengono quindi utilizzate come contenuto inviato per la consegna di messaggi in batch allo stesso pubblico di utenti.

A tal fine, l’organizzazione:

  • Esegui il Batch Decisioning API, che contiene due richieste:

    1. A Richiesta Batch POST per avviare un carico di lavoro per elaborare in batch le selezioni delle offerte.

    2. A Richiesta batch di GET per ottenere lo stato del carico di lavoro batch.

  • Esporta il set di dati nell’API del fornitore per la consegna dei messaggi.

NOTE
Le decisioni in batch possono essere eseguite anche utilizzando l’interfaccia di Journey Optimizer. Per ulteriori informazioni, consulta questa sezione, che fornisce informazioni sui prerequisiti e le limitazioni globali da tenere in considerazione quando si utilizzano le decisioni batch.
  • Numero di processi batch in esecuzione per set di dati: è possibile eseguire fino a cinque processi batch alla volta, per set di dati. Eventuali altre richieste batch con lo stesso set di dati di output vengono aggiunte alla coda. Un processo in coda viene selezionato per l'elaborazione al termine dell'esecuzione del processo precedente.
  • Limitazione di frequenza: un batch viene eseguito dallo snapshot del profilo che si verifica una volta al giorno. Il Batch Decisioning L’API limita la frequenza e carica sempre i profili dallo snapshot più recente.

Introduzione getting-started

Prima di utilizzare questa API, assicurati di completare i seguenti passaggi preliminari richiesti.

Preparare la decisione prepare-decision

Per preparare una o più decisioni, assicurati di aver creato un set di dati, un pubblico e una decisione. Tali prerequisiti sono descritti in questa sezione.

Requisiti API api-requirements

Tutti Batch Decisioning Le richieste di richiedono le seguenti intestazioni oltre a quelle indicate nella Guida per gli sviluppatori API per la gestione delle decisioni:

  • Content-Type: application/json
  • x-request-id: stringa univoca che identifica la richiesta.
  • x-sandbox-name: nome della sandbox.

Avviare un processo batch start-a-batch-process

Per avviare un carico di lavoro per l'elaborazione in batch delle decisioni, effettuare una richiesta POST al /workloads/decisions endpoint.

NOTE
Informazioni dettagliate sui tempi di elaborazione dei processi batch sono disponibili in questa sezione.

Formato API

POST {ENDPOINT_PATH}/workloads/decisions
Parametro
Descrizione
Esempio
{ENDPOINT_PATH}
Percorso dell’endpoint per le API dell’archivio.
https://platform.adobe.io/data/core/dwm

Richiesta

curl -X POST 'https://platform.adobe.io/data/core/dwm/workloads/decisions' \
-H 'x-request-id: f671a589-eb7b-432f-b6b9-23d5b796b4dc' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-d '{
  "xdm:segmentIds": [
    "609028e4-e66c-4776-b0d9-c782887e2273"
  ],
  "xdm:dataSetId": "6196b4a1a63bd118dafe093c",
  "xdm:propositionRequests": [
        {
            "xdm:activityId": "xcore:offer-activity:1410cdcda196707b",
            "xdm:placementId": "xcore:offer-placement:1410c4117306488a",
            "xdm:itemCount": 1
        }
  ],
  "xdm:includeContent": false
}'
Proprietà
Descrizione
Esempio
xdm:segmentIds
Il valore è un array che contiene l’identificatore univoco del pubblico. Può contenere un solo valore.
609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId
Il set di dati di output in cui è possibile scrivere gli eventi di decisione.
6196b4a1a63bd118dafe093c
xdm:propositionRequests
Un wrapper che contiene placementId e activityId
xdm:activityId
L’identificatore univoco della decisione.
xcore:offer-activity:1410cdcda196707b
xdm:placementId
L’identificatore di posizionamento univoco.
xcore:offer-placement:1410c4117306488a
xdm:itemCount
Questo è un campo facoltativo che mostra il numero di elementi, ad esempio le opzioni richieste per l’ambito decisionale. Per impostazione predefinita, l’API restituisce un’opzione per ambito, ma è possibile richiedere esplicitamente più opzioni specificando questo campo. È possibile richiedere un minimo di 1 e un massimo di 30 opzioni per ambito.
1
xdm:includeContent
Questo è un campo facoltativo ed è false per impostazione predefinita. Se true, il contenuto dell’offerta è incluso negli eventi decisionali del set di dati.
false

Consulta la sezione Documentazione di Gestione delle decisioni per una panoramica dei concetti e delle proprietà principali.

Risposta

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}
Proprietà
Descrizione
Esempio
@id
L’UUID generato dalla gestione delle decisioni che identifica un singolo carico di lavoro.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
L’ID organizzazione.
9GTO98D5F@AdobeOrg
ode:createDate
L’ora in cui è stata creata la richiesta del carico di lavoro di decisione.
1648078924834
ode:status
Stato del carico di lavoro.
ode:status: "QUEUED"

Recuperare informazioni su una decisione batch retrieve-information-on-a-batch-decision

Per recuperare informazioni su una decisione specifica, invia una richiesta GET al /workloads/decisions fornendo il corrispondente valore ID del carico di lavoro per la decisione.

Formato API

GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
Parametro
Descrizione
Esempio
{ENDPOINT_PATH}
Percorso dell’endpoint per le API dell’archivio.
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
L’UUID generato dalla gestione delle decisioni che identifica un singolo carico di lavoro.
47efef25-4bcf-404f-96e2-67c4f784a1f5

Richiesta

curl -X GET 'https://platform.adobe.io/data/core/dwm/workloads/decisions/f395ab1f-dfaf-48d4-84c9-199ad6354591' \
-H 'x-request-id: 7832a42a-d4e5-413b-98e8-e49bef056436' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}'

Risposta

{
   "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}
Proprietà
Descrizione
Esempio
@id
L’UUID generato dalla gestione delle decisioni che identifica un singolo carico di lavoro.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
ID organizzazione
9GTO98D5F@AdobeOrg
ode:createDate
Ora di creazione della richiesta del carico di lavoro delle decisioni.
1648076994405
ode:status
Lo stato del carico di lavoro inizia con "QUEUED" (IN CODA) e cambia in "PROCESSING" (ELABORAZIONE), "INGESTING" (ACQUISIZIONE), "COMPLETED" (COMPLETATO) o "ERROR" (ERRORE).
ode:status: "COMPLETED"
ode:statusDetail
Mostra altri dettagli come sparkJobId e batchID se lo stato è "PROCESSING" o "INGESTING". Mostra i dettagli dell’errore se lo stato è "ERROR".

Passaggi successivi next-steps

Seguendo questa guida API, hai controllato lo stato del carico di lavoro e hai consegnato le offerte utilizzando Batch Decisioning API. Per ulteriori informazioni, vedere panoramica sulla gestione delle decisioni.

recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76