Distribuire le offerte tramite l’API Decisioning decisioning-api

Con la funzione di gestione delle decisioni, puoi creare e fornire esperienze di offerta personalizzate per l’utente finale, per diversi canali e applicazioni utilizzando la logica di business e le regole decisionali. Un’offerta è un messaggio di marketing a cui possono essere associate delle regole che determinano gli utenti idonei per visualizzare l’offerta.

Per creare e consegnare le offerte, devi effettuare una richiesta POST al Decisioning API.

Questo tutorial richiede una buona conoscenza delle API, in particolare per quanto riguarda la gestione delle decisioni. Per ulteriori informazioni, vedere Guida per gli sviluppatori API per la gestione delle decisioni. Questo tutorial richiede anche di avere a disposizione un ID posizionamento e un valore ID decisione univoci. Se non hai acquisito questi valori, consulta i tutorial per creazione di un posizionamento e creazione di una decisione.

➡️ Scopri questa funzione nel video

Intestazioni richieste required-headers

La tabella seguente mostra i valori validi che compongono Content-Type e Accetta campi nell’intestazione della richiesta:

Nome intestazione
Valore
Accetta
application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-response;version=1.0"
Content-Type
application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-request;version=1.0"
Authorization
Bearer {ACCESS_TOKEN}
x-gw-ims-org-id
{IMS_ORG}
x-sandbox-name
{SANDBOX_NAME}
x-api-key
{API_KEY}
  • Tutte le richieste che contengono un payload (POST,PUT,PATCH) richiedono l’intestazione content-type

richiesta API request

Formato API

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

Richiesta

curl -X POST \
  'https://platform.adobe.io/data/core/ods/decisions' \
  -H 'Accept: application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-response;version=1.0"' \
  -H 'Content-Type: application/vnd.adobe.xdm+json; schema="https://ns.adobe.com/experience/offer-management/decision-request;version=1.0"'
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
        "xdm:propositionRequests": [
            {
              "xdm:placementId": "xcore:offer-placement:ffed0456",
              "xdm:activityId": "xcore:offer-activity:ffed0123",
              "xdm:itemCount": 2
            },
            {
              "xdm:placementId": "xcore:offer-placement:ffed0012",
              "xdm:activityId": "xcore:offer-activity:fffc0789"
            }
        ],
        "xdm:profiles": [
            {
              "xdm:identityMap": {
                "SWCUSTID": [
                {
                    "xdm:id": "123@abc.com"
                }
                ]
            },
            "xdm:decisionRequestId": "0AA00002-0000-1224-c0de-cjf98Csj43"
            }
        ],
        "xdm:allowDuplicatePropositions": {
            "xdm:acrossActivities": true,
            "xdm:acrossPlacements": true
        },
        "xdm:mergePolicy": {
            "xdm:id": "5f3ed32f-eaf1-456c-b0f0-7b338c4cb18a"
        },
        "xdm:responseFormat": {
            "xdm:includeContent": true,
            "xdm:includeMetadata": {
            "xdm:activity": [
                "name"
            ],
            "xdm:option": [
                "name"
            ],
            "xdm:placement": [
                "name"
            ]
            }
        }
      }'
Proprietà
Descrizione
Esempio
xdm:propositionRequests
Questo oggetto contiene gli identificatori di posizionamento e di decisione.
xdm:propositionRequests.xdm:placementId
L’identificatore di posizionamento univoco.
"xdm:placementId": "xcore:offer-placement:ffed0456"
xdm:propositionRequests.xdm:activityId
L’identificatore di decisione univoco.
"xdm:activityId": "xcore:offer-activity:ffed0123"
xdm:itemCount
Il numero di offerte da restituire. Il numero massimo è 30.
"xdm:itemCount": 2
xdm:profiles
Questo oggetto contiene informazioni sul profilo per cui è richiesta la decisione. Per una richiesta API questo conterrà un profilo.
xdm:profiles.xdm:identityMap
Questo oggetto contiene un set di identità dell’utente finale basate sul codice di integrazione dello spazio dei nomi dell’identità. La mappa delle identità può contenere più di un’identità di ogni spazio dei nomi. Per ulteriori informazioni sugli spazi dei nomi, consulta questa pagina.
Email: [{"xdm:id": "123@abc.com"}]
xdm:profiles.xdm:decisionRequestId
L’ID generato dal client che può essere utilizzato per identificare in modo univoco una richiesta di decisione di profilo. Questo ID viene ripreso nella risposta e non influenza l’esito della decisione.
"xdm:decisionRequestId": "0AA00002-0000-1224-c0de-cjf98Csj43"
xdm:allowDuplicatePropositions
Questo oggetto rappresenta la struttura di controllo delle regole di deduplicazione. È costituito da una serie di flag che indicano se la stessa opzione può essere proposta in una determinata dimensione. Un flag impostato su true significa che i duplicati sono consentiti e non devono essere rimossi in tutta la categoria indicata dal flag. Un flag impostato su false significa che il motore decisionale non deve fare la stessa proposta in tutta la dimensione e scegliere invece l’opzione migliore successiva per una delle sottodecisioni.
xdm:allowDuplicatePropositions.xdm:acrossActivities
Se è impostato su true, a più decisioni può essere assegnata la stessa opzione.
"xdm:acrossActivities": true
xdm:allowDuplicatePropositions.xdm:acrossPlacements
Se è impostato su true, a più posizionamenti può essere assegnata la stessa opzione.
"xdm:acrossPlacements": true
xdm:mergePolicy.xdm:id
Identifica il criterio di unione in base al quale gestire i dati restituiti dal servizio di accesso al profilo. Se non ne viene specificato uno nella richiesta, la gestione delle decisioni non trasmette alcun servizio di accesso al profilo, altrimenti trasmette l’ID fornito dal chiamante.
"xdm:id": "5f3ed32f-eaf1-456c-b0f0-7b338c4cb18a"
xdm:responseFormat
Un set di flag che formatta il contenuto della risposta.
xdm:responseFormat.xdm:includeContent
Valore booleano che, se impostato su true, include il contenuto della risposta.
"xdm:includeContent": true
xdm:responseFormat.xdm:includeMetadata
Oggetto utilizzato per specificare i metadati aggiuntivi restituiti. Se questa proprietà non è inclusa, xdm:id e repo:etag vengono restituiti per impostazione predefinita.
name
xdm:responseFormat.xdm:activity
Questo flag identifica le informazioni di metadati specifiche restituite per xdm:activity.
name
xdm:responseFormat.xdm:option
Questo flag identifica le informazioni di metadati specifiche restituite per xdm:option.
name, characteristics
xdm:responseFormat.xdm:placement
Questo flag identifica le informazioni di metadati specifiche restituite per xdm:placement.
name, channel, componentType

Risposta

In caso di esito positivo, la risposta restituisce informazioni sulla proposta, comprese le sue caratteristiche univoche xdm:propositionId.

{
  "xdm:propositionId": "5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8",
  "xdm:propositions": [
    {
      "xdm:activity": {
        "xdm:id": "xcore:activity:ffed0123",
        "repo:etag": 4
      },
      "xdm:placement": {
        "xdm:id": "xcore:placement:ffed0456",
        "repo:etag": 1
      },
      "xdm:options": [
        {
          "xdm:id": "xcore:personalized-option:ccc0111",
          "repo:etag": 3,
          "@type": "https://ns.adobe.com/experience/decisioning/content-component-html-template",
          "xdm:content": "<html>some html</html>"
        },
        {
          "xdm:id": "xcore:personalized-option:ccc0222",
          "repo:etag": 5,
          "@type": "https://ns.adobe.com/experience/decisioning/content-component-html-template",
          "xdm:content": "<html>hello, world</html>",
          "xdm:score": 45.65
        }
      ]
    },
    {
      "xdm:activity": {
        "xdm:id": "xcore:activity:ffed0123",
        "repo:etag": 4
      },
      "xdm:placement": {
        "xdm:id": "xcore:placement:ffed0789",
        "repo:etag": 2
      },
      "xdm:fallback": {
        "xdm:id": "xcore:fallback:ccc0222",
        "repo:etag": 5,
        "@type": "https://ns.adobe.com/experience/decisioning/content-component-imagelink",
        "dc:format": "image/png",
        "xdm:deliveryURL": "https://cdn.adobe.com/content/1445323-1134331.png",
        "xdm:content": "https://www.adobe.com/index2.html"
      }
    }
  ],
  "ode:createDate": 1566497582038
}
Proprietà
Descrizione
Esempio
xdm:propositionId
L’identificatore univoco dell’entità proposta associata a un DecisionEvent XDM.
"xdm:propositionId": "5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8"
xdm:propositions
Questo oggetto contiene una singola proposta di decisione. È possibile restituire più opzioni per la decisione. Se non viene trovata alcuna opzione, viene restituita l’offerta di fallback della decisione. Le singole proposte di decisione includono sempre options proprietà o un fallback proprietà. Se presente, il options la proprietà non può essere vuota.
xdm:propositions.xdm:activity
Questo oggetto contiene l’identificatore univoco di una decisione.
"xdm:id": "xcore:activity:ffed0123"
xdm:propositions.xdm:placement
Questo oggetto contiene l’identificatore univoco per il posizionamento di un’offerta.
"xdm:id": "xcore:placement:ffed0456"
xdm:propositions.xdm:options
Questo oggetto contiene una singola opzione, incluso il relativo identificatore univoco. Se presente, questo oggetto non può essere vuoto.
xdm:id": "xcore:personalized-option:ccc0111
xdm:propositions.xdm:options.@type
Definisce il tipo di componente. @type funge da contratto di elaborazione per il cliente. Quando l'esperienza viene assemblata, il compositore cercherà i componenti che hanno un tipo specifico.
https://ns.adobe.com/experience/offer-management/content-component-imagelink
xdm:propositions.xdm:content
Il formato del contenuto della risposta.
Il contenuto della risposta può essere: text, html block, o image link
xdm:score
Il punteggio di un’opzione calcolato come risultato di una funzione di classificazione associata all’opzione o alla decisione. Questo campo verrà restituito dall’API se una funzione di classificazione è coinvolta nella determinazione del punteggio di un’offerta durante la classificazione.
"xdm:score": 45.65
xdm:propositions.xdm:fallback
Questo oggetto contiene una singola offerta di fallback, incluso il relativo identificatore univoco.
"xdm:id": "xcore:fallback:ccc0222"
xdm:propositions.xdm:fallback.dc:format
La manifestazione fisica o digitale della risorsa. In genere, il formato deve includere il tipo di file multimediale della risorsa. Il formato può essere utilizzato per determinare il software, l'hardware o altre apparecchiature necessarie per visualizzare o utilizzare la risorsa. Si consiglia di selezionare un valore da un vocabolario controllato, ad esempio, l’elenco di Tipi di file multimediali Internet definizione dei formati dei supporti informatici.
"dc:format": "image/png" oppure "image/jpeg"
xdm:propositions.xdm:fallback.xdm:deliveryURL
Un URL facoltativo per leggere la risorsa da una rete di distribuzione di contenuti o da un endpoint di servizio. Questo URL viene utilizzato per accedere pubblicamente alla risorsa da un agente utente.
https://d37yhxrr0p3l3l.cloudfront.net/0fd0f090-a148-11ea-89e3-f1f2ad52f7e8/urn:aaid:sc:US:a68c86a6-9295-4940-a083-11916b665500/0/40d78a12-f8b6-3f07-8e67-7cb8ae2cc7ec
ode:createDate
L’ora in cui è stato creato il messaggio di risposta alla decisione. Questo è rappresentato come tempo dell'epoca.
"ode:createDate": 1566497582038

Codici di risposta

La tabella seguente elenca tutti i codici che possono essere restituiti nella risposta:

Codice
Descrizione
200
Operazione completata. La decisione è stata presa per determinate attività
400
Parametro di richiesta non valido. Impossibile comprendere la richiesta dal server a causa di sintassi non valida.
403
Autorizzazioni non consentite, insufficienti.
422
Entità non elaborabile. La sintassi della richiesta è corretta, tuttavia, a causa di errori semantici non è possibile elaborarla.
429
Troppe richieste. L’utente ha inviato troppe richieste in un determinato periodo di tempo.
500
Errore interno del server. Il server ha rilevato una condizione imprevista che ha impedito il completamento della richiesta.
503
Servizio non disponibile a causa di sovraccarico del server. Il server non è attualmente in grado di gestire la richiesta a causa di un sovraccarico temporaneo.

Passaggi successivi next-steps

Seguendo questa guida API, hai creato e consegnato offerte utilizzando Decisions API. Per ulteriori informazioni, vedere panoramica sulla gestione delle decisioni.

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