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

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

Name

Description

Type

Required

Notes

type

Object type data.

String

Required

Standard Banner Ad

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

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

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

Required

adFormatName

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

String

Read-only

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

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

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

Optional

minAudioVersion

Internal.

Internal

Internal

fourthPartyTag

Deprecated

String

Read only

adChoicesStatus

Determines whether the ad choices icon is shown.

Boolean

Optional

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. Inherited by the account and passed to campaigns. Can override the account analytics settings.

analyticsSettings Object

Read-only

customFields

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

customFields Object

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

Used for Delivery Groups.

String

Optional
View values

  • Brand

  • EndUser

native

Determines if the ad is a native DCO ad.

Boolean

Optional

adFeatures

List of ad features.

Array of adFeature Object

Read-only

html5

Workspace used in the ad.

adAssetFolder Object

Optional

tooltip

Legacy field.

String

Optional

authoringTool

Authoring tool used to create the ad.

String

Read only
View values

  • AD_BUILDER

  • WORKSPACE

  • INSTANT_CREATIVE

  • RAPID_CREATIVE

downloadMode

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

String

Optional
View values

  • POLITE

  • INSTANT

  • INSTANT_WITHOUT_PRELOAD

initialLoadAsset

Asset to be displayed initially.

String

Optioal
View values

  • DEFAULT_IMAGE

  • PRELOAD_IMAGE

defaultImage

Image that appears by default.

adAsset Object

Required

defaultImageClickthrough

Default image's clickthrough URL.

clickthrough Object

Optional

banner

The ad's banner.

adAsset Object

Optional

adSmartVersionSchema

Includes catalog and dynamic elements.

adSmartVersionSchema Object

Optional

minFlashVersion

Minimum version of Flash required to play the ad.

Double

Read-only

mxpVersion

Legacy field.

String

Optional

osVersion

Legacy field.

String

Optional

asVersion

Minimum version of ActionScript required to play the ad.

String

Read-only

flashIDE

Legacy field.

String

Optional

variables

List of ad variables.

Array of variable Object

Optional

Object JSON Example

Example
{
    "type": "StandardBannerAd",
    "id": 1073756400,
    "relationsBag": null,
    "version": 1520513642286481408,
    "createdBy": 1073741800,
    "createdByName": "User",
    "createdByAccount": 1073741800,
    "createdByAccountName": "Account",
    "createdOn": 1516875663770,
    "lastUpdatedBy": 1073741800,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741800,
    "lastUpdatedByAccountName": null,
    "lastUpdateOn": 1520513642283,
    "name": "new_adfcbGfXYv",
    "masterAdId": 0,
    "changed": true,
    "adStatus": "PUBLISHED",
    "enabled": true,
    "adFormat": "STANDARD_BANNER_AD",
    "adFormatId": 42,
    "adFormatName": "Standard Banner",
    "accountId": 1073741800,
    "accountName": "SanityAccount",
    "placementId": null,
    "placementName": null,
    "placementType": null,
    "siteId": null,
    "siteName": null,
    "adAssignmentData": {
        "type": "AdAssignmentData",
        "accountId": 1073742100,
        "accountName": "02i9PiPpXBg",
        "advertiserId": 1073742800,
        "advertiserName": "sdvdsv",
        "brandId": 1073743000,
        "brandName": "sdvdsv",
        "campaignId": 1073742300,
        "campaignName": "SanityCampaign"
    },
    "mainClickthrough": null,
    "adURLs": null,
    "pricingSize": 36347,
    "overallSize": 50387,
    "initialSize": 36347,
    "width": 300,
    "height": 250,
    "dimensions": "300x250",
    "templateScriptName": "StdBanner",
    "urlTokens": "UUIuuukEJV",
    "minAudioVersion": 0.7692349410666157,
    "fourthPartyTag": "i2lBSvukeU",
    "adChoicesStatus": false,
    "adChoicesLocation": "TOP_RIGHT",
    "qaStatus": "NOT_SUBMITTED",
    "numberOfPlacementAds": 1,
    "overallNumberOfPlacementAds": 1,
    "servingMethod": null,
    "analyticsData": null,
    "analyticsSettings": null,
    "customFields": null,
    "massVersioning": false,
    "usedAsTemplate": false,
    "unSavedTemplateAd": false,
    "adTemplateId": null,
    "feedEnabled": null,
    "feedStatus": null,
    "enableTimeBasedServing": false,
    "servingTimeZoneType": null,
    "adFeatures": [],
    "defaultImage": {
        "type": "AdAsset",
        "id": 51345487429600,
        "relationsBag": null,
        "version": null,
        "assetId": 2073742400,
        "assetName": "CRT_CreativeQApositiveImage.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1073742100,
        "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/DEV1/asset/1073742500/IMAGE/20170711/CRT_CreativeQApositiveImage_29856856971149325.jpg",
        "external": false
    },
    "defaultImageClickthrough": null,
    "banner": {
        "type": "AdAsset",
        "id": 51345487429600,
        "relationsBag": null,
        "version": null,
        "assetId": 2073742700,
        "assetName": "oldAsset-4b54636f-6781-4f94-90ca-2a345f54abb8",
        "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
    },
    "minFlashVersion": 9.0,
    "mxpVersion": "6bnyH0Abrr",
    "osVersion": "ohY6U6rWBq",
    "asVersion": "x6bGXmQjXZ",
    "flashIDE": "BykqdZVjgG",
    "variables": null,
    "html5": null,
    "tooltip": "lnMDFdgmmE",
    "authoringTool": null,
    "downloadMode": "INSTANT",
    "initialLoadAsset": "PRELOAD_IMAGE",
    "forceClickthrough": false,
    "adSmartVersionSchema": {
        "type": "APIAdSmartVersionSchema",
        "id": null,
        "smartElements": []
    },
    "disableIncomplete": false,
    "enableRetargeting": false,
    "rotationType": "EvenDistribution",
    "versionTargetingType": "TargetAudience",
    "versionBasePath": "DEV1/DCO",
    "advancedRetargeting": null,
    "automaticOptimizationData": null,
    "native": false,
    "containsNonWorkspaceAssets": true
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments