PRODUCT
Follow

Endpoints Using the 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 Sizmek 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 Sizmek on the ad request.

String

Optional

customToken

Use this field to add a custom cacheBustingToken.

String

Optional

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 Sizmek 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 Sizmek geo information for the impression.

String

Optional

serverDomainName

Internal.

String

Internal

cacheBustingToken

If a publisher ad server is not selected, a cache busting token can be used by the ad server for tracking impressions and clicks. The token can be obtained from the publisher's ad server support.

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. Enables a custom parameter to be sent to Sizmek Ad Suite for every impression event.

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 Sizmek server to identify to which Sizmek 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

Parent Objects

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

Comments

Powered by Zendesk