�۶���Ƶ

Deliver offers using the Batch Decisioning API deliver-offers-batch

The Batch Decisioning API allows organizations to use decisioning functionality for all profiles in a given audience in one call. The offer content for each profiles in the audience is placed in an �۶���Ƶ Experience Platform dataset where it is available for custom batch workflows.

With the Batch Decisioning API, you can populate a dataset with the best offers for all profiles in an �۶���Ƶ Experience Platform audience for decision scopes. For example, an organization may want to run Batch Decisioning so they can send offers to a message delivery vendor. Those offers are then used as content that is sent out for batch message delivery to the same audience of users.

To do this, the organization would:

Getting started getting-started

Before using this API, make sure you complete the following pre-requisite steps.

Prepare the decision prepare-decision

To prepare one or more decisions, make sure you have created a dataset, an audience, and a decision. Those prerequisites are detailed in this section.

API requirements api-requirements

All Batch Decisioning requests require the following headers in addition to the ones referred to in the Decision Management API developer guide:

Start a batch process start-a-batch-process

To start a workload to batch process decisions, make a POST request to the /workloads/decisions endpoint.

API format

POST {ENDPOINT_PATH}/workloads/decisions

Request

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

Refer to the Decision Management documentation for an overview of the main concepts and properties.

Response

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@�۶���ƵOrg",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}

Retrieve information on a batch decision retrieve-information-on-a-batch-decision

To retrieve information on a specific decision, make a GET request to the /workloads/decisions endpoint while providing the corresponding workload ID value for your decision.

API format

GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}

Request

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

Response

{
   "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}

Next steps next-steps

By following this API guide, you have checked for the workload status and delivered offers using the Batch Decisioning API. For more information, see the overview on Decision Management.