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

Parent Objects

adSmartVersionSchema 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 the entity.

String

Required

APIAdSmartVersionSchema

id

ID of the ad.

Long

Read-only

smartElements

List of the smart elements for the ad.

Array of adSmartElement Object

Optional

Object JSON Example

Example
 "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/40432400441815689/mini.jpg",
                "width": "630",
                "height": "354",
                "enableFS": 1,
                "bitRate": null,
                "assetId": 2073745200,
                "relativePathInWorkspace": null,
                "stringValue": "CI/html5/40432400441815689/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"
        }]
    },

adSmartElement Object

Related Entities

Endpoints Using the adSmartElement Object

Parent Objects

adSmartElement 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
View type values

  • AdSmartTextElement

  • AdSmartHtmlElement

  • AdSmartImageElement

  • AdSmartAudioElement

  • AdSmartVideoElement

  • AdSmartUrlElement

id

ID of the element.

Long

Read-only

svKey

Key to the element, usually the type + number.

String

Required

value

Value of the element.

adSmartElementValue Object

Required

Object JSON Example

Example
"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/40432400441815689/mini.jpg",
                "width": "630",
                "height": "354",
                "enableFS": 1,
                "bitRate": null,
                "assetId": 2073745200,
                "relativePathInWorkspace": null,
                "stringValue": "CI/html5/40432400441815689/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"
        }]

adSmartElementValue Object

Related Entities

Endpoints Using the adSmartElementValue Object

Parent Objects

adSmartElementValue 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
View type values

  • AdSmartElementSimpleStringValue

  • AdSmartElementAssetReferenceValue

value

Value of the AdSmartElementSimpleStringValue.

String

Required

Only required for AdSmartElementSimpleStringValue.

name

Name of the asset.

String

Required

Only required for AdSmartElementAssetReferenceValue. Note that the remaining fields are enriched by the asset automatically.
Object JSON Example
Example
"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>"
            },

"value": {
                "type": "AdSmartElementAssetReferenceValue",
                "name": "mini.jpg",
                "contentTypeCode": 0,
                "publishPath": "CI/html5/40432400441815689/mini.jpg",
                "width": "630",
                "height": "354",
                "enableFS": 1,
                "bitRate": null,
                "assetId": 2073745200,
                "relativePathInWorkspace": null,
                "stringValue": "CI/html5/40432400441815689/mini.jpg"
            },
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments