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 Expandable Banner Ad Object

HTML5 Expandable 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

type

Type of entity

String

Required

HTML5SingleExpandableBannerAd

panels

List of the ad's panels.

Array of panel Object

Optional

panelsSettings

Settings related to the panels that will expand in the ad.

panelsSettings 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

allowHTML5DynamicExpansion

Determines if the expansion will be fixed or according location on the page.

Boolean

Required

If true, panel will not be fixed.

massVersioning

Indicates if the ad is a mass versioned ad.

Boolean

Optional

adSmartVersionSchema

Includes catalog and dynamic elements.

adSmartVersionSchema Object

Optional

disableIncomplete

Internal.

Internal

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 ad 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.

String

Internal

initialLoadAsset

Asset to be displayed initially.

String

Optional
View values

  • DEFAULT_IMAGE

  • PRELOAD_IMAGE

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

defaultImage

Image that is shown as a default.

adAsset Object

Required

defaultImageClickthrough

Default images' clickthrough URL.

clickthrough Object

Optional

variables

List of ad variables.

Array of variable Object

Optional

additionalAssets

Other assets used in the ad.

Array of additionalAsset Objects

Optional

customInteractions

Interactions that the user can have with the various assets in the ad.

Array of adCustomInteraction Objects

Optional

performAutoVideoTranscoding

Determines if video transcoding of the asset should be done automatically.

Boolean

Optional

Default value: True

adTranscodingStatus

Ad's transcoding status.

String

Read-only
View values

  • TRANSCODING_IN_PROGRESS

  • TRANSCODING_FAILED

  • TRANSCODING_IN_PROGRESS_DISABLING_AD

  • TRANSCODING_FAILED_DISABLING_AD

  • TRANSCODING_SUCCESS

  • TRANSCODING_NOT_REQUIRED

downloadMode

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

String

Optional
View values

  • POLITE

  • INSTANT

  • INSTANT_WITHOUT_PRELOAD

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

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

String

Required

For ads using a custom ad format it represents the base ad format

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 to which the ad is attached.

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

URLs

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

minAudioVersion

Internal,

Internal

Internal

urlTokens

Determines the tokens that are appended to the 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

Same as in Placement entity.

analyticsSettings

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

analyticsSettings Object

Optional

customFields

User-defined custom field name inherited from the account level.

customFields Object

Optional

Same as in Account entity.

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

Read-only

unSavedTemplateAd

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

Boolean

Read-only

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

Read-only

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

videoAudioAdAssetData

Internal.

Internal

Internal

native

Determines if this ad is a native DCO ad.

Boolean

Optional

containsNonWorkspaceAssets

Internal.

Internal

Internal

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": "HTML5SingleExpandableBannerAd",
    "id": 1073765600,
    "relationsBag": null
    "version": 1539168498279972864,
    "createdBy": 1073741800,
    "createdByName": "User",
    "createdByAccount": 1073741800,
    "createdByAccountName": "Account",
    "createdOn": 1539168306509,
    "lastUpdatedBy": 1073741800,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741800,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1539168498282,
    "name": "Ad4b61ea45-a45b-4f12-9685-2f3b50efc92d",
    "masterAdId": 0,
    "changed": false,
    "adStatus": "NEW",
    "enabled": true,
    "adFormat": "HTML5_SINGLE_EXPANDABLE_BANNER_AD",
    "adFormatId": 39,
    "adFormatName": "HTML5 Single Expandable Banner",
    "accountId": 1073741800,
    "accountName": "Account",
    "placementId": null,
    "placementName": null,
    "placementType": null,
    "siteId": null,
    "siteName": null,
    "adAssignmentData": {
        "type": "AdAssignmentData",
        "accountId": null,
        "accountName": "",
        "advertiserId": null,
        "advertiserName": "",
        "brandId": null,
        "brandName": "",
        "campaignId": null,
        "campaignName": ""
    },
    "mainClickthrough": {
        "type": "MainClickthrough",
        "id": 35481401361000,
        "relationsBag": null,
        "url": "http://acme.com",
        "targetWindowType": "TOP",
        "showAddressBar": false,
        "showMenuBar": false,
        "closeAllAdParts": false
    },
    "adURLs": [{
        "type": "ThirdPartyURL",
        "id": 35481401361000,
        "relationsBag": null,
        "url": "http://acme.com",
        "urlType": "IMPRESSION_TRACKING",
        "enabled": false,
        "urlSource": "AD",
        "externalId": "1",
        "uniqueIdentifier": "IMPRESSION_TRACKING_1",
        "customScriptId": null,
        "disableServing": false
    }],
    "pricingSize": 54039,
    "overallSize": 54039,
    "initialSize": 36347,
    "width": 300,
    "height": 250,
    "dimensions": "300x250",
    "templateScriptName": "Html5SEBanner",
    "urlTokens": null,
    "minAudioVersion": 0.0,
    "fourthPartyTag": "",
    "adChoicesStatus": false,
    "adChoicesLocation": "TOP_LEFT",
    "qaStatus": "NOT_SUBMITTED",
    "numberOfPlacementAds": 0,
    "overallNumberOfPlacementAds": 0,
    "servingMethod": null,
    "analyticsData": null,
    "analyticsSettings": null,
    "customFields": null,
    "massVersioning": false,
    "usedAsTemplate": false,
    "unSavedTemplateAd": false,
    "adTemplateId": null,
    "feedEnabled": null,
    "feedStatus": null,
    "enableTimeBasedServing": false,
    "servingTimeZoneType": null,
    "videoAudioAdAssetData": [],
    "adFeatures": [],
    "defaultImage": {
        "type": "AdAsset",
        "id": 35532940968600,
        "relationsBag": null,
        "assetId": 2073741800,
        "assetName": "CRT_QAPositiveImage2.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1073741800,
        "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/asset/1073741800/IMAGE/20181000/CRT_QAPositiveImage2_40428906326523958.jpg",
        "external": false
    },
    "defaultImageClickthrough": {
        "type": "MainClickthrough",
        "id": 35481401361000,
        "relationsBag": null,
        "url": "http://acme.com",
        "targetWindowType": "TOP",
        "showAddressBar": false,
        "showMenuBar": false,
        "closeAllAdParts": false
    },
    "additionalAssets": [{
        "type": "AdditionalAsset",
        "id": 35481401361000,
        "relationsBag": null,
        "assetId": 2073746100,
        "assetName": "oldAsset-f56d2bf6-d8a6-43c1-aa81-8dccbaf3e172",
        "source": true,
        "assetStatus": null,
        "folderId": 1073741800,
        "workspaceFolderId": 0,
        "size": 14040,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "application/x-shockwave-flash",
        "mediaType": "FLASH",
        "format": null,
        "thumbnailUrl": null,
        "external": false,
        "variants": null,
        "transcodeJobID": null,
        "name": "1"
    }, {
        "type": "AdditionalAsset",
        "id": 35532940968600,
        "relationsBag": null,
        "assetId": 2073741800,
        "assetName": "CRT_QAPositiveImage2.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1073741800,
        "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/asset/1073741826/IMAGE/20181010/CRT_QAPositiveImage2_40428906326523958.jpg",
        "external": false,
        "variants": null,
        "transcodeJobID": null,
        "name": "2"
    }],
    "customInteractions": null,
    "performAutoVideoTranscoding": false,
    "adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
    "variables": null,
    "downloadMode": "INSTANT",
    "html5": {
        "type": "AdAssetFolder",
        "id": 35481401361000,
        "relationsBag": null,
        "assetId": 1073741800,
        "assetName": "CRT_HTML5Workspace",
        "source": true,
        "assetStatus": null,
        "folderId": null,
        "workspaceFolderId": null,
        "size": 3652,
        "duration": null,
        "bitRate": null,
        "width": 0,
        "height": 0,
        "mimeType": null,
        "mediaType": null,
        "format": null,
        "thumbnailUrl": null,
        "external": null,
        "assets": null
    },
    "authoringTool": "WORKSPACE",
    "allowHTML5DynamicExpansion": false,
    "adSmartVersionSchema": {
        "type": "APIAdSmartVersionSchema",
        "id": null,
        "smartElements": []
    },
    "disableIncomplete": false,
    "enableRetargeting": false,
    "rotationType": "EvenDistribution",
    "versionTargetingType": "TargetAudience",
    "versionBasePath": "CI/DCO",
    "initialLoadAsset": "PRELOAD_IMAGE",
    "advancedRetargeting": null,
    "automaticOptimizationData": null,
    "panels": [{
        "type": "Panel",
        "id": 35481275531900,
        "relationsBag": null,
        "assetId": 2073741800,
        "assetName": "index.html",
        "source": true,
        "assetStatus": "FAILED_INGEST",
        "folderId": 1073741800,
        "workspaceFolderId": 1073741800,
        "size": 431,
        "duration": null,
        "bitRate": null,
        "width": 0,
        "height": 0,
        "mimeType": "text/html",
        "mediaType": "HTML",
        "format": null,
        "thumbnailUrl": null,
        "external": false,
        "name": "Panel",
        "nameId": 4216384196211500,
        "defaultPanel": true,
        "positionX": 0.0,
        "positionY": 0.0,
        "positionType": "BANNER_RELATIVE",
        "autoExpand": false,
        "delayedExpansion": false,
        "retraction": "NEVER",
        "transparent": false,
        "autoGeneratedPanel": true
    }],
    "panelsSettings": {
        "type": "BasePanelsSettings",
        "panelFrequency": "ONCE_IN_CAMPAIGN",
        "panelFrequencyTimes": 1,
        "multiplePanels": true,
        "defaultPanelAutoExpansion": "USE_AD_CREATIVE_SETTINGS",
        "expandedPanelWidth": 0,
        "expandedPanelHeight": 0,
        "panelPixelOffsetsX": 0,
        "panelPixelOffsetsY": 0
    },
    "native": false,
    "containsNonWorkspaceAssets": true
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments