Skip to content

Latest commit

 

History

History
198 lines (131 loc) · 6.74 KB

proposition-detail.schema.md

File metadata and controls

198 lines (131 loc) · 6.74 KB
Raw

Decision Proposition Details Schema

https://ns.adobe.com/experience/decisioning/proposition-detail

A decision proposition detail is used to capture the output of a decisioning activity. Propositions are enriched with the observed metrics that applied to the selected options at the time the decision was made.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/decisioning/proposition-detail.schema.json

Schema Hierarchy

Decision Proposition Details Examples

{
  "xdm:activity": {
    "xdm:id": "xcore:offer-activity:ebc48132c26ccfc",
    "xdm:name": "Online College Counseler",
    "xdm:startDate": "2018-10-13T05:59:18.914Z",
    "xdm:endDate": "2018-12-27T05:59:18.914Z",
    "xdm:fallback": "xcore:fallback-offer:e91ce7243fd8c2a"
  },
  "xdm:placement": {
    "xdm:id": "xcore:offer-placement:c652463157c2aa1",
    "xdm:name": "Top Banner",
    "xdm:channel": "https://ns.adobe.com/xdm/channels/email"
  },
  "xdm:selections": [
    {
      "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9",
      "xdm:name": "Introduction to machine learning",
      "xdm:characteristics": {
        "duration": "14",
        "level": "intermediate",
        "format": "Syllable"
      },
      "https://ns.adobe.com/experience/decisioning/propositionsTotal": {
        "xdm:value": 4948
      },
      "https://ns.adobe.com/experience/decisioning/propositionsProfile": {
        "xdm:value": 2
      }
    },
    {
      "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
      "xdm:name": "Summer Camp",
      "xdm:characteristics": {
        "cost": "$2400",
        "inventoryId": "BORA04",
        "country": "French Polynesia"
      },
      "https://ns.adobe.com/experience/decisioning/propositionsTotal": {
        "xdm:value": 3813
      },
      "https://ns.adobe.com/experience/decisioning/propositionsProfile": {
        "xdm:value": 1
      }
    }
  ]
}
{
  "xdm:activity": {
    "xdm:id": "xcore:offer-activity:f203512e02542b5"
  },
  "xdm:fallback": {
    "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a"
  }
}

Decision Proposition Details Properties

Property Type Required Defined by
xdm:activity Decision Activity Details Optional Decision Proposition Details (this schema)
xdm:channel string Optional Decision Proposition Details (this schema)
xdm:fallback Decision Option Details Optional Decision Proposition Details (this schema)
xdm:placement Decision Placement Detail Optional Decision Proposition Details (this schema)
xdm:selections Decision Option Details Optional Decision Proposition Details (this schema)
* any Additional this schema allows additional properties

xdm:activity

Decision Activity Snapshot

Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. In the future, this will be deprecated in favor of scopeDetails.activity.

xdm:activity

  • is optional
  • type: Decision Activity Details
  • defined in this schema

xdm:activity Type

xdm:channel

Channel (deprecated)

The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'. (deprecated), use scope.placement.channel instead.

xdm:channel

  • is optional
  • type: string
  • defined in this schema

xdm:channel Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:fallback

Fallback Option Snapshot

Snapshot of the fixed fallback option that was selected because no available option satisfied all constraints. The object contains at least the xdm:id property value which is the identifier of the fallback action. Note that the intention is that either the selections or the fallback property is required. In the future, this will be deprecated in favor of scopeDetails.activity.fallback.

xdm:fallback

  • is optional
  • type: Decision Option Details
  • defined in this schema

xdm:fallback Type

xdm:placement

Placement Snapshot

Snapshot of the placement for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the placement. In the future, this will be deprecated in favor of scopeDetails.placement.

xdm:placement

  • is optional
  • type: Decision Placement Detail
  • defined in this schema

xdm:placement Type

xdm:selections

Selected Options' Snapshot

Snapshot of the options that were selected by this activity. The objects contain a at least the xdm:id property value which is the identifier of an option. The intention is that either the selections or the fallback property is required. In the future, this will be deprecated in favor of items.

xdm:selections

  • is optional
  • type: Decision Option Details
  • at least 1 items in the array
  • defined in this schema

xdm:selections Type

Array type: Decision Option Details

All items must be of the type: