PRODUCT
Follow

Endpoints Using the verificationTracking Placement Object

verificationTracking Placement 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

actualStartDate

First impression date (Date epoch).

Long

Read-only

allowHTML5DynamicExpansion

Enables the system to automatically detect the direction in which HTML5 expandable ads should expand during serving.

Boolean

Required

Required in a programmatic environment, where the location of the ad that will be displayed is not known in advance.

allowServingInAutoRefreshSite

Internal.

Internal

Internal

analyticsData

Contains a set of analytics metrics. Appears in a box on the placements page.

placementAnalyticsData Object

Read-only

attached

Determines whether placement is attached to an ad.

Boolean

Read-only

bandwidth

Internal.

Internal

Internal

brandTimeZone

Time zone for brand. Used in the Delivery Group that is attached to the placement.

String

Read-only

campaignId

Placement's campaign ID.

Long

Required

Searchable field for placement.

cookieSyncType

Internal.

Internal

Internal

customFields

Custom fields display custom metadata that can be used, for example, as a token on click-throughs and 3rd party events, or in Sizmek reporting.

customFields Object

Optional

controlOverDelivery

Internal.

Internal

Internal

defaultTrackingAd

Internal.

Internal

Internal

deliveryRate

Internal.

Internal

Internal

disableCookies

Disable or enable cookies for placement.

Boolean

Optional

hardStop

Internal.

Internal

Internal

packageId

Internal.

Internal

Internal

packageName

Internal.

Internal

Internal

id

ID of the placement.

Long

Read-only

mediaCostData

Object that defines the cost model and other media cost fields.

mediaCostData Object

Required

mobileApplicationAdEnabler

Type of mobile support .

String

Optional

mode

Internal.

Internal

Internal

name

Name of the placement.

String

Required

placementAdCount

Number of ads attached to placement.

Integer

Read-only

placementDGData

Internal.

Internal

Internal

placementLevel

Determines whether the placement is on a placement level or a package level.

Boolean

Required

True: Placement is on the placement level.

False: Placement is on the package level.

placementType

Type of placement.

String

Required

VERIFICATION_TRACKING

placementAttachmentData

Object that describes the placement's attachment.

placementAttachmentData Object

Read-only

placementMV

Determines whether placement is mass version.

Boolean

Required

True when a placement is attached to a DCO ad.

preBidPeer

Determines if the DSP line item uses Peer39 pre-bid targeting. It will be assigned a different rate for billing purposes.

Boolean

Optional

True: Placement is on the placement level.

False: Placement is on the package level.

publisherTargetingIds

Media targeting audience assigned to placement.

Long

Optional

servingAndCostData

Serving and cost data for placement.

servingAndCostData Object

Required

relationsBag

Internal.

relationsBag Object

Internal

createdBy

ID of the user that created the account .

Long

Read-only

createdByName

Name of the user that created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (Date epoch).

Long

Read-only

lastPublished

Last time placement was published.

Long

Read-only

Stored in Epoch time.

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of last update (Date epoch).

Long

Read-only

sectionName

Name of Site section where the placement will serve.

String

Read-only

specialInstructions

Internal.

String

Optional

status

Placement status.

String

Read-only

Searchable field for placement.

tagBuilderParams

Parameters to build tag for placement.

tagBuilderParams Object

Optional

taxonomyId

ID of the taxonomy to which this placement belongs.

Integer

Required

1402 (Sizmek DSP)

taxonomyName

Name of the taxonomy.

String

Required

testImpressions

Internal.

Internal

Internal

trackingFormat

Format of the verification tracking.

String

Required

Display

trackingTagLocationId

Location ID of the taxonomy to which this placement belongs.

String

Required

1402 (Sizmek DSP)

trackingTagLocationName

Location ID of the taxonomy to which this placement belongs.

String

Required

1402 (Sizmek DSP)

trackingType

Type of tracking for the placement.

String

Required

type

Type of placement.

String

Required

VerificationTrackingPlacement

Note

Note: If you want to use an External Media Plan, see externalMediaPlan Object.

Object JSON Example

Child Objects

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

Comments

Powered by Zendesk