vastSmartElement Object – API Help Center

Related Entities

Endpoints Using the vastSmartElement Object

AdVersion Resource

Parent Objects

AdVersion Object

vastSmartElement Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Read-only	AdSmartVideoElement
id	Internal.	Internal	Read-only
svKey	Name of the dynamic element.	String	Read-only
value	Object that includes the different attributes of the assigned video.	value Object (vastSmartElement)	Read-only
smartElementSource	Source from which the dynamic element was created.	String	Read-only

Object JSON Example

"vastSmartElement": {
    "type": "AdSmartVideoElement",
    "id": 21323027994211,
    "svKey": "primary_video",
    "value": {
        "type": "AdSmartElementVideoReferenceValue",
        "publishPath": "HostingServices/TC/live/NE_Tundra_H264_720p_2500kbps.mp4",
        "assetId": 2077389533,
        "name": "H264_720p_2500kbps.mp4",
        "width": "1280",
        "height": "720",
        "bitRate": 2482,
        "relativePathInWorkspace": null,
        "duration": "00:00:15",
        "mimetype": "video/mp4",
        "fullPathURL": "https://services.serving-sys.com/HostingServices/TC/live/NE_Tundra_H264_720p_2500kbps.mp4",
        "thumbnailURL": "http://ds.serving-sys.com/resources/PROD/thumbnail/15496/20181213/41931899147387014.png",
        "stringValue": "H264_720p_2500kbps.mp4",
        "relativePath": false,
        "value": "H264_720p_2500kbps.mp4"
    },
    "smartElementSource": "System"
}

value Object (vastSmartElement)

value Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Read-only	AdSmartElementVideoReferenceValue
publishPath	Location of file in storage.	String	Read-only
assetId	ID of the video asset.	Long	Read-only
name	Name of the asset.	String	Read-only
width	Width of the asset.	Integer	Read-only
height	Height (dimensions) of the asset.	Integer	Read-only
bitRate	Bit rate of the asset.	Integer	Read-only
relativePathInWorkspace	Internal.	Internal	Internal
duration	Video duration.	Integer	Read-only
mimetype	Media type MIME Type definition.	String	Read-only
fullPathURL	Specific location of file in storage including the storage domain.	String	Required
thumbnailURL	URL of the image used as thumbnail for the asset.	String	Read-only
stringValue	Internal.	Internal	Internal
relativePath	Internal.	Internal	Internal
value	Internal.	Internal	Internal

Object JSON Example

,
    "value": {
        "type": "AdSmartElementVideoReferenceValue",
        "publishPath": "HostingServices/TCAA_Toyota/live/NE_Tundra_H264_720p_2500kbps.mp4",
        "assetId": 2077389533,
        "name": "NE_Tundra_H264_720p_2500kbps.mp4",
        "width": "1280",
        "height": "720",
        "bitRate": 2482,
        "relativePathInWorkspace": null,
        "duration": "00:00:15",
        "mimetype": "video/mp4",
        "fullPathURL": "https://services.serving-sys.com/HostingServices/TCAA_Toyota/live/NE_Tundra_H264_720p_2500kbps.mp4",
        "thumbnailURL": "http://ds.serving-sys.com/resources/PROD/thumbnail/15496/20181213/41931899147387014.png",
        "stringValue": "NE_Tundra_H264_720p_2500kbps.mp4",
        "relativePath": false,
        "value": "NE_Tundra_H264_720p_2500kbps.mp4"
    },

Related Entities

Endpoints Using the vastSmartElement Object

Parent Objects

vastSmartElement Object Definition

Note

Object JSON Example

value Object (vastSmartElement)

value Object Definition

Note

Object JSON Example

Comments