PRODUCT
Follow

Related Entities

Endpoints Using the rootContainer Object

Parent Objects

rootContainer 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

String

Read-only

RootContainer

id

ID of the delivery group.

Integer

Read-only

relationsBag

Holds hierarchy entities (parent/children).

relationsBag Object

Read-only

version

Internal.

Integer

Read-only

childRotationType

Rotation type of subcontainers.

Integer

Required

subContainers

List of all base ad containers attached to this delivery group.

subContainers Object

Optional

childOptimizationMetric

Metric towards which the automatic optimization engine optimizes when the selected rotation method for a delivery group is automatic optimization.

String

Required

childConversionTagId

ID of the conversion tag towards which to optimize when the selected optimization metric is conversions.

Integer

Required

childConversionTagName

Name of the tag towards which the automatic optimization engine is optimizing.

String

Optional

Object JSON Example

subContainers Object

subContainers 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 object.

String

Read-only

subContainers

id

ID of the delivery group.

Integer

Read-only

rotationSetting

Rotation type.

rotationSetting Object

Required

masterAdId

Master ad ID for the delivery group ad.

Long

Required

name

Name of the ad.

String

Read-only

adName

Deprecated.

Deprecated

Deprecated

Object JSON Example

rotationSetting Object

rotationSetting 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 object.

String

Read-only

rotationSetting

id

ID of the master ad.

Integer

Required

enabled

Status of the ad.

Boolean

Required

rotationType

Type of rotation.

String

Required

weight

Deprecated.

Deprecated

Deprecated

Object JSON Example

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

Comments

Powered by Zendesk