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 was disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the schema Object

Parent Objects

schema 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

APIAdSmartVersionSchema

id

Internal.

Internal

Internal

smartElements

List of the smart elements for the ad version.

Array of smartElements Object

Optional

catalog

Includes the catalog settings in case of a catalog ad.

catalog Object

Optional

Object JSON Example

Example
,
        "schema": {
            "type": "APIAdSmartVersionSchema",
            "id": 15435820449811,
            "smartElements": [{
                "type": "AdSmartImageElement",
                "id": 15435820449812,
                "svKey": "product_image",
                "value": {
                    "type": "AdSmartElementSimpleStringValue",
                    "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png",
                    "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png"
                },
                "smartElementSource": "ConfigJS"
            }],
            "catalog": null
        },

smartElements Object

smartElements 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

AdSmartImageElement

id

Internal.

Internal

Internal

svKey

Name of the dynamic element

String

Required

value

Value of the smart element.

value Object (SmartElement)

Required

smartElementSource

Source from which the dynamic element was created.

String

Read-Only

config.js

Object JSON Example

Example
"schema": {
            "type": "APIAdSmartVersionSchema",
            "id": 15435820449811,
            "smartElements": [{
                "type": "AdSmartImageElement",
                "id": 15435820449812,
                "svKey": "product_image",
                "value": {
                    "type": "AdSmartElementSimpleStringValue",
                    "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png",
                    "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png"
                },
                "smartElementSource": "ConfigJS"
            }],
            "catalog": null
        },

value Object (SmartElement)

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

The value for the smart element image is pulled from a URL.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Required

AdSmartElementSimpleStringValue

value

Value of the dynamic element in plain text.

String

Required

stringValue

Value of the dynamic element in plain text.

String

Read-Only
Object JSON Example
Example
,
        "schema": {
            "type": "APIAdSmartVersionSchema",
            "id": 15435820449811,
            "smartElements": [{
                "type": "AdSmartImageElement",
                "id": 15435820449812,
                "svKey": "product_image",
                "value": {
                    "type": "AdSmartElementSimpleStringValue",
                    "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png",
                    "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png"
                },
                "smartElementSource": "ConfigJS"
            }],

value Object Definition

The value for the smart element image is pulled from the asset library.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Required

AdSmartElementAssetReferenceValue

name

Name of the asset.

String

Read-only

contentTypeCode

Internal.

Internal

Internal

publishPath

Specific location of file in storage.

String

Required

width

Width of the asset.

Integer

Read-only

height

Height (dimensions) of the asset.

Integer

Read-only

enableFS

Internal.

Internal

Internal

bitRate

Bit rate of the asset.

Integer

Read-only

assetId

ID of the image asset.

Long

Read-only

relativePathInWorkspace

Relative path of the asset in the ads' Workspace folder.

Internal

Read-only

stringValue

Value of the asset in string format.

String

Read-only
Object JSON Example
Example
"schema": {
    "type": "APIAdSmartVersionSchema",
    "id": 31255607264000,
    "smartElements": [{
                "type": "AdSmartImageElement",
                "id": 31255607264030,
                "svKey": "ClaimFrame3",
                "value": {
                    "type": "AdSmartElementAssetReferenceValue",
                    "name": "3242322th4234.png",
                    "contentTypeCode": 0,
                    "publishPath": "PROD/asset/2/IMAGE/20191218/3242322th4234_50500407243321260.png",
                    "width": "300",
                    "height": "250",
                    "enableFS": 1,
                    "bitRate": null,
                    "assetId": 2080095005,
                    "relativePathInWorkspace": null,
                    "stringValue": "PROD/asset/2/IMAGE/20191218/3242322th4234_50500407243321260.png"
                }

catalog Object

catalog 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

Read-only

APICatalog

minVersions

Minimum number of versions to serve in the catalog ad.

Integer

Required

maxVersions

Maximum number of versions to serve in the catalog ad.

Integer

Required

Object JSON Example

Example
...,
"catalog": {
    "type": "APICatalog",
    "minVersions": 2,
    "maxVersions": 40
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments