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

adAsset 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

Required

AdAsset

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

assetId

ID of the asset to be used.

Long

Read-only

assetStatus

Status of the asset to be used.

String

Read-only

width

Width of the asset.

Integer

Read-only

Width is in pixels.

height

Height of the asset.

Integer

Read-only

Height is in pixels.

assetName

Name of the asset to be used.

String

Read-only

source

Internal.

Boolean

Internal

folderId

ID of the folder in which the asset resides.

Long

Read-only

workspaceFolderId

ID of the Workspace folder in which the asset is located.

Long

Read-only

size

Size of the asset.

Long

Read-only

Size is in bytes.

duration

Length of the asset (If applicable).

Long

Read-only

Duration is in milliseconds.

bitRate

Bit rate of the asset (If applicable).

Long

Read-only

bitRate is bits per second.

mimeType

Label used to identify the type of data.

String

Read-only

mediaType

Media type for the asset.

String

Read-only

format

Format of the asset, depending on the mediaType.

String

Read-only

Examples include jpg and mp4.

external

Determines if the asset is external.

Boolean

Internal

thumbnailUrl

URL of the asset thumbnail image.

String

Read-only

Object JSON Example

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

Comments