|
| 1 | +{ |
| 2 | + "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#", |
| 3 | + "description": "Context Schema attached to interactive_hotspot_click_event and interactive_overlay_panel_click_event.", |
| 4 | + "self": { |
| 5 | + "vendor": "com.vimeo", |
| 6 | + "name": "interaction", |
| 7 | + "format": "jsonschema", |
| 8 | + "version": "1-0-0" |
| 9 | + }, |
| 10 | + "type": "object", |
| 11 | + "properties": { |
| 12 | + "action": { |
| 13 | + "type": "string", |
| 14 | + "description": "The action type of the hotspot.", |
| 15 | + "maxLength": 4096 |
| 16 | + }, |
| 17 | + "actionPreference": { |
| 18 | + "type": "object", |
| 19 | + "description": "The user's preferred action type for the hotspot.", |
| 20 | + "properties": { |
| 21 | + "pauseOnAction": { |
| 22 | + "type": [ |
| 23 | + "boolean", |
| 24 | + "null" |
| 25 | + ], |
| 26 | + "description": "Whether to pause when the action type is overlay, url, seek, event, or none." |
| 27 | + }, |
| 28 | + "overlayId": { |
| 29 | + "type": [ |
| 30 | + "string", |
| 31 | + "null" |
| 32 | + ], |
| 33 | + "description": "When action is overlay, the displayed unique ID for the overlay when the hotspot is clicked.", |
| 34 | + "maxLength": 4096 |
| 35 | + }, |
| 36 | + "seekTo": { |
| 37 | + "type": [ |
| 38 | + "number", |
| 39 | + "null" |
| 40 | + ], |
| 41 | + "description": "When action is seek, the time in seconds that the video should jump to when the hotspot is clicked.", |
| 42 | + "minimum": 0, |
| 43 | + "maximum": 2147483647 |
| 44 | + }, |
| 45 | + "seekToFrame": { |
| 46 | + "type": [ |
| 47 | + "number", |
| 48 | + "null" |
| 49 | + ], |
| 50 | + "description": "When action is seek, the frame that the video should jump to when the hotspot is clicked.", |
| 51 | + "minimum": 0, |
| 52 | + "maximum": 2147483647 |
| 53 | + }, |
| 54 | + "url": { |
| 55 | + "format": "uri", |
| 56 | + "type": [ |
| 57 | + "string", |
| 58 | + "null" |
| 59 | + ], |
| 60 | + "description": "When action is clickthrough, the target URL when the overlay panel is clicked.", |
| 61 | + "maxLength": 4096 |
| 62 | + } |
| 63 | + }, |
| 64 | + "additionalProperties": false |
| 65 | + }, |
| 66 | + "customPayloadData": { |
| 67 | + "type": [ |
| 68 | + "object", |
| 69 | + "null" |
| 70 | + ], |
| 71 | + "description": "The custom payload data of the interactive hotspot", |
| 72 | + "additionalProperties": true |
| 73 | + }, |
| 74 | + "currentTime": { |
| 75 | + "type": [ |
| 76 | + "number", |
| 77 | + "null" |
| 78 | + ], |
| 79 | + "description": "The current time of the video when the interaction occurs is clicked.", |
| 80 | + "minimum": 0, |
| 81 | + "maximum": 2147483647 |
| 82 | + }, |
| 83 | + "hotspotId": { |
| 84 | + "type": [ |
| 85 | + "string", |
| 86 | + "null" |
| 87 | + ], |
| 88 | + "description": "The unique ID for the hotspot.", |
| 89 | + "maxLength": 4096 |
| 90 | + }, |
| 91 | + "panelId": { |
| 92 | + "type": [ |
| 93 | + "string", |
| 94 | + "null" |
| 95 | + ], |
| 96 | + "description": "The unique ID for a panel within the overlay.", |
| 97 | + "maxLength": 36, |
| 98 | + "minLength": 1 |
| 99 | + }, |
| 100 | + "overlayId": { |
| 101 | + "type": [ |
| 102 | + "string", |
| 103 | + "null" |
| 104 | + ], |
| 105 | + "description": "When action is overlay, the displayed unique ID for the overlay when the hotspot is clicked.", |
| 106 | + "maxLength": 4096 |
| 107 | + } |
| 108 | + }, |
| 109 | + "required": [ |
| 110 | + "action", |
| 111 | + "actionPreference" |
| 112 | + ], |
| 113 | + "additionalProperties": false |
| 114 | +} |
0 commit comments