Skip to content

Latest commit

 

History

History
240 lines (127 loc) · 7.61 KB

offer-detail.schema.md

File metadata and controls

240 lines (127 loc) · 7.61 KB
Raw

Offer Detail Schema

https://ns.adobe.com/experience/offer-management/offer-detail

Offer detail is used to capture the attributes of an offer in a proposition or response. Offers are the decision options in the offer management domain and the offer detail datatype extends the option detail datatype.

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

Schema Hierarchy

  • Offer Detail https://ns.adobe.com/experience/offer-management/offer-detail

Offer Detail Example

{
  "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
  "xdm:name": "Beach Vacations",
  "xdm:tags": [
    "xcore:tag:f68535bc217322e",
    "xcore:tag:f66f67dbe6d6ee1"
  ],
  "xdm:characteristics": {
    "cost": "$2400",
    "inventoryId": "BORA04",
    "country": "French Polynesia"
  }
}

Offer Detail Properties

Property Type Required Defined by
https://ns.adobe.com/experience/decisioning/propositionsProfile Measure Optional Decision Option Details
https://ns.adobe.com/experience/decisioning/propositionsTotal Measure Optional Decision Option Details
repo:etag string Optional Decision Option Details
xdm:characteristics object Optional Decision Option Details
xdm:id string Optional Decision Option Details
xdm:name string Optional Decision Option Details
xdm:optionContent Content Component Details Optional Decision Option Details
xdm:score number Optional Decision Option Details
xdm:tags string[] Optional Decision Option Details
* any Additional this schema allows additional properties

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

The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile.

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

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

  • Measure – https://ns.adobe.com/xdm/data/measure

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

The total number a particular option was proposed so far across all profiles.

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

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

  • Measure – https://ns.adobe.com/xdm/data/measure

repo:etag

Decision Option ETag

The revision that the decision option object was at when the snapshot was taken.

repo:etag

repo:etag Type

string

xdm:characteristics

Decision Option Characteristics

Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail.

xdm:characteristics

xdm:characteristics Type

object with following properties:

Property Type Required

xdm:id

Decision Option Identifier

A unique identifier for the decision option.

xdm:id

xdm:id Type

string

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

xdm:name

Decision Option Name

Option name. The name is displayed in various user interfaces.

xdm:name

xdm:name Type

string

xdm:optionContent

Option Content

Additional properties or attributes related to offer content

xdm:optionContent

xdm:optionContent Type

xdm:score

Decision Option Score

Calcuated value for that option in the context of a single scope. The value is only available if a score was calculated.

xdm:score

xdm:score Type

number

  • minimum value: 0

xdm:tags

Decision Option Tags

The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made.

xdm:tags

xdm: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