AWS mediatailor documentation change
Summary
Restructured documentation to use JSON schema examples, added detailed property paths/VAST mappings, and expanded property descriptions
Security assessment
Changes focus on improving schema documentation structure and clarity. While adVerifications/security-adjacent fields (executableResource, verificationParameters) are documented, this represents enhanced documentation of existing security features rather than addressing vulnerabilities or adding new security content. No evidence of CVE fixes or incident response.
Diff
diff --git a/mediatailor/latest/ug/ad-reporting-client-side-ad-tracking-schema.md b/mediatailor/latest/ug/ad-reporting-client-side-ad-tracking-schema.md index e45966a00..536adacbb 100644 --- a//mediatailor/latest/ug/ad-reporting-client-side-ad-tracking-schema.md +++ b//mediatailor/latest/ug/ad-reporting-client-side-ad-tracking-schema.md @@ -11,9 +10,0 @@ With the MediaTailor client-side ad-tracking feature, you can integrate detailed -###### Contents - - * [Schema](./ad-reporting-client-side-ad-tracking-schema.html#ad-reporting-client-side-ad-tracking-schema-table) - - * [Properties](./ad-reporting-client-side-ad-tracking-schema.html#ad-reporting-client-side-ad-tracking-schema-properties) - - - - @@ -22,144 +13,183 @@ With the MediaTailor client-side ad-tracking feature, you can integrate detailed -The following table describes the MediaTailor client-side ad-tracking schema. Where applicable, the table maps the schema to VAST data. - -Key | Data type | Child keys | Mapping from VAST 2.0/3.0 | Mapping from VAST 4.0 | Description ----|---|---|---|---|--- -Response JSON -- | Object | avails, nonLinearAvails | | | -`/avails` | Array | | | | -MediaTailor creates one object for each avail (ad break) inside the manifest window. | | ads, adType, availID, duration, durationInSeconds, startTime, startTimeInSeconds, dateTime | | | -`/ads` | Array | | | | -MediaTailor creates one object for each ad inside the avail period. | Object | adID, adType, adParameters, adVerifications, companionAds, duration, durationInSeconds, extensions, icons, mediaFile, startTime, startTimeInSeconds, dateTime, adBreakTrackingEvents | | | -`/adId` | String | | | | - - * HLS - the sequence number associated with the beginning of the ad - * DASH - the period ID of the ad - - -`/adParameters` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters` | | String of ad parameters from the VAST VPAID that MediaTailor passes to the player -`/adVerifications` | Array | `VAST/Ad/InLine/AdVerifications` | | | Contains the resources and metadata required to execute third-party measurement code in order to verify creative playback -MediaTailor creates an object for each ad-verification element. | Object | executableResource, javaScriptResource, vendor, verificationParameters | | | -`/executableResource` | Array | | `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource` | | -MediaTailor creates an object for each `executableResource` element. | Object | apiFramework, adType, uri, language | | | -`/apiFramework` | String | | `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@apiFramework` | | -`/type` | String | | | -`/uri` | String | | `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/#CDATA` | | -`/language` | String | | `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@language` | `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@language` | -`/javaScriptResource` | Array | | `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource` | | -MediaTailor creates an object for each `javaScriptResource` element. | Object | apiFramework, browserOptional, uri | | | -`/apiFramework` | String | | `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@apiFramework` | | -`/browserOptional` | String | | `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@browserOptional` | | -`/uri` | String | | `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/#CDATA` | | -`/trackingEvents` | Array | | | | -MediaTailor creates an object for each ad-verification element tracking-event type. | Object | event, uri | | | -`/event` | String | | `VAST/Ad/InLine/AdVerifications/Verification/TrackingEvents/Tracking/@event` | | -`/uri` | String | | `VAST/Ad/InLine/AdVerifications/Verification/TrackingEvents/Tracking/#CDATA` | | -`/vendor` | String | | `VAST/Ad/InLine/AdVerifications/Verification/@vendor` | | -`/verificationParameters` | String | | `VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters` | | -`/companionAds` | Array | | | | Companion ads, which accompany the ad avail, provide content like a frame around the ad or a banner to display near the video. -MediaTailor creates an object for each companion-ad element. | Object | adParameters, altText, attributes, companionClickThrough, companionClickTracking, htmlResource, sequence, staticResource, trackingEvents | `VAST/Ad/InLine/Creatives/Creative/CompanionAds` | | -`/adParameters` | String | | | | -`/altText` | String | | | | -`/attributes` | Object | adSlotId, apiFramework, assetHeight, assetWidth, expandedHeight, expandedWidth, height, id, pxratio, renderingMode, width | | | -`/adSlotId` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@adSlotId` | | -`/apiFramework` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@apiFramework` | | -`/assetHeight` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@assetHeight` | | -`/assetWidth` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@assetWidth` | | -`/expandedHeight` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@expandedHeight` | | -`/expandedWidth` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@expandedWidth` | | -`/height` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@height` | | -`/id` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@id` | | -`/pxratio` | String | | | | -`/renderingMode` | String | | | | -`/width` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@width` | | -`/companionClickThrough` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough` | | -`/companionClickTracking` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking` | | -`/htmlResource` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource` | | -`/iFrameResource` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource` | | -`/sequence` | String | | | | -`/staticResource` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/StaticResource` | | -`/trackingEvents` | Array | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents` | | -MediaTailor creates an object for each companion-ad element-tracking event type. | | | | | -`/tracking` | Object | >event, uri | | | -`/event` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/@event` | | -`/uri` | String | | `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/#CDATA` | | -`/duration` | String | | | | Length, in ISO 8601 seconds format -`/durationInSeconds` | Number | | | | Length, in seconds format -`/extensions` | Array | | | | Ad servers can use custom VAST extensions -MediaTailor creates an object for each child extension of the `extensions` element. | | | `VAST/Ad/InLine/Extensions` | | -`/extension` | Object | type, content | `VAST/Ad/InLine/Extensions/Extension` | | -`/type` | String | | `VAST/Ad/InLine/Extensions/Extension/@type` | | -`/content` | String | | | | -`/icons` | Array | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons` | | -MediaTailor creates an object for each `icon` element within `icons`. | Object | attributes, dateTime, duration, durationInSeconds, htmlResource, iconClicks, iconViewTracking, iFrameResource, staticResource, startTime, startTimeInSeconds | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon` | | -`/attributes` | Object | apiFramework, duration, height, offset, program, pxratio, width, xPosition, yPosition | | | -`/apiFramework` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@apiFramework` | | -`/duration` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@duration` | | -`/height` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@height` | | -`/offset` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@offset` | | -`/program` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@program` | | -`/pxratio` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@pxratio` | | -`/width` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@width` | | -`/xPosition` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@xPosition` | | -`/yPosition` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@yPosition` | | -`/dateTime` | String | | | | -`/duration` | String | | | | -`/durationInSeconds` | Number | | | | -`/htmlResource` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/HTMLResource` | | -`/iconClicks` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks` | | -`/iconClickThrough` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickThrough` | | -`/iconClickTracking` | Object | id | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickTracking` | | -`/id` | String | | | | -`/iconClickFallbackImages` | Array | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages` | | -MediaTailor creates an object for each icon-click fallback-image node. | | | | | -`/altText` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/AltText` | | -`/height` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/@height` | | -`/width` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/@width` | | -`/staticResource` | Object | creativeType, uri | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource` | | -`/creativeType` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource/@creativeType` | | -`/uri` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource/#CDATA` | | -`/iconViewTracking` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconViewTracking` | | -`/iFrameResource` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/iFrameResource` | | -`/statidResource` | Object | creativeType, uri | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource` | | -`/creativeType` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/@type` | | -`/uri` | String | | `VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/#CDATA` | | -`/startTime` | String | | | | -`/startTimeInSeconds` | Number | | | | -`/mediaFiles` | Object | adParameters, duration, durationInSeconds, mediaFilesList, mezzanine, startTime, startTimeInSeconds, trackingEvents | | | Video and other assets that the player needs for the ad avail -`/adParameters` | String | | | | -`/duration` | String | | | | -`/durationInSeconds` | Number | | | | -`/mediaFilesList` | Array | | | | -MediaTailor creates an object for each companion-ad element-tracking event type | | apiFramework, delivery, height, maintainAspectRatio, mediaFileUri, mediaType, scalable, width | | | -`/apiFramework` | String | | | | -`/delivery` | String | | | | -`/height` | String | | | | -`/maintainAspectRatio` | String | | | | -`/mediaFileUri` | String | | | | -`/mediaType` | String | | | | -`/scalable` | String | | | | -`/width` | String | | | | -`/mezzanine` | String | | | | -`/startTime` | String | | | | -`/startTimeInSeconds` | String | | | | -`/trackingEvents` | Array | | | | -MediaTailor creates an object for each tracking event for the creative | | beaconUrls, duration, durationInSeconds, dateTime, eventId, eventType, startTime, startTimeInSeconds | | | -`/beaconUrls` | Array | | | | -A comma-separated list of all tracking URLs for this event | | | | | -`/duration` | String | | | | -`/durationInSeconds` | Number | | | | -`/dateTime` | String | | | | -`/eventId` | String | | | | -`/eventType` | String | | | | -`/startTime` | String | | | | -`/startTimeInSeconds` | Number | | | | -`/startTime` | String | | | | Time position, in ISO 8601 seconds format, relative to the beginning of the playback session -`/startTimeInSeconds` | Number | | | | Time position, in seconds format, relative to the beginning of the playback session -`/dateTime` | String | | | | Program date time, in ISO 8601 seconds format, for the start of the ad avail -`/trackingEvents` | Array | | | | Contains all tracking-event data that was received in the VAST response, along with timing information -`/adType` | String | | | | -`/availId` | String | | | | -`/dateTime` | String | | | | -`/duration` | String | | | | -`/durationInSeconds` | Number | | | | -`/startTime` | String | | | | -`/startTimeInSeconds` | Number | | | | +The following JSON structure shows the MediaTailor client-side ad-tracking schema. This representation illustrates the nesting structure of the schema to help you understand the relationships between different parts. + +For detailed information about each property, see Properties. + + + { + "avails": [ + { + "ads": [ + { + "adID": "string", + "adParameters": "string", + "adSystem": "string", + "adTitle": "string", + "adVerifications": [ + { + "executableResource": [ + { + "apiFramework": "string", + "type": "string", + "uri": "string", + "language": "string" + } + ], + "javaScriptResource": [ + { + "apiFramework": "string", + "browserOptional": "string", + "uri": "string" + } + ], + "trackingEvents": [ + { + "event": "string", + "uri": "string" + } + ], + "vendor": "string", + "verificationParameters": "string" + } + ],