proposition-interaction-detail.schema.json

{
    "meta:license": [
        "Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/decisioning/proposition-interaction-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Proposition Interaction Details",
    "type": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "description": "A proposition interaction is used to report an experience event that relates to a prior decision proposition. The decision proposition is assumed to have contributed to the experience and the unique decision ID is added to the experience event.",
    "definitions": {
        "proposition-interaction-detail-datatype": {
            "type": "object",
            "properties": {
                "xdm:id": {
                    "type": "string",
                    "title": "Decision Proposition Identifier",
                    "description": "The unique identifier of the proposition that originally contained the decision options that are being acted upon (see the corresponding 'items' field in this object). When this identifier is present, direct attribution is given to a unique proposition. If the identifier is missing, the action for the items could not be assiciated with a unique proposition.",
                    "meta:titleId": "proposition-interaction-details##xdm:id##title##39041",
                    "meta:descriptionId": "proposition-interaction-details##xdm:id##description##601"
                },
                "xdm:scope": {
                    "type": "string",
                    "title": "Decision Scope",
                    "description": "The scope that is associated with the decision. This is the name of the scope that was in the request when the decision was made.",
                    "meta:titleId": "proposition-interaction-details##xdm:scope##title##37661",
                    "meta:descriptionId": "proposition-interaction-details##xdm:scope##description##27021"
                },
                "xdm:items": {
                    "type": "array",
                    "title": "Selected Options",
                    "description": "One or more of the previously proposed options that this experience event is related to. Those items were returned as output of the decision for a requested scope and are now part of an interaction. For instance, if the decision returned five proposed videos to watch and the user selected two in a \"Save For Later\" interaction, then this experience event could record the user's reaction with an event type \"custom.savedToWatchLater\" and list the two selected videos in the 'items' array.",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/decisioning/option-detail",
                        "description": "An item from the proposition's options. See 'selections' of the 'Decision Proposition Detail' mix-in.",
                        "meta:descriptionId": "proposition-interaction-details##items##description##99371"
                    },
                    "meta:titleId": "proposition-interaction-details##xdm:items##title##59961",
                    "meta:descriptionId": "proposition-interaction-details##xdm:items##description##42051"
                },
                "xdm:scopeDetails": {
                    "$ref": "https://ns.adobe.com/experience/decisioning/scope-details",
                    "title": "Decision Scope Snapshot",
                    "description": "A snapshot of properties from the decision scope. This is the state of the scope entity that was used in the decision requst.",
                    "meta:titleId": "proposition-interaction-details##xdm:scopeDetails##title##49471",
                    "meta:descriptionId": "proposition-interaction-details##xdm:scopeDetails##description##14071"
                },
                "xdm:decisionEventID": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "title": "Decision Event Identifier (deprecated)",
                    "description": "The unique identifier of the decision event that proposed the 'items' (options). For a given decision request and profile identity the output of the decision is a unique event. If a decision is requested again for the same profile and the output are the same options, it is still considered a different proposition with a unique event ID. Multiple propositions can be associated with the same decision event. See https://ns.adobe.com/experience/decisioning/proposition. (deprecated)",
                    "meta:titleId": "proposition-interaction-details##xdm:decisionEventID##title##2971",
                    "meta:descriptionId": "proposition-interaction-details##xdm:decisionEventID##description##58071"
                },
                "xdm:decisionEventDetails": {
                    "meta:status": "deprecated",
                    "$ref": "https://ns.adobe.com/experience/decisioning/decisionevent-details",
                    "title": "Decision Event Details (deprecated)",
                    "description": "A snapshot of properties from the decision event when it occured. (deprecated)",
                    "meta:titleId": "proposition-interaction-details##xdm:decisionEventDetails##title##37351",
                    "meta:descriptionId": "proposition-interaction-details##xdm:decisionEventDetails##description##79441"
                },
                "xdm:decisionScope": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "title": "Decision Event Scope (deprecated)",
                    "description": "The scope that is associated with the decision. This is the name of the scope that was in the request when the decision was made. See https://ns.adobe.com/experience/decisioning/scope-details.(deprecated)",
                    "meta:titleId": "proposition-interaction-details##xdm:decisionScope##title##11981",
                    "meta:descriptionId": "proposition-interaction-details##xdm:decisionScope##description##25091"
                },
                "xdm:decisionScopeDetails": {
                    "meta:status": "deprecated",
                    "$ref": "https://ns.adobe.com/experience/decisioning/scope-details",
                    "title": "Decision Event Scope Details (deprecated)",
                    "description": "A snapshot of properties from the decision scope. This is the state of the scope entity that was used in the decision requst. (deprecated)",
                    "meta:titleId": "proposition-interaction-details##xdm:decisionScopeDetails##title##67901",
                    "meta:descriptionId": "proposition-interaction-details##xdm:decisionScopeDetails##description##66451"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/proposition-interaction-detail-datatype"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "proposition-interaction-details##title##50231",
    "meta:descriptionId": "proposition-interaction-details##description##80651",
    "examples": [
        {
            "xdm:items": [
                {
                    "xdm:id": "ExperienceB",
                    "xdm:data": {
                        "type": "setHtml",
                        "content": "<div class='banner_img d-none d-lg-block'><img src='https://contentviewer.s3.amazonaws.com/helium/women_banner.jpeg?w=780&amp;h=408&amp;crop=1' alt=''>\n</div>",
                        "selector": "#root > DIV.react-spectrum-provider:eq(0) > DIV.app-wrapper:eq(0) > DIV.app-content:eq(0) > DIV:nth-of-type(1) > SECTION.banner_part:eq(0)",
                        "prehidingSelector": "#root > DIV:nth-of-type(1) > DIV:nth-of-type(1) > DIV:nth-of-type(2) > DIV:nth-of-type(1) > SECTION:nth-of-type(1)"
                    }
                }
            ],
            "xdm:id": "AT:eyJhY3Rpdml0eUlkIjoiMzg0NDU5IiwiZXhwZXJpZW5jZUlkIjoiMSJ9",
            "xdm:scope": "home",
            "xdm:scopeDetails": {
                "xdm:activity": {
                    "xdm:id": "384459",
                    "repo:etag": "8"
                },
                "xdm:experience": {
                    "xdm:id": "ExperienceB"
                },
                "xdm:strategies": [
                    {
                        "xdm:step": "targeting",
                        "xdm:algorithmID": "randomuniform",
                        "xdm:trafficType": "noncontextual"
                    }
                ],
                "xdm:characteristics": {
                    "prop1": "Value 1",
                    "prop2": "Value 2"
                }
            }
        },
        {
            "xdm:items": [
                {
                    "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
                    "repo:etag": "5",
                    "xdm:score": 83,
                    "xdm:propositionsTotal": {
                        "xdm:value": 948
                    }
                },
                {
                    "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9",
                    "repo:etag": "3",
                    "xdm:score": 12,
                    "xdm:propositionsTotal": {
                        "xdm:value": 221
                    }
                }
            ],
            "xdm:id": "3cc33a7e-13ca-4b19-b25d-c816eff9a70a",
            "xdm:scope": "home-page-banner",
            "xdm:scopeDetails": {
                "xdm:id": "home-page-banner",
                "xdm:placement": {
                    "xdm:id": "xcore:offer-placement:c652463157c2aa1",
                    "repo:etag": "4",
                    "xdm:name": "Home Page Banner"
                },
                "xdm:activity": {
                    "xdm:id": "xcore:offer-activity:ebc48132c26ccfc",
                    "repo:etag": "8",
                    "xdm:name": "Spring 21 Campaign Web"
                },
                "xdm:strategies": [
                    {
                        "xdm:step": "eligibility",
                        "xdm:strategyID": "xcore:eligibility-rule:e5244c22eff29e8",
                        "xdm:algorithmID": "pql-rule",
                        "xdm:trafficType": "contextual"
                    },
                    {
                        "xdm:step": "ranking",
                        "xdm:strategyID": "ranking-strategy:7251468357c2236",
                        "xdm:algorithmID": "auto-optimize",
                        "xdm:trafficType": "noncontextual"
                    }
                ],
                "xdm:characteristics": {
                    "prop1": "Value 1",
                    "prop2": "Value 2"
                }
            }
        }
    ]
}