PRODUCT
Follow

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

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

Comments

Powered by Zendesk