PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Follow

Related Entities

Endpoints Using the vastSmartElement Object

Parent Objects

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

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

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments