Consegnare offerte utilizzando Batch Decisioning API

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

Con la Batch Decisioning API, puoi compilare un set di dati con le migliori offerte per tutti i profili in un segmento Adobe Experience Platform per gli ambiti decisionali. Ad esempio, un'organizzazione può voler eseguire Batch Decisioning in modo da poter inviare offerte a un fornitore di consegna messaggi. Tali offerte vengono quindi utilizzate come contenuto inviato per la consegna di messaggi batch allo stesso segmento 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 di GET batch per ottenere lo stato del carico di lavoro batch.

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

NOTA

Le decisioni in batch possono essere eseguite anche utilizzando l'interfaccia Journey Optimizer. Per ulteriori informazioni, consulta questa sezione, che fornisce informazioni su prerequisiti e limitazioni globali da tenere in considerazione quando si utilizzano le decisioni in 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 raccolto per l'elaborazione una volta che il processo precedente è stato completato.
  • Limite di frequenza: Un batch esegue lo snapshot del profilo che si verifica una volta al giorno. La Batch Decisioning L’API limita la frequenza e carica sempre i profili dallo snapshot più recente.

Introduzione

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

Preparare la decisione

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

Requisiti API

Tutto Batch Decisioning le richieste richiedono le seguenti intestazioni oltre a quelle di cui al Guida per gli sviluppatori API per la gestione delle decisioni:

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

Avviare un processo batch

Per avviare un carico di lavoro per l'elaborazione in batch delle decisioni, inviare una richiesta POST /workloads/decisions punto finale.

NOTA

Informazioni dettagliate sul tempo di elaborazione dei processi batch sono disponibili in questa sezione.

Formato API

POST {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions
Parametro Descrizione Esempio
{ENDPOINT_PATH} Percorso endpoint per le API dell'archivio. https://platform.adobe.io/data/core/ode
{CONTAINER_ID} Il contenitore in cui si trovano le decisioni. e0bd8463-0913-4ca1-bd84-6309134ca1f6

Richiesta

curl -X POST 'https://platform.adobe.io/data/core/ode/0948b1c5-fff8-3b76-ba17-909c6b93b5a2/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 è una matrice che contiene l’identificatore univoco del segmento. Può contenere un solo valore. 609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId Il dataSet di output in cui è possibile scrivere gli eventi decisionali. 6196b4a1a63bd118dafe093c
xdm:propositionRequests Un wrapper contenente il placementId e activityId
xdm:activityId Identificatore univoco della decisione. xcore:offer-activity:1410cdcda196707b
xdm:placementId Identificatore di posizionamento univoco. xcore:offer-placement:1410c4117306488a
xdm:itemCount Si tratta di 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 puoi chiedere 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

Fai riferimento a 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",
    "xdm:containerId": "0948b1c5-fff8-3b76-ba17-909c6b93b5a2",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}
Proprietà Descrizione Esempio
@id UUID generato dall'Offer decisioning che identifica un singolo carico di lavoro. 5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId ID organizzazione. 9GTO98D5F@AdobeOrg
xdm:containerId ID del contenitore. 0948b1c5-fff8-3b76-ba17-909c6b93b5a2
ode:createDate Data di creazione della richiesta del carico di lavoro della decisione. 1648078924834
ode:status Stato del carico di lavoro. ode:status: "QUEUED"

Recupera informazioni su una decisione batch

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

Formato API

GET  {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions/{WORKLOAD_ID}
Parametro Descrizione Esempio
{ENDPOINT_PATH} Percorso endpoint per le API dell'archivio. https://platform.adobe.io/data/core/ode
{CONTAINER_ID} Il contenitore in cui si trovano le decisioni. e0bd8463-0913-4ca1-bd84-6309134ca1f6
{WORKLOAD_ID} UUID generato dall'Offer decisioning che identifica un singolo carico di lavoro. 47efef25-4bcf-404f-96e2-67c4f784a1f5

Richiesta

curl -X GET 'https://platform.adobe.io/data/core/ode/0948b1c5-fff8-3b76-ba17-909c6b93b5a2/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}",
    "xdm:containerId": "0948b1c5-fff8-3b76-ba17-909c6b93b5a2",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}
Proprietà Descrizione Esempio
@id UUID generato dall'Offer decisioning che identifica un singolo carico di lavoro. 5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId ID organizzazione 9GTO98D5F@AdobeOrg
xdm:containerId ID contenitore 0948b1c5-fff8-3b76-ba17-909c6b93b5a2
ode:createDate Data e ora di creazione della richiesta di carico di lavoro della decisione. 1648076994405
ode:status Lo stato del carico di lavoro inizia con "QUEUED" e cambia in "PROCESSING", "INGESTING", "COMPLETED" o "ERROR". ode:status: "COMPLETED"
ode:statusDetail Questo mostra ulteriori dettagli come sparkJobId e batchID se lo stato è "PROCESSING" o "INGESTING". Mostra i dettagli dell'errore se lo stato è "ERROR".

Passaggi successivi

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

In questa pagina