Skip to content

profile-constraint-details.schema.md

Latest commit

 

History

History
150 lines (94 loc) · 5.28 KB

profile-constraint-details.schema.md

File metadata and controls

150 lines (94 loc) · 5.28 KB

Profile Constraint Details Schema

https://ns.adobe.com/experience/decisioning/profile-constraint-details

Profile constraints define the policies that ensure a particular decision option qualifies, is relevant and is suitable for a particular profile. Such policy rules determine the eligibility, applicability and suitability of the option. Usually the option is tested against a user profile and the events that were observed for that profile, but the qualification rule can consider any context data as long as it can be described by an XDM schema.

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

Profile Constraint Details Examples

{
  "https://ns.adobe.com/experience/decisioning/profileConstraintType": "eligibilityRule",
  "https://ns.adobe.com/experience/decisioning/eligibilityRule": "xcore:eligibility-rule:e5244c22eff29e8"
}
{
  "https://ns.adobe.com/experience/decisioning/profileConstraintType": "none"
}
{
  "https://ns.adobe.com/experience/decisioning/profileConstraintType": "anySegments",
  "https://ns.adobe.com/experience/decisioning/segmentIdentities": [
    {
      "@id": "https://data.adobe.io/entities/segmentIdentity/id123",
      "xdm:namespace": {
        "xdm:code": "AA12345"
      }
    },
    {
      "@id": "https://data.adobe.io/entities/segmentIdentity/id456",
      "xdm:namespace": {
        "xdm:code": "AA12345"
      }
    }
  ]
}

Profile Constraint Details Properties

Property Type Required Default Defined by
xdm:description string Optional Profile Constraint Details (this schema)
xdm:eligibilityRule string Optional Profile Constraint Details (this schema)
xdm:profileConstraintType enum Optional "none" Profile Constraint Details (this schema)
xdm:segmentIdentities Segment identity Optional Profile Constraint Details (this schema)
* any Additional this schema allows additional properties

xdm:description

Description

Profile constraint description. It is used to convey human readable intentions on how or why this profile constraint was constructed and/or what option will be included or excluded by it.

xdm:description

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

xdm:description Type

string

xdm:eligibilityRule

Eligibility Rule

A reference to a decision rule that evaluates to true or false for a given profile and/or other given contextual XDM objects. The rule is used to decide if the option qualifies for a given profile. The value is the URI (@id) of the decision rule that is referenced. See schema https://ns.adobe.com/experience/decisioning/rule

xdm:eligibilityRule

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

xdm:eligibilityRule Type

string

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

xdm:profileConstraintType

Profile Constraint Type

Determines if any constraints are currently set and how the contraints are expressed. It could be though a rule or through one or more segment memberships.

xdm:profileConstraintType

  • is optional
  • type: enum
  • default: "none"
  • defined in this schema

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

xdm:profileConstraintType Known Values

Value Description
none
eligibilityRule The profile constraint is expressed as a single rule that must evaluate to true before the constrained action is allowed
anySegments The profile constraint is expressed as one or more segments and the profile must be a member of at least one of them before the constrained action is allowed
allSegments The profile constraint is expressed as one or more segments and the profile must be a member of all of them before the constrained action is allowed
rules The profile constraint is expressed as a number of different rules, e.g. eligibility, applicability, suitability, which all must evaluate to true before the constrained action is allowed

xdm:segmentIdentities

Segment Identifiers

Identifiers of the segments

xdm:segmentIdentities

  • is optional

  • type: Segment identity

  • defined in this schema

xdm:segmentIdentities Type

Array type: Segment identity

All items must be of the type: