Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

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.

Please note that on October 1, 2024, the ability to create new campaigns, placements, and tag managers will be disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the HTML5 Rich Media Banner Ad Object

HTML5 Rich Media Banner Ad 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.

Parameter

Description

Type

Required

Notes

defaultImage

Settings for the image that is displayed as the default.

adAsset Object

Required

defaultImageClickthrough

Click-through URL settings for the default image.

clickthrough Object

Optional

downloadMode

Determines the method in which the ad loads on the publisher's site.

String

Optional
View values

  • POLITE

  • INSTANT

  • INSTANT_WITHOUT_PRELOAD

additionalAssets

An array of additional assets used in the ad.

Array of additionalAsset Objects

Optional

customInteractions

Tracks how users interact with various assets in an ad.

Array of adCustomInteraction Objects

Optional

performAutoVideoTranscoding

Determines whether video transcoding is performed automatically.

Boolean

Optional

Default value: True

adTranscodingStatus

Indicates the status of the auto-transcoding process for the ad.

String

Read-only
View values

  • TRANSCODING_IN_PROGRESS

  • TRANSCODING_FAILED

  • TRANSCODING_IN_PROGRESS_DISABLING_AD

  • TRANSCODING_FAILED_DISABLING_AD

  • TRANSCODING_SUCCESS

  • TRANSCODING_NOT_REQUIRED

variables

List of ad variables.

Array of variable Object

Optional

html5

Workspace used in the ad.

adAssetFolder Object

Required

authoringTool

Authoring tool used to create the ad.

String

Read-only
View values

  • AD_BUILDER

  • WORKSPACE

  • INSTANT_CREATIVE

  • RAPID_CREATIVE

initialLoadAsset

Asset to be displayed initially.

String

Optional
View values

  • DEFAULT_IMAGE

  • PRELOAD_IMAGE

adSmartVersionSchema

Includes catalog and dynamic elements.

adSmartVersionSchema Object

Optional

disableIncomplete

Internal.

Boolean

Internal

enableRetargeting

Determines whether multiple retargeting tags and values can be set for each version of a Dynamic Creative ad.

Boolean

Optional

rotationType

Determines the rotation methods by which to serve the versions.

String

Optional
View values

  • EvenDistribution

  • Weighted

  • TimeBased

  • Sequence

  • AdvancedSequence

  • AutomaticOptimaztion

versionTargetingType

Determines the targeting type by which to serve the versions.

String

Optional
View Values

  • None

  • TargetedPlacement

  • TargetAudience

versionBasePath

Internal

Internal

Internal

advancedRetargeting

Internal.

Internal object

Internal

In a Dynamic Creative ad, this object includes the IDs of the tags from the Dynamic Creative version.

automaticOptimizationData

Internal.

automaticOptimizationData Object

Internal

name

Name of the ad.

String

Required

masterAdId

(In case of a placement ad) ID of the master ad it originated from, empty otherwise.

Long

Read-only

changed

(In case of a placement ad) Indicates whether the ad was modified since it was created from its master ad.

Boolean

Read-only

adStatus

Status of the ad.

String

Read-only
View values

  • NEW

  • ASSIGNED

  • ATTACHED

  • DETACHED

  • PUBLISHED

  • IDLE

  • LIVE

enabled

(For serving purposes) Indicates whether the ad is enabled or disabled.

Boolean

Optional

Default value: True

adFormat

(In case of custom ad format) Base ad format of the ad.

String

Required
View values

  • RICH_MEDIA_BANNER_AD

  • EXPANDABLE_BANNER_AD

  • PUSHDOWN_BANNER_AD

  • TRACKING_PIXEL_AD

  • INSTREAM_VIDEO_TRACKING_PIXEL_AD

  • ENHANCED_STANDARD_BANNER_AD

  • SINGLE_EXPANDABLE_BANNER_AD

  • INSTREAM_AD

  • INSTREAM_INTERACTIVE_AD

  • HTML5_RICH_MEDIA_BANNER_AD

  • HTML5_SINGLE_EXPANDABLE_BANNER_AD

  • STANDARD_BANNER_AD

  • HTML5_EXPANDABLE_BANNER_AD

  • VERIFICATION_TRACKING_AD

  • INSTREAM_VIDEO_VERIFICATION_TRACKING_AD

adFormatId

ID of the ad format

Long

Optional

adFormatName

Name of the ad format, for example, 'HTML5 Expandable Ad'.

String

Required

accountId

ID of the account of the user who created the ad.

Long

Required

accountName

Name of the account of the user who created the ad.

String

Read-only

placementId

(Placement ad only) ID of the placement to which the ad is attached.

Long

Read-only

placementName

(Placement ad only) Name of the placement to which the ad is attached.

String

Read-only

placementType

(Placement ad only) Type of placement the ad is attached to.

String

Read-only
View values

  • OUT_OF_BANNER

  • TRACKING_ONLY

  • IN_STREAM_VIDEO

  • IN_STREAM_VIDEO_TRACKING

  • VERIFICATION_TRACKING

  • VERIFICATION_TRACKING_VIDEO

  • IN_BANNER

siteId

(Placement ad only) ID of the site of the placement to which the ad is attached.

Long

Read-only

siteName

(Placement ad only) Name of the site of the placement to which the ad is attached.

String

Read-only

adAssignmentData

Assignment data of the ad, for example campaign or brand.

adAssignmentData Object

Read-only

mainClickthrough

Main click-through that will be fired when clicking on the ad.

mainClickthrough Object

Optional

adURLs

List of all ad 3rd party tracking URLs.

Array of thirdPartyURL Object

Optional

pricingSize

(For billing purposes) Size of the ad, calculated in KB.

Long

Read-only

overallSize

Size of the ad (in KB) including all of its assets.

Long

Read-only

initialSize

Size of the ad (in KB) calculated by the asset that is initially loaded.

Long

Read-only

width

Width of the ad.

Long

Read-only

height

Height of the ad.

Long

Read-only

dimensions

String representation of the dimensions as width x height.

String

Read-only

templateScriptName

Maps to the correct base AdConfig.js file.

String

Read-only
View values

  • STANDARD_BANNER

  • HTML5_STANDARD_BANNER

  • HTML5_RICH_MEDIA_BANNER

  • HTML5_EXPANDBLE_BANNER

  • HTML5_SINGLE_EXPANDBLE_BANNER

  • HYBRID_STANDARD_BANNER

  • RICH_MEDIA_BANNER

  • EXPANDABLE_BANNER

  • SINGLE_EXPANDABLE_BANNER

  • PUSHDOWN_BANNER

  • TRACKING_PIXEL

  • VERIFICATION_TRACKING

  • ENHANCED_STANDARD_BANNER

  • INSTREAM, INSTREAM_INTERACTIVE

urlTokens

Determines the tokens that are appended to URLs.

String

Read-only

fourthPartyTag

Deprecated.

String

Read-only

adChoicesStatus

Determines whether the ad choices icon is shown.

Boolean

Optional

Default value: False

adChoicesLocation

Determines the relative location of the ad choices icon on the ad.

String

Optional
View values

  • (Default) TOP_RIGHT

  • TOP_LEFT

  • BOTTOM_RIGHT

  • BOTTOM_LEFT

qaStatus

Indicates the status of the ad qa review process.

String

Read-only
View values

  • SUBMITTED

  • NOT_SUBMITTED

numberOfPlacementAds

Number of placement ads the master ad has (only the ones visible to the user).

Integer

Read-only

overallNumberOfPlacementAds

Number of placements ad the master ad has (All).

Integer

Read-only

servingMethod

Describes the type of serving method used to display the ad.

String

Read-only
View values

  • NONE

  • ONLY_AD_CONFIG

  • ONLY_VAST

  • VAST_AND_AD_CONFIG

analyticsData

Provides ad analytics statistics on the ad.

adAnalyticsData Object

Read-only

analyticsSettings

Definitions for analytics settings. By default, these settings are inherited from the advertiser.

analyticsSettings Object

Optional

Default value: Null

customFields

Custom field values on entity level, each field must have metadata definition on parent account.

customFields Object

Optional

massVersioning

Indicates if the ad is a mass versioned ad.

Boolean

Optional

usedAsTemplate

Indicates if this ad is used as part of an ad template.

Boolean

Optional

unSavedTemplateAd

Indicates if the ad was created from Ad Builder for HTML5 from an ad template but was not actually saved yet.

Boolean

Optional

adTemplateId

ID of the ad template from which ad originated.

Long

Read-only

feedEnabled

Indicates if the Dynamic Creative feed is set up for the ad.

Boolean

Optional

feedStatus

Status of the Dynamic Creative feed.

String

Read-only
View values

  • New

  • Ingested

  • Processing

  • Completed

  • Failed

enableTimeBasedServing

Determines time-based settings according to the brand's time zone or the user's time zone.

Boolean

Optional

servingTimeZoneType

Set on the account level.

String

Read-only
View values

  • Brand

  • EndUser

native

Native DCO ad.

Boolean

Optional

adFeatures

List of ad features.

Array of adFeature Object

Read-only

createdBy

ID of the user who created the ad.

Long

Read-only

createdByName

Name of the user who created the ad.

String

Read-only

createdByAccount

ID of the account of the user who created the ad.

Long

Read-only

createdByAccountName

Name of the account of the user who created the ad.

String

Read-only

createdOn

Date and time the ad was created (Date epoch).

Date (Long)

Read-only

lastUpdatedBy

ID of the user who last updated the ad.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the ad.

String

Read-only

lastUpdatedByAccount

ID of the account of the user who last updated the ad.

Long

Read-only

lastUpdatedByAccountName

Name of the account of the user who last updated the ad.

String

Read-only

lastUpdateOn

Date and time the ad was last updated (Date epoch).

Date (Long)

Read-only

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

Object JSON Example

Example
{
    "type": "HTML5RichMediaBannerAd",
    "id": 1234567800,
    "relationsBag": null
    "version": 1234567890123456789,
    "createdBy": 1234567800,
    "createdByName": "User",
    "createdByAccount": 1234567800,
    "createdByAccountName": "Account",
    "createdOn": 1111111111111,
    "lastUpdatedBy": 1073741800,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1233456700,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 2222222222222,
    "name": "Name",
    "masterAdId": 0,
    "changed": true,
    "adStatus": "ATTACHED",
    "enabled": true,
    "adFormat": "HTML5_RICH_MEDIA_BANNER_AD",
    "adFormatId": 38,
    "adFormatName": "HTML5 Rich Media Banner",
    "accountId": 1234567800,
    "accountName": "Account",
    "placementId": null,
    "placementName": null,
    "placementType": null,
    "siteId": null,
    "siteName": null,
    "adAssignmentData": {
        "type": "AdAssignmentData",
        "accountId": 1234567800,
        "accountName": "Account",
        "advertiserId": 1234567896,
        "advertiserName": "Advertiser",
        "brandId": 1234567897,
        "brandName": "Brand",
        "campaignId": 1234567898,
        "campaignName": "CampaignName"
    },
    "mainClickthrough": null,
    "adURLs": null,
    "pricingSize": 112233,
    "overallSize": 112244,
    "initialSize": 12345,
    "width": 300,
    "height": 250,
    "dimensions": "300x250",
    "templateScriptName": "Html5PoliteBanner",
    "urlTokens": "OwOlENqq68",
    "minAudioVersion": 0.6332508603330881,
    "fourthPartyTag": "G_sOxPeB3c",
    "adChoicesStatus": false,
    "adChoicesLocation": "BOTTOM_RIGHT",
    "qaStatus": "NOT_SUBMITTED",
    "numberOfPlacementAds": 1,
    "overallNumberOfPlacementAds": 1,
    "servingMethod": null,
    "analyticsData": null,
    "analyticsSettings": null,
    "customFields": null,
    "massVersioning": true,
    "usedAsTemplate": false,
    "unSavedTemplateAd": false,
    "adTemplateId": null,
    "feedEnabled": null,
    "feedStatus": null,
    "enableTimeBasedServing": false,
    "servingTimeZoneType": null,
    "videoAudioAdAssetData": [],
    "adFeatures": [{
        "id": 33333333333333333,
        "featureType": "DCO"
    }],
    "defaultImage": {
        "type": "AdAsset",
        "id": 55555555555555,
        "relationsBag": null,
        "assetId": 1234567899,
        "assetName": "Image.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": -1,
        "workspaceFolderId": 0,
        "size": 36347,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "image/jpeg",
        "mediaType": "IMAGE",
        "format": null,
        "thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/CI/source/8888888888/IMAGE/678678678678678/Image.jpg",
        "external": false
    },
    "defaultImageClickthrough": null,
    "html5": {
        "type": "AdAssetFolder",
        "id": 4564564564564,
        "relationsBag": null,
        "assetId": 1234567892,
        "assetName": "CRT_MVHTML5 (4)",
        "source": true,
        "assetStatus": null,
        "folderId": null,
        "workspaceFolderId": null,
        "size": 79740,
        "duration": null,
        "bitRate": null,
        "width": 0,
        "height": 0,
        "mimeType": null,
        "mediaType": null,
        "format": null,
        "thumbnailUrl": null,
        "external": null,
        "assets": null
    },
    "additionalAssets": null,
    "customInteractions": null,
    "authoringTool": null,
    "performAutoVideoTranscoding": true,
    "adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
    "variables": null,
    "adSmartVersionSchema": {
        "type": "APIAdSmartVersionSchema",
        "id": null,
        "smartElements": [{
            "type": "AdSmartHtmlElement",
            "id": null,
            "svKey": "html1",
            "value": {
                "type": "AdSmartElementSimpleStringValue",
                "value": "<!DOCTYPE html>\r\n<html>\r\n<body>\r\n\r\n<h1>My html5 Heading</h1>\r\n\r\n<p>My html5 paragraph.</p>\r\n\r\n</body>\r\n</html>",
                "stringValue": "<!DOCTYPE html>\r\n<html>\r\n<body>\r\n\r\n<h1>My html5 Heading</h1>\r\n\r\n<p>My html5 paragraph.</p>\r\n\r\n</body>\r\n</html>"
            },
            "smartElementSource": "ConfigJS"
        }, {
            "type": "AdSmartImageElement",
            "id": null,
            "svKey": "image1",
            "value": {
                "type": "AdSmartElementAssetReferenceValue",
                "name": "mini.jpg",
                "contentTypeCode": 0,
                "publishPath": "CI/html5/12345678902345678790/mini.jpg",
                "width": "630",
                "height": "354",
                "enableFS": 1,
                "bitRate": null,
                "assetId": 1234567890,
                "relativePathInWorkspace": null,
                "stringValue": "CI/html5/2134567890213456789/mini.jpg"
            },
            "smartElementSource": "ConfigJS"
        }, {
            "type": "AdSmartTextElement",
            "id": null,
            "svKey": "text1",
            "value": {
                "type": "AdSmartElementSimpleStringValue",
                "value": "<div style=\"text-align: center;\"><span style=\"font-family: Arial; font-size: 16px;\"><b>this is my text</b></span></div>",
                "stringValue": "<div style=\"text-align: center;\"><span style=\"font-family: Arial; font-size: 16px;\"><b>this is my text</b></span></div>"
            },
            "smartElementSource": "ConfigJS"
        }]
    },
    "disableIncomplete": false,
    "enableRetargeting": false,
    "rotationType": "EvenDistribution",
    "versionTargetingType": "TargetAudience",
    "versionBasePath": "CI/DCO",
    "automaticOptimizationData": null,
    "priorityPolicy": "Server",
    "initialLoadAsset": "PRELOAD_IMAGE",
    "downloadMode": "INSTANT",
    "advancedRetargeting": null,
    "native": false,
    "containsNonWorkspaceAssets": true
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments