PRODUCT

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

Related Entities

Endpoints Using the siteTagSettings Object

Parent Objects

siteTagSettings Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

type

Type of entity.

String

SiteTagSettings

clearEscapingOfNoscripTag

Relevant for the Create iFrame option. For the NoScript part of the code, the tag URL (variable) will not be escaped.

Boolean

referringURLToken

Adds the Referring URL Token to the generated placement tags for the vURL (verification/page URL) parameter. The token will be replaced by the publisher with the Referring URL.

String

trackingTagType

Code generated for tracking placements includes URLs for tracking impressions and clicks. This option determines whether to generate these URLs within IMG tags (required by certain ad servers) instead of within regular or script tags.

String

tagTypes

Enables you to select a default tag type for placements in this site:

  • Script: Generates code for serving ads by using a script.

  • iFrame: Serves the ads to an iFrame in the web page.

  • Auto Detect: AAS automatically determines whether the ad is being served into an iFrame, and then serves the ad appropriately. Please note that with this option, when iFrames are used to serve content, Auto Detect will identify the ad as an iFrame, and expand it beyond the content's boundaries.

  • Create iFrame: Creates the iFrame to which the ads will be served.

Array of Strings

createIFrameSupported

Adds the Create iFrame option to the publish settings for placements to run on this site. If you do not set this value to true, only Script, iFrame, and Auto Detect options are enabled.

Boolean

protocol

Determines whether the tag will be generated with a secure protocol (HTTPS) or non-secure protocol (HTTP).

  • For HTML5 and In-Stream ads, when a tag is generated with a secure protocol, the ad request and all subsequent AAS ad server calls will be over a secure protocol, regardless of whether the tag is placed on a secure page or a non-secure page.

  • For Adobe Flash Rich Media ads, because of Flash framework limitations, if a secure tag is placed on a non-secure page, the ad request is sent over a secure protocol; however, the ad's assets will use a non-secure protocol.

When generating a secure tag, make sure that you check that all other URLs, for example, 3rd party trackers, used by the ad are using the secure protocol.

String

Object JSON Example

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments