xdm/docs/reference/datatypes/advertising-timed-asset-reference.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
    "meta:license": [
        "Copyright 2018 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/xdm/context/advertising-timed-asset-reference",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Ad asset reference",
    "type": "object",
    "description": "Ad asset reference is info about the ad captured by the experience event.",
    "meta:extensible": true,
    "definitions": {
        "adAssetReference": {
            "properties": {
                "@id": {
                    "title": "Ad ID",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "Identifier of the ad asset provided by media analytics customers. Following the Ad-ID standard [https://www.ad-id.org]."
                },
                "xdm:creativeID": {
                    "title": "Ad creative ID",
                    "type": "string",
                    "description": "The ID of the ad creative."
                },
                "xdm:creativeURL": {
                    "title": "Ad creative URL",
                    "type": "string",
                    "description": "The URL of the ad creative."
                },
                "xdm:siteID": {
                    "title": "Ad site ID",
                    "type": "string",
                    "description": "ID of the ad site."
                },
                "xdm:placementID": {
                    "title": "Ad placement ID",
                    "type": "string",
                    "description": "Placement ID of the ad."
                },
                "dc:title": {
                    "title": "Ad name",
                    "type": "string",
                    "description": "The friendly and human-readable name of the ad asset."
                },
                "xdm:advertiser": {
                    "title": "Ad advertiser",
                    "type": "string",
                    "description": "Company/Brand whose product is featured in the ad."
                },
                "xdm:campaign": {
                    "title": "Ad campaign",
                    "type": "string",
                    "description": "ID of the ad campaign."
                },
                "xmpDM:duration": {
                    "title": "Ad length or duration",
                    "type": "integer",
                    "description": "Length or duration of ad asset in seconds."
                }
            },
            "required": [
                "@id"
            ]
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/adAssetReference"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "@id": "https://data.adobe.io/entities/asser-reference/23423",
            "xdm:creativeID": "6738737",
            "dc:title": "Acme offer 21",
            "xmpDM:duration": 23
        }
    ]
}