PRODUCT
Follow

Related Entities

Endpoints Using the trackingOnly Placement Object

trackingOnly 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 Ad Suite (SAS) 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.

campaignName

Placement campaign name.

String

Read-only

Searchable field for placement.

cookieSyncType

Internal.

Internal

Internal

 

controlOverDelivery

Internal.

Internal

Internal

 

createdBy

ID of the user who created the placement.

Long

Read-only

 

createdByAccount

ID of the account of the user who created the placement.

Long

Read-only

 

createdByAccountName

Name of the account of the user who created the placement.

String

Read-only

 

createdByName

Name of the user who created the placement.

Long

Read-only

 

createdOn

Date and time on which the placement was created (Date epoch).

Long

Read-only

 

customFields

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

customFields Object

Optional

 

defaultTrackingAd

Internal.

Internal

Internal

 

deliveryRate

Internal.

Internal

Internal

 

disableCookies

Disable or enable cookies for placement.

Boolean

Optional

 

hardstop

Internal.

Internal

Internal

 

id

ID of the placement.

Long

Read-only

 

lastPublished

Last time placement was published.

Long

Read-only

Stored in Epoch time.

lastUpdatedBy

ID of the user who last updated the placement.

Long

Read-only

 

lastUpdatedByAccount

ID of the account of the user who last updated the placement.

Long

Read-only

 

lastUpdatedByAccountName

Name of the account of the user who last updated the placement.

String

Read-only

 

lastUpdatedByName

Name of the user who last updated the placement.

String

Read-only

 

lastUpdatedOn

Date and time on which the placement was last updated (Date epoch).

Long

Read-only

 

mobileApplicationAdEnabler

Type of mobile support .

String

Optional

mode

Internal.

Internal

Internal

 

name

Name of the placement.

String

Required

 

packageId

Placement package ID.

Long

Optional

Searchable field for placement.

packageName

Name of package for this placement. SAS creates a default package if none exists for the placement.

String

Read-only

Searchable field for placement.

placementAdCount

Number of ads attached to placement.

Integer

Read-only

 

placementAttachmentData

Object that describes the placement's attachment.

placementAttachmentData Object

Read-only

 

placementDGData

Internal.

Internal

Internal

 

placementMV

Determines whether placement is mass version.

Boolean

Required

True when a placement is attached to a DCO ad.

placementType

Type of placement.

String

Required

TRACKING_ONLY

publisherTargetingIds

Media targeting audience assigned to placement.

Long

Optional

 

relationsBag

Internal.

relationsBag Object

Internal

 

sectionId

ID of Site section where the placement will serve.

Long

Optional

 

sectionName

Name of Site section where the placement will serve.

String

Read-only

 

servingAndCostData

Serving and cost data for placement.

servingAndCostData Object

Required

 

siteId

Placement site ID.

Long

Required

Searchable field for placement and placement package.

specialInstructions

Internal.

String

Optional

 

status

Placement status.

String

Read-only

Searchable field for placement.

tagBuilderParams

Parameters to build tag for placement.

tagBuilderParams Object

Optional

 

trackingAds

Internal.

Internal

Internal

 

type

Type of placement (main entity, not child objects).

String

Required

TrackingOnlyPlacement

Object JSON Example

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

Comments

Powered by Zendesk