PRODUCT
Follow

Related Entities

Endpoints Using the inBanner Placement Object

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

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.

analyticsData

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

placementAnalyticsData Object

Read-only

actualStartDate

First impression date (Date epoch).

Long

Read-only

controlOverDelivery

Internal.

Internal

Internal

supportMobileApplications

Internal.

Internal

Internal

bandwidth

Internal.

Internal

Internal

hardStop

Internal.

Internal

Internal

attached

Determines whether placement is attached to an ad.

Boolean

Read-only

placementAttachmentData

Object that describes the placement's attachment.

placementAttachmentData Object

Read-only

placementAdCount

Number of ads attached to placement.

Integer

Read-only

placementMV

Determines whether placement is mass version.

Boolean

Required

True when a placement is attached to a DCO ad.

createdBy

ID of the user who created the placement.

Long

Read-only

createdByName

Name 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

createdOn

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

Long

Read-only

campaignName

Placement campaign name.

String

Read-only

Searchable field for placement.

lastUpdatedBy

ID of the user who last updated the placement.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the placement.

String

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

lastUpdateOn

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

Long

Read-only

relationsBag

Internal.

relationsBag Object

Internal

bannerSize

Height and width of banner size.

bannerSize Object

Required

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 Sizmekreporting.

customFields Object

Optional

disableCookies

Disable or enable cookies for placement.

Boolean

Required

placementDGData

Internal.

Internal

Internal

id

ID of the placement.

Long

Read-only

mobileApplicationAdEnabler

Type of mobile support.

String

Required

name

Name of the placement.

String

Required

lastPublished

Last time placement was published.

Long

Read-only

Stored in Epoch time.

packageId

Placement package ID.

Long

Optional

Searchable field for placement.

packageName

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

String

Read-only

Searchable field for placement.

placementType

Type of placement.

String

Required

Value: IN_BANNER

publisherTargetingIds

Media targeting audience assigned to placement.

Long

Optional

sectionId

ID of Site section where the placement will serve.

Long

Optional

sectionName

Name of Site section where the placement will serve.

String

Optional

servingAndCostData

Serving and cost data for placement.

servingAndCostData Object

Required

siteId

Placement site ID.

Long

Required

Searchable field for placement and placement package.

status

Placement status.

String

Read-only

Searchable field for placement.

tagBuilderParams

Parameters to build tag for placement.

tagBuilderParams Object

Optional

type

Type of entity.

String

Required

Value: In-Banner Placement

Object JSON Example

bannerSize Object

bannerSize 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.

Parameter

Description

Type

Required

Notes

type

Type of entity.

String

Required

APIBannerSize

height

Height of the placement area.

Integer

Required

Searchable field for placement

width

Width of placement area.

Integer

Required

Searchable field for placement

Object JSON Example

placementAnalyticsData Object

placementAnalyticsData 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

impressions

Number of impressions for the placement. (Counted when an ad is fetched from its source.)

Long

Read-only

clicks

Counted when a user clicks on an ad.

Long

Read-only

lastUpdated

Date and time that the last changes were made to the placements.

Long

Read-only

ctr

Total number of clicks divided by the total impressions.

Float

Read-only

actualStartDate

Actual date that a placement began to appear.

Long

Read-only

Object JSON Example

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Parents Object

Related Entities

Endpoints Using the Parents Object

Parents 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

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1072241834,
 "name": "testing account",
 "internal": false
 }

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1073741822,
 "name": "AAA"
 }

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741833,
 "name": "BBB"
 }

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741831,
 "name": "ccc"
 }

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741853,
 "name": "ddd"
 }

Object JSON Example

Children Object

Related Entities

Endpoints Using the Children Object

Children 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

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only

Object JSON Example

placementAttachmentData Object

placementAttachmentData 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.

Parameter

Description

Type

Required

Notes

attachedToUntargeted

Determines if the placement is attached to a delivery group that is untargeted.

Boolean

Read-only

targetAudienceIds

IDs for the target audience If the placement is attached to a delivery group that is a target audience.

Array of IDs

Internal

Object JSON Example

customFields Object

Related Entities

Endpoints Using the customFields Object

customFields 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

type

Type of entity.

String

Read-only

CustomFields

id

Internal.

Internal

Internal

textFields

An object that contains all of the text fields defined on the entity that includes the custom field.

customTextField Object

Optional

numericFields

Internal.

Internal

Internal

decimalFields

Internal.

Internal

Internal

choiceListFields

An object that contains all of the choice list fields defined on the entity that includes the custom field.

customTextField Object

Optional

labelsFields

Internal.

Internal

Internal

Object JSON Example

customTextField Object

Related Entities

customTextField 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.

Parameter

Description

Type

Required

Notes

Number that represents the ID of the custom field defined on the account.

Number that represents the ID of the custom field defined on the account.

String

Read-only

type

Type of entity.

String

Read-only

CustomTextField

id

ID of the custom field defined on the account.

String

Read-only

name

Internal.

Internal

Internal

fieldType

Type of custom field that was defined on the account.

String

Required

accountId

Internal.

Internal

Internal

value

Value of the custom field as defined on the entity.

String

Optional

Object JSON Example

servingAndCostData Object

servingAndCostData 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.

Parameter

Description

Type

Required

Notes

mediaServingData

Object that describes the placement's media serving data.

mediaServingData Object

Required

mediaCostData

Object that describes the placement's media cost data.

mediaCostData Object

Required

isHardStop

Determines whether placement is hard-stop at end of date.

Boolean

Required

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.

Object JSON Example

mediaCostData Object

mediaCostData 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.

Parameter

Description

Type

Required

Notes

actionType

Type of action on the asset level.

String

conversionActivityId

For cost model CPA, ID of the conversion activity.

String

Required

In case of All Conversions, this value is -1.

conversionId

Internal.

Internal

Internal

costModel

Total cost for the ad for a specific period. Calculation depends on the Cost-Based Model.

  • CPA: Cost per Conversion

  • CPC: Cost per Click

  • CPCV: Cost per Video Fully Played

  • CPE: Cost per User Interaction

  • CPM: Cost per Impression

  • CPV: Cost per Video Starts

  • Flat Fee: Cost is fixed and calculated as ((booked cost)/(number of scheduled days or hours) * (Number of running days or hours past the start date - within time periods))

  • Time-Based: Cost is fixed for a prearranged time period. There is no cost for days without delivery.

  • Zero Cost: Placement cost is free (no cost for the advertiser).

String

Required

customInteraction

Internal.

Internal

Internal

ignoreOverDelivery

For reporting purposes, determines whether the report should ignore over delivery in calculating media cost.

Boolean

Required

interactionId

Internal.

Internal

Internal

orderedUnits

Ordered units for costs set for the placement.

Integer

Optional

rate

Cost of the placement according to its cost model.

Optional

Optional

type

Type of entity.

String

Read-only

MediaCost

Object JSON Example

mediaServingData Object

mediaServingData 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.

Parameter

Description

Type

Required

Notes

endDate

End date of placement.

Long

Required

Stored in Epoch time.

hardStopMethod

Continue serving settings according to end date or booked units.

String

Required

startDate

Start date of placement.

Long

Required

units

Booked impressions.

Integer

Optional

Object JSON Example

tagBuilderParams Object

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 Sizmek 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

placementType

Type of placement

String

Internal

Object JSON Example

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

placementPackage Object

placementPackage 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.

PARAMETER

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of package.

String

Required

PlacementPackage

id

ID of the package.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user who created the package.

Long

Read-only

createdByName

Name of the user who created the package.

String

Read-only

createdByAccount

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

Long

Read-only

createdByAccountName

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

String

Read-only

createdOn

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

Long

Read-only

lastUpdatedBy

ID of the user who last updated the package.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the package.

String

Read-only

lastUpdatedByAccount

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

Long

Read-only

lastUpdatedByAccountName

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

Long

Read-only

lastUpdateOn

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

Long

Read-only

name

Name of the package.

String

Required

campaignId

Package's campaign ID

Long

Required

campaignName

Package's campaign name.

String

Read-only

siteId

Package's site ID.

Long

Required

mediaServingData

Object that describes the package's media serving data.

mediaServingData Object

Required

mediaCostData

Object that describes the package's media cost data.

mediaCostData Object

Required

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.

Object JSON Example

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

Comments

Powered by Zendesk