PRODUCT
Follow

Endpoints Using the servingSettings Object

servingSettings Object Definition

Serving settings inherit default values from the account level; however, you can modify these fields. If there is a change in the advertiser settings, the campaign level is changed accordingly.

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

ServingSettings

collectionBelowTheFold

Deprecated.

Boolean

Deprecated

dfCollecitonID

Deprecated.

Integer

Deprecated

pathLength

Number of events to collect in the conversion path. Path to conversion and conversion reports are calculated according to this setting.

Integer

Required

visibilityMinimumSurface

Percentage of the ad area required for an impression to be counted as viewable.

Integer

Required

visibilityMinimumDuration

Number of seconds that the minimum surface must appear for an impression to be counted as viewable.

Integer

Required

agencyVisibilityMinimumDuration

Number of seconds that the minimum surface must appear for an impression to be counted as viewable.

Integer

Required

agencyVisibilityMinimumSurface

Percentage of the ad area required for an impression to be counted as viewable.

Integer

Required

adChoicesCertificationProgramID

Regulation program to associate with the AdChoices icon. The regulation program you select depends on your country's regulations.

Integer

Required

adChoicesClickthroughURL

URL for a landing page if you want the consumer to arrive at a landing page after clicking the AdChoices icon.

String

Required

disableCookie

Determines whether to disable cookies and tracking capabilities for all ads. In addition, if this check box is selected on the advertiser level, the Disable Cookies check box for all new campaigns and placements under this advertiser is disabled by default.

Boolean

Required

saveAdCookie

Deprecated.

Boolean

Deprecated

retargetingCookieWindow

Deprecated.

Integer

Deprecated

deviceIntelligenceTypeId

Deprecated.

Integer

Deprecated

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