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 automaticOptimizationData Object

Parent Objects

automaticOptimizationData 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

optimizationMetric

Metric by which optimization is measured.

String

Read-only
View values

  • ConversionRate

  • SelectedConversions

  • ClickthroughRate

conversionTagId

ID of the conversion tag.

String

Read-only

conversionTagName

Name of the conversion tag.

String

Read-only

dynamicElementOptimization

Sets the dynamic element to optimize the versioning.

DynamicElementOptimization 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
{
        "metadata": null,
        "debug": null,
        "error": null,
        "result": {
                "type": "HTML5RichMediaBannerAd",
                "id": 1234808100,
                "relationsBag": null,
                "version": 1231674767705047040,
                "createdBy": 466535,
                "createdByName": "Tags",
                "createdByAccount": 128966,
                "createdByAccountName": "Account1",
                "createdOn": 1230155091480,
                "lastUpdatedBy": 359567,
                "lastUpdatedByName": "User",
                "lastUpdatedByAccount": 2,
                "lastUpdatedByAccountName": "Account2",
                "lastUpdateOn": 1231674767706,
                "name": "AO-retargeting",
                "masterAdId": 0,
                "changed": false,
                "adStatus": "PUBLISHED",
                "enabled": true,
                "adFormat": "HTML5_RICH_MEDIA_BANNER_AD",
                "adFormatId": 38,
                "adFormatName": "HTML5 Rich Media Banner",
                "accountId": 128900,
                "accountName": "Account1",
                "placementId": null,
                "placementName": null,
                "placementType": null,
                "siteId": null,
                "siteName": null,
                "adAssignmentData": {
                        "type": "AdAssignmentData",
                        "accountId": 128900,
                        "accountName": "Account3",
                        "advertiserId": 1233752400,
                        "advertiserName": "AdvertiserName",
                        "brandId": 1233831400,
                        "brandName": "BrandName",
                        "campaignId": 1233874200,
                        "campaignName": "AO-Ret"
                },
                "mainClickthrough": {
                        "type": "MainClickthrough",
                        "id": 12360373305500,
                        "relationsBag": null,
                        "url": "",
                        "targetWindowType": null,
                        "showAddressBar": false,
                        "showMenuBar": false,
                        "closeAllAdParts": false
                },
                "adURLs": null,
                "pricingSize": 79646,
                "overallSize": 79646,
                "initialSize": 79646,
                "width": 259,
                "height": 194,
                "dimensions": "259x194",
                "templateScriptName": "Html5PoliteBanner",
                "urlTokens": null,
                "minAudioVersion": 0.0,
                "fourthPartyTag": "",
                "adChoicesStatus": false,
                "adChoicesLocation": "TOP_RIGHT",
                "qaStatus": "NOT_SUBMITTED",
                "numberOfPlacementAds": 2,
                "overallNumberOfPlacementAds": 2,
                "servingMethod": null,
                "analyticsData": {
                        "impressions": 360,
                        "clicks": 0,
                        "lastUpdated": 1230160488000,
                        "ctr": 0.0,
                        "actualStartDate": null
                },
                "analyticsSettings": null,
                "customFields": null,
                "massVersioning": true,
                "usedAsTemplate": false,
                "unSavedTemplateAd": false,
                "adTemplateId": null,
                "feedEnabled": null,
                "feedStatus": null,
                "enableTimeBasedServing": false,
                "servingTimeZoneType": null,
                "videoAudioAdAssetData": [],
                "adFeatures": [{
                        "id": 12331660428882340,
                        "featureType": "DCO"
                }],
                "defaultImage": {
                        "type": "AdAsset",
                        "id": 12360373305500,
                        "relationsBag": null,
                        "assetId": 1236311000,
                        "assetName": "images1.jpg",
                        "source": true,
                        "assetStatus": null,
                        "folderId": 1234194000,
                        "workspaceFolderId": 1234194000,
                        "size": 9956,
                        "duration": null,
                        "bitRate": null,
                        "width": 259,
                        "height": 194,
                        "mimeType": "image/jpeg",
                        "mediaType": "IMAGE",
                        "format": null,
                        "thumbnailUrl": "http://resources-prod-sizmdx.s3.amazonaws.com/PROD/html5/128966/12380304/1234194087/12331656170610679/images1.jpg",
                        "external": false
                },
                "defaultImageClickthrough": {
                        "type": "MainClickthrough",
                        "id": 12360373305500,
                        "relationsBag": null,
                        "url": "",
                        "targetWindowType": null,
                        "showAddressBar": false,
                        "showMenuBar": false,
                        "closeAllAdParts": false
                },
                "html5": {
                        "type": "AdAssetFolder",
                        "id": 12330373305500,
                        "relationsBag": null,
                        "assetId": 1234194000,
                        "assetName": "ServerAutomationWorkspace",
                        "source": true,
                        "assetStatus": null,
                        "folderId": null,
                        "workspaceFolderId": null,
                        "size": 79646,
                        "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": "WORKSPACE",
                "performAutoVideoTranscoding": false,
                "adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
                "variables": null,
                "adSmartVersionSchema": {
                        "type": "APIAdSmartVersionSchema",
                        "id": null,
                        "smartElements": [{
                                "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"
                        }, {
                                "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": "AdSmartElementSimpleStringValue",
                                        "value": "mini.jpg",
                                        "stringValue": "mini.jpg"
                                },
                                "smartElementSource": "ConfigJS"
                        }]
                },
                "disableIncomplete": false,
                "enableRetargeting": true,
                "rotationType": "AutomaticOptimization",
                "versionTargetingType": "TargetAudience",
                "versionBasePath": "PROD/DCO",
                "automaticOptimizationData": {
                        "type": "AutomaticOptimizationData",
                        "id": null,
                        "relationsBag": null,
                        "createdBy": null,
                        "createdByName": null,
                        "createdByAccount": null,
                        "createdByAccountName": null,
                        "createdOn": null,
                        "lastUpdatedBy": null,
                        "lastUpdatedByName": null,
                        "lastUpdatedByAccount": null,
                        "lastUpdatedByAccountName": null,
                        "lastUpdateOn": null,
                        "optimizationMetric": "SelectedConversions",
                        "conversionTagId": "1233742811",
                        "conversionTagName": "Homepage Conversion",
                        "dynamicElementOptimization": null
                },
                "priorityPolicy": "Server",
                "initialLoadAsset": "PRELOAD_IMAGE",
                "downloadMode": "INSTANT",
                "advancedRetargeting": {
                        "type": "AdvancedRetargeting",
                        "branchItemClientIds": [],
                        "advertiserId": null,
                        "tags": [],
                        "tagIds": [1234082000],
                        "nodeType": "AdvancedRetargeting"
                },
                "native": false,
                "containsNonWorkspaceAssets": false
        }
}

DynamicElementOptimization Object

Related Entities

Endpoints Using the DynamicElementOptimization Object

Parent Objects

DynamicElementOptimization 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

smartElementKey

Smart item that the AO engine will break into groups and optimize (click here for details).

String

secondaryMetric

Allows an option to split into optimization groups both by the dynamic element and the retargeting/targeting value.

String
View values

  • TargetAudience

  • RetargetingValue

optimizationIntervalType

Defines the run times of the optimization engine (every X weeks/days).

String
View values

  • Days

  • Weeks

optimizationInterval

Defines the numeric value of the threshold type

Internal

optimizationDataLookBackType

Defines on which data the optimization engine will make the decisions based on (i.e. only impressions from the last 30 days)

String
View values

  • Days

  • Weeks

optimizationDataLookBack

Defines on which data the optimization engine will make the decisions based on (i.e. only impressions from the last 30 days)

Integer

optimizationThresholdType

Items that are measured in the optimization threshold field.

String
View values

  • Impressions

  • Clicks

optimizationThreshold

Defines what is the minimal threshold for the automatic optimization engine to start optimizing.

Internal

minimumWeight

Defines the minimum weight that will be given to an optimization group by the AO engine

Double

endDate

Defines the end date of the AO run.

Long

Object JSON Example

Example
"automaticOptimizationData": {
                        "type": "AutomaticOptimizationData",
                        "id": null,
                        "relationsBag": null,
                        "createdBy": null,
                        "createdByName": null,
                        "createdByAccount": null,
                        "createdByAccountName": null,
                        "createdOn": null,
                        "lastUpdatedBy": null,
                        "lastUpdatedByName": null,
                        "lastUpdatedByAccount": null,
                        "lastUpdatedByAccountName": null,
                        "lastUpdateOn": null,
                        "optimizationMetric": "ClickthroughRate",
                        "conversionTagId": null,
                        "conversionTagName": null,
                        "dynamicElementOptimization": {
                                "type": "DynamicElementOptimization",
                                "id": null,
                                "relationsBag": null,
                                "createdBy": null,
                                "createdByName": null,
                                "createdByAccount": null,
                                "createdByAccountName": null,
                                "createdOn": null,
                                "lastUpdatedBy": null,
                                "lastUpdatedByName": null,
                                "lastUpdatedByAccount": null,
                                "lastUpdatedByAccountName": null,
                                "lastUpdateOn": null,
                                "smartElementKey": "Model",
                                "secondaryMetric": "TargetAudience",
                                "optimizationIntervalType": "Weeks",
                                "optimizationInterval": 1,
                                "optimizationDataLookBackType": "Days",
                                "optimizationDataLookBack": 30,
                                "optimizationThresholdType": "Impressions",
                                "optimizationThreshold": 250,
                                "minimumWeight": 5.0,
                                "endDate": null
                        }
                },

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example
"relationsBag": {
        "parents": {
                "account": {
                        "id": 16674,
                        "name": "[TEST] migrated account",
                        "internal": true
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
        },
        "children": {
                "advertisers": {
                        "count": 0
                },
                "brands": {
                        "count": 1
                },
                "campaigns": {
                        "count": 231
                },
                "users": {
                        "count": 0
                }
        },
        "creativeAccountContact": false
},

Parents Object

Parents Object Definition

Name

Description

Type

Required

Notes

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1072241834,
 "name": "testing account",
 "internal": false
 }

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1073741822,
 "name": "AAA"
 }

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741833,
 "name": "BBB"
 }

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741831,
 "name": "ccc"
 }

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741853,
 "name": "ddd"
 }
Object JSON Example
Example
"parents": {
        "account": {
                "id": 1072241834,
                "name": "testing account",
                "internal": false
        },
        "advertiser": {
                "id": 1073741822,
                "name": "AAA"
        },
        "brand": {
                "id": 1073741833,
                "name": "BBB"
        },
        "campaign": null,
        "site": null
},

Children Object

Children Object Definition

Name

Description

Type

Required

Notes

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only
Object JSON Example
Example
"children": {
        "advertisers": {
                "count": 0
        },
        "brands": {
                "count": 1
        },
        "campaigns": {
                "count": 231
        },
        "users": {
                "count": 0
        }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments