tagBuilderParams Object – API Help Center

tagBuilderParams 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
placementId	Placement ID	Long	Internal
siteServing	Site Serving object	siteServing Object	Required
builderTagTypes	Used to create different types of tags for different pages.	Array of strings	Optional	View values SCRIPT IFRAME AUTO_DETECT DEFAULT CREATIVE_IFRAME
placementType	Type of placement	String	Internal	View values OUT_OF_BANNER TRACKING_ONLY IN_STREAM_VIDEO IN_STREAM_VIDEO_TRACKING VERIFICATION_TRACKING VERIFICATION_TRACKING_VIDEO IN_BANNER

Object JSON Example

...
"tagBuilderParams" :{ 
           "type" : "TagBuilderParams" , 
           "id" : null ,            
           "relationsBag" : null ,           
           "version" : null , 
           "placementId" : null , 
           "builderTagTypes" :[ 
              "SCRIPT" 
           ], 
           "siteServing" :{ 
              "secureServingProtocol" : "HTTPS" , 
              "lineIdToken" : null , 
              "customToken" : "CustomToken" , 
              "zipCodeToken" : null , 
              "countryToken" : null , 
              "serverDomainName" : "bs.serving-sys.com" , 
              "cacheBustingToken" : "[RANDOM]" , 
              "publisherCustomParam" : null , 
              "minZIndex" : "0" , 
              "impTracking" : "[RANDOM]" , 
              "clickTracking" : "[RANDOM]" , 
              "escapeNoScript" : false , 
              "generateMultipleTags" : true , 
              "generateIMGTag" : false , 
              "firstPartyAdIdToken" : null , 
              "disableCookies" : false , 
              "generateKeywords" : false 
           }, 
           "placementType" : null , 
           "exposeKwTag" : null 
        }, 
 ...

siteServing Object

siteServing 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
secureServingProtocol	Determines whether the tag will be generated with a secure protocol (HTTPS) or non-secure protocol (HTTP).	String	Required	HTTP HTTPS
lineIdToken	A dynamic token that allows publishers to pass data to AAS on the ad request.	String	Optional
customToken	Use this field to add a custom customToken.	String	Optional	For tracking placement, "RandomNumber" should not be used.
zipCodeToken	Enables you to add a token with a zip code on the publisher's site. The values are added to the tag during ad serving, and are used to override the AAS geo information for the impression.	String	Optional
countryToken	Enables you to add a token with a country code on the publisher's site. The values are added to the tag during ad serving, and are used to override the AAS geo information for the impression.	String	Optional
serverDomainName	Internal.	String	Internal
cacheBustingToken	Determines the token to add to the tag when serving a placement : Publisher ad server: Automatically adds the ad server's supported token for cache busting. Custom Token: Enables you to define a custom value for the cache busting token. Make sure to obtain the token from the 3rd party ad server used to serve the placement. How does cache busting work? Cache busting prevents a browser from reusing an ad it has already seen and cached, or saved, to a temporary memory file. This forces the user’s browser or network proxy to fetch a fresh copy of data for each request, providing a more accurate count of the number of requests from users. In advertising, the technique is used to cause a separate banner request to be sent to the server, thus ensuring the banner is not cached and banner advertisement impressions are not under-counted. The cache busting token placed in the tag is replaced by the site ad server with a random number or timestamp to avoid caching problems.	String	Optional
publisherCustomParam	Used for analytics purposes, and is available in Path to Conversion and Raw Data Feed reports.	String	Optional
minZIndex	Determines the ad’s position in the order of layers on the page.	String	Optional
impTracking	Enables you to add the URL for tracking impressions by the selected ad server. The URL can be obtained from the publisher's ad server support.	String	Optional
clickTracking	Enables you to add the URL for tracking clicks by the selected ad server. The URL can be obtained from the publisher's ad server support.	String	Optional
escapeNoScript	Relevant for the Create iFrame option. For the NoScript part of the code, the tag URL (variable) will not be escaped.	Boolean	Required
generateMultipleTags	Enables generation of multiple tags for a single placement.	Boolean	Required
generateIMGTag	Determines whether to create an additional IMG tag when generating the placement tag.	Boolean	Required
firstPartyAdIdToken	A token that is added to the tag and allows the 1st party server to add their ad ID. The ad ID enables the AAS server to identify to which AAS ad it should log the tracking call.	String	Optional
disableCookies	Disable or enable cookies for placement.	Boolean	Required
generateKeywords	If on the placement tag, should include site keywords for targeting.	Boolean	Required

Object JSON Example

...
"siteServing": {
   "secureServingProtocol": "HTTP",
   "lineIdToken": "1",
   "customToken": null,
   "zipCodeToken": null,
   "countryToken": null,
   "serverDomainName": "bs.serving-sys-int.com",
   "cacheBustingToken": "+Ads_Timestamp+",
   "publisherCustomParam": "dtn836odRE",
   "minZIndex": "1000",
   "impTracking": "k1nhwC9fVs",
   "clickTracking": "WJgfCFWO0n",
   "escapeNoScript": true,
   "generateMultipleTags": true,
   "generateIMGTag": true,
   "firstPartyAdIdToken": "fzYm5EiXIA",
   "disableCookies": true,
   "generateKeywords": true
 },
...

tagBuilderParams Object Definition

Note

Object JSON Example

siteServing Object

siteServing Object Definition

Note

Object JSON Example

Comments