Biedt aanbiedingen met de Batch Decisioning API deliver-offers-batch

De Batch Decisioning API staat organisaties toe om besluitvormingsfunctionaliteit voor alle profielen in een bepaald publiek in één vraag te gebruiken. De aanbiedingsinhoud voor elke profielen in het publiek wordt geplaatst in een dataset van Adobe Experience Platform waar het voor de werkschema's van de douanepartij beschikbaar is.

Met de Batch Decisioning API, kunt u een dataset met de beste aanbiedingen voor alle profielen in een publiek van Adobe Experience Platform voor besluitvormingswerkingsgebied bevolken. Een organisatie wil bijvoorbeeld Batch Decisioning zodat zij voorstellen naar een leverancier van de berichtlevering kunnen verzenden. Die aanbiedingen worden dan gebruikt als inhoud die voor partijberichtlevering aan het zelfde publiek van gebruikers wordt verzonden.

Om dit te doen, zou de organisatie:

  • Voer de Batch Decisioning API, die twee verzoeken bevat:

    1. A Batchverzoek POST om een werkbelasting naar batchverwerking te starten, kunt u kiezen.

    2. A Batchaanvraag om de status van batchwerkbelasting te verkrijgen.

  • Exporteer de dataset naar de API van de leverancier van de berichtlevering.

NOTE
U kunt de batch ook bepalen via de Journey Optimizer-interface. Raadpleeg voor meer informatie deze sectie, die informatie verstrekt over globale voorwaarden en beperkingen om rekening te houden met wanneer het gebruiken van partijbesluit.
  • Het aantal lopende partijbanen per dataset: Er kunnen maximaal vijf batchtaken tegelijk per dataset worden uitgevoerd. Om het even welke andere partijverzoeken met de zelfde outputdataset worden toegevoegd aan de rij. Er wordt een taak in de wachtrij opgehaald om te worden verwerkt zodra de vorige taak is voltooid.
  • Frequentiecorrectie: Een batch wordt uitgevoerd uit de profielmomentopname die één keer per dag plaatsvindt. De Batch Decisioning API kapt de frequentie en laadt altijd profielen van de meest recente momentopname.

Aan de slag getting-started

Voordat u deze API gebruikt, moet u de volgende vereiste stappen uitvoeren.

De beslissing voorbereiden prepare-decision

Om één of meerdere besluiten voor te bereiden, zorg ervoor u een dataset, een publiek, en een besluit hebt gecreeerd. Deze voorwaarden worden nader beschreven in deze sectie.

API-vereisten api-requirements

Alles Batch Decisioning naast de in de Handleiding voor ontwikkelaars van API voor beheer van beslissingen:

  • Content-Type: application/json
  • x-request-id: Een unieke tekenreeks die de aanvraag identificeert.
  • x-sandbox-name: De naam van de sandbox.

Een batchproces starten start-a-batch-process

Als u een werkbelasting wilt starten om beslissingen over batchprocessen te nemen, vraagt u een POST aan de /workloads/decisions eindpunt.

NOTE
Gedetailleerde informatie over de verwerkingstijd van batchtaken is beschikbaar in deze sectie.

API-indeling

POST {ENDPOINT_PATH}/workloads/decisions
Parameter
Beschrijving
Voorbeeld
{ENDPOINT_PATH}
Het eindpuntpad voor gegevensopslagruimte-API's.
https://platform.adobe.io/data/core/dwm

Verzoek

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
}'
Eigenschap
Beschrijving
Voorbeeld
xdm:segmentIds
De waarde is een array die de unieke id van het publiek bevat. Het kan slechts één waarde bevatten.
609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId
De output dataSet dat beslissingsgebeurtenissen kunnen worden geschreven in.
6196b4a1a63bd118dafe093c
xdm:propositionRequests
Een omslag die bevat placementId en activityId
xdm:activityId
De unieke identificatiecode van het besluit.
xcore:offer-activity:1410cdcda196707b
xdm:placementId
De unieke plaatsings-id.
xcore:offer-placement:1410c4117306488a
xdm:itemCount
Dit is een facultatief gebied dat het aantal punten zoals opties toont die voor het beslissingswerkingsgebied worden gevraagd. Standaard retourneert de API één optie per bereik, maar u kunt expliciet om meer opties vragen door dit veld op te geven. Voor elk bereik kunnen minimaal 1 en maximaal 30 opties worden aangevraagd.
1
xdm:includeContent
Dit is een optioneel veld en is false standaard. Indien trueDe inhoud van het aanbod is opgenomen in de besluitvormingsgebeurtenissen van de dataset.
false

Zie de Beslissingsbeheerdocumentatie voor een overzicht van de belangrijkste concepten en eigenschappen.

Antwoord

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}
Eigenschap
Beschrijving
Voorbeeld
@id
De UUID die door besluitvormingsbeheer wordt geproduceerd dat één enkele werkbelasting identificeert.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
De organisatie-id.
9GTO98D5F@AdobeOrg
ode:createDate
De tijd toen het verzoek van de beslissingswerklast werd gecreeerd.
1648078924834
ode:status
De status van de werklast.
ode:status: "QUEUED"

Informatie ophalen over een batchbeslissing retrieve-information-on-a-batch-decision

Om informatie over een specifiek besluit terug te winnen, doe een verzoek van de GET aan /workloads/decisions eindpunt terwijl het verstrekken van de overeenkomstige waarde van werklastidentiteitskaart voor uw besluit.

API-indeling

GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
Parameter
Beschrijving
Voorbeeld
{ENDPOINT_PATH}
Het eindpuntpad voor gegevensopslagruimte-API's.
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
De UUID die door besluitvormingsbeheer wordt geproduceerd dat één enkele werkbelasting identificeert.
47efef25-4bcf-404f-96e2-67c4f784a1f5

Verzoek

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

Antwoord

{
   "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}
Eigenschap
Beschrijving
Voorbeeld
@id
De UUID die door besluitvormingsbeheer wordt geproduceerd dat één enkele werkbelasting identificeert.
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
Organisatie-id
9GTO98D5F@AdobeOrg
ode:createDate
De tijd waarop de aanvraag voor beslissingswerkbelasting is gemaakt.
1648076994405
ode:status
De status van de werklast begint met "QUEUED" en verandert in "PROCESSING", "INGESTING", "COMPLETED" of "ERROR".
ode:status: "COMPLETED"
ode:statusDetail
Hier worden meer details weergegeven, zoals sparkJobId en batchID als de status "PROCESSING" of "INGESTING" is. De foutdetails worden weergegeven als de status "ERROR" is.

Volgende stappen next-steps

Door deze API-handleiding te volgen, hebt u de werklaststatus gecontroleerd en aanbiedingen geleverd met de Batch Decisioning API. Zie de klasse overzicht van het besluitvormingsbeheer.

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