Skip to content

Latest commit

 

History

History
207 lines (128 loc) · 10.1 KB

personalized-content-option.schema.md

File metadata and controls

207 lines (128 loc) · 10.1 KB
Raw

Personalized Content Decision Option Schema

https://ns.adobe.com/experience/decisioning/personalized-content-option

Personalized decision options form the set of choices for any decision actvity. The objective for decisioning is to take a large inventory of items and apply numerous constraint rules to that inventory to narrow it down and then to rank the qualifying options according to a criteria. The resulting propositions assemble and personalize the experience for specific individuals.

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

Schema Hierarchy

Personalized Content Decision Option Example

{
  "@id": "xcore:personalized-offer:e526a1503bf29e9",
  "https://ns.adobe.com/experience/decisioning/name": "Personalized Offer 1",
  "https://ns.adobe.com/experience/decisioning/status": "approved",
  "https://ns.adobe.com/experience/decisioning/contents": [
    {
      "https://ns.adobe.com/experience/decisioning/components": [
        {
          "https://ns.adobe.com/experience/decisioning/content": "You can always get what you want!",
          "@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
          "dc:format": "text/template"
        }
      ],
      "https://ns.adobe.com/experience/decisioning/placement": "xcore:offer-placement:e51944a87919861"
    }
  ],
  "https://ns.adobe.com/experience/decisioning/tags": [
    "xcore:tag:e5196f1d9119862"
  ],
  "https://ns.adobe.com/experience/decisioning/calendarConstraints": {
    "https://ns.adobe.com/experience/decisioning/startDate": "2018-03-13T05:59:18.914Z",
    "https://ns.adobe.com/experience/decisioning/endDate": "2018-12-27T05:59:18.914Z"
  },
  "https://ns.adobe.com/experience/decisioning/profileConstraints": {
    "https://ns.adobe.com/experience/decisioning/profileConstraintType": "rules",
    "https://ns.adobe.com/experience/decisioning/eligibilityRule": "xcore:eligibility-rule:e5244c22eff29e8"
  },
  "https://ns.adobe.com/experience/decisioning/ranking": {
    "https://ns.adobe.com/experience/decisioning/priority": 1
  }
}

Personalized Content Decision Option Properties

Property Type Required Defined by
https://ns.adobe.com/experience/decisioning/calendarConstraints Calendar Constraint Details Optional Decision Option Calendar Constraints
https://ns.adobe.com/experience/decisioning/contents Content Details Optional Decision Option Contents
https://ns.adobe.com/experience/decisioning/lifecycleStatus enum Optional Decision Option Lifecycle Status
https://ns.adobe.com/experience/decisioning/profileConstraints Profile Constraint Details Optional Decision Option Profile Constraints
https://ns.adobe.com/experience/decisioning/ranking Ranking Details Optional Decision Option Ranking
https://ns.adobe.com/experience/decisioning/tags string[] Optional Decisioning Option Tags
* any Additional this schema allows additional properties

https://ns.adobe.com/experience/decisioning/calendarConstraints

Calendar Constraint Details

Calendar constraints decide if a decision option is valid given a date range. Outside that date range the option cannot be proposed.

https://ns.adobe.com/experience/decisioning/calendarConstraints

https://ns.adobe.com/experience/decisioning/calendarConstraints Type

https://ns.adobe.com/experience/decisioning/contents

Content Details

Content items to render the decision item in different contexts. A single decision option can have multiple contents variants. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels into a particular placement.

https://ns.adobe.com/experience/decisioning/contents

https://ns.adobe.com/experience/decisioning/contents Type

Array type: Content Details

All items must be of the type:

  • Content Details – https://ns.adobe.com/experience/decisioning/content-details

https://ns.adobe.com/experience/decisioning/lifecycleStatus

Lifecycle Status

Lifecycle status allows workflows to be conducted with an object. The status may affect where an object is visible or considered relevant. Status changes are driven by the clients or services that use the objects.

https://ns.adobe.com/experience/decisioning/lifecycleStatus

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/decisioning/lifecycleStatus Known Values

Value Description
draft Draft
approved Approved
live Live
completed Completed
archived Archived

https://ns.adobe.com/experience/decisioning/profileConstraints

Profile Constraint Details

The profile constraints decide if an option is eligible for this profile identity, at this moment, in this context. If the profile constraint does not need to consider values of each of the option, i.e. it is invariant of the options from the option selection, the profile constraint that evaluates to 'false' cancels out the entire option selection. On the other hand, a profile constraint rule that takes an option as a parameter is evaluated for each qualifiying option of the option selection.

https://ns.adobe.com/experience/decisioning/profileConstraints

https://ns.adobe.com/experience/decisioning/profileConstraints Type

https://ns.adobe.com/experience/decisioning/ranking

Ranking Details

Rank (priority). Defines what is considered the "best action" given the context of the decision criterion. Among all the selected options that meet the eligibility constraint, the ranking order will decide the top (or top N) option(s) to be proposed.

https://ns.adobe.com/experience/decisioning/ranking

https://ns.adobe.com/experience/decisioning/ranking Type

  • Ranking Details – https://ns.adobe.com/experience/decisioning/ranking-details

https://ns.adobe.com/experience/decisioning/tags

Tags

The set of tags associated with this entity. The tags are used in filter expressions to constrain the overall inventory to a sub set (category).

https://ns.adobe.com/experience/decisioning/tags

https://ns.adobe.com/experience/decisioning/tags Type

Array type: string[]

All items must be of the type: string

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

An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/decisioning/tag