Leverera erbjudanden med API:t Batch Decisioning deliver-offers-batch

Med API:t Batch Decisioning kan organisationer använda beslutsfunktioner för alla profiler i en viss målgrupp i ett enda anrop. Erbjudandeinnehållet för varje profil i målgruppen placeras i en Adobe Experience Platform-datauppsättning där det är tillgängligt för anpassade grupparbetsflöden.

Med API:t Batch Decisioning kan du fylla i en datauppsättning med de bästa erbjudandena för alla profiler i en Adobe Experience Platform-målgrupp för beslutsomfattningar. En organisation kanske vill köra Batch Decisioning så att den kan skicka erbjudanden till en meddelandeleverantör. Erbjudandena används sedan som innehåll som skickas ut för batchmeddelandeleverans till samma målgrupp.

För att göra detta skulle organisationen:

  • Kör API:t Batch Decisioning som innehåller två begäranden:

    1. En gruppbearbetningsbegäran om att starta en arbetsbelastning för batchbearbetning av erbjudandeval.

    2. En Batch GET-begäran om att hämta batcharbetsbelastningsstatus.

  • Exportera datauppsättningen till meddelandeleverantörens API.

NOTE
Gruppbeslut kan också utföras med Journey Optimizer gränssnitt. Mer information finns i det här avsnittet, som innehåller information om globala krav och begränsningar som ska beaktas när gruppbeslut används.
  • Antalet batchjobb som körs per datamängd: Upp till fem batchjobb kan köras åt gången, per datamängd. Alla andra gruppförfrågningar med samma utdatamängd läggs till i kön. Ett jobb i kö plockas upp för bearbetning när det föregående jobbet har slutförts.
  • Frekvensbegränsning: En grupp körs bort från profilögonblicksbilden som inträffar en gång om dagen. API:t Batch Decisioning kapslar frekvensen och läser alltid in profiler från den senaste ögonblicksbilden.

Komma igång getting-started

Innan du använder detta API måste du utföra följande steg.

Förbered beslutet prepare-decision

Om du vill förbereda ett eller flera beslut måste du skapa en datauppsättning, en målgrupp och ett beslut. Dessa krav beskrivs i det här avsnittet.

API-krav api-requirements

Alla Batch Decisioning-begäranden kräver följande huvuden förutom de som refereras i API-utvecklarhandboken för beslutshantering:

  • Content-Type: application/json
  • x-request-id: En unik sträng som identifierar begäran.
  • x-sandbox-name: Sandlådans namn.

Starta en gruppbearbetning start-a-batch-process

Om du vill starta en arbetsbelastning för att batchbearbeta beslut gör du en POST till slutpunkten /workloads/decisions.

NOTE
Detaljerad information om bearbetningstiden för batchjobb finns i det här avsnittet.

API-format

POST {ENDPOINT_PATH}/workloads/decisions
Parameter
Beskrivning
Exempel
{ENDPOINT_PATH}
Slutpunktssökvägen för databas-API:er.
https://platform.adobe.io/data/core/dwm

Begäran

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
}'
Egenskap
Beskrivning
Exempel
xdm:segmentIds
Värdet är en array som innehåller målgruppens unika identifierare. Den får bara innehålla ett värde.
609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId
DataSet-utdata som beslutshändelser kan skrivas till.
6196b4a1a63bd118dafe093c
xdm:propositionRequests
En wrapper som innehåller placementId och activityId
xdm:activityId
Beslutets unika identifierare.
xcore:offer-activity:1410cdcda196707b
xdm:placementId
Den unika placeringsidentifieraren.
xcore:offer-placement:1410c4117306488a
xdm:itemCount
Det här är ett valfritt fält som visar antalet objekt, t.ex. alternativ som begärts för beslutsomfånget. Som standard returnerar API ett alternativ per omfång, men du kan uttryckligen be om fler alternativ genom att ange det här fältet. Minst 1 och högst 30 alternativ kan begäras per scope.
1
xdm:includeContent
Det här är ett valfritt fält och är false som standard. Om true inkluderas erbjudandeinnehållet i beslutshändelserna för datauppsättningen.
false

I beslutsdokumentationen finns en översikt över de viktigaste begreppen och egenskaperna.

Svar

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}
Egenskap
Beskrivning
Exempel
@id
UUID som genereras av beslutshantering som identifierar en enskild arbetsbelastning.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
Organisations-ID.
9GTO98D5F@AdobeOrg
ode:createDate
Den tid då begäran om beslutsarbetsbelastning skapades.
1648078924834
ode:status
Status för arbetsbelastningen.
ode:status: "QUEUED"

Hämta information om ett batchbeslut retrieve-information-on-a-batch-decision

Om du vill hämta information om ett specifikt beslut gör du en GET-förfrågan till slutpunkten /workloads/decisions och anger motsvarande ID-värde för arbetsbelastning för ditt beslut.

API-format

GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
Parameter
Beskrivning
Exempel
{ENDPOINT_PATH}
Slutpunktssökvägen för databas-API:er.
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
UUID som genereras av beslutshantering som identifierar en enskild arbetsbelastning.
47efef25-4bcf-404f-96e2-67c4f784a1f5

Begäran

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}'

Svar

{
   "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}
Egenskap
Beskrivning
Exempel
@id
UUID som genereras av beslutshantering som identifierar en enskild arbetsbelastning.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
Organisations-ID
9GTO98D5F@AdobeOrg
ode:createDate
Den tid då begäran om beslutsarbetsbelastning skapades.
1648076994405
ode:status
Arbetsbelastningens status börjar med "QUEUED" och ändras till "PROCESSING", "INGESTING", "COMPLETED" eller "ERROR".
ode:status: "COMPLETED"
ode:statusDetail
Detta visar mer information, till exempel sparkJobId och batchID, om statusen är "PROCESSING" eller "INGESTING". Felinformationen visas om statusen är FEL.

Nästa steg next-steps

Genom att följa den här API-guiden har du kontrollerat arbetsbelastningsstatusen och levererat erbjudanden med API:t Batch Decisioning. Mer information finns i översikten över beslutshantering.

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