PRODUCT
Follow

automaticOptimizationData 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

optimizationMetric

Metric by which optimization is measured.

String

Read-only

conversionTagId

ID of the conversion tag.

String

Read-only

conversionTagName

Name of the conversion tag.

String

Read-only

dynamicElementOptimization

Sets the dynamic element to optimize the versioning.

DynamicElementOptimization Object

Read-only

createdBy

ID of the user who created the ad.

Long

Read-only

createdByName

Name of the user who created the ad.

String

Read-only

createdByAccount

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

Long

Read-only

createdByAccountName

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

String

Read-only

createdOn

Date and time the ad was created (Date epoch).

Date (Long)

Read-only

lastUpdatedBy

ID of the user who last updated the ad.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the ad.

String

Read-only

lastUpdatedByAccount

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

Long

Read-only

lastUpdatedByAccountName

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

String

Read-only

lastUpdateOn

Date and time the ad was last updated (Date epoch).

Date (Long)

Read-only

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

Object JSON Example

DynamicElementOptimization Object

Related Entities

Endpoints Using the DynamicElementOptimization Object

DynamicElementOptimization 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

smartElementKey

Smart item that the AO engine will break into groups and optimize (click here for details).

String

secondaryMetric

Allows an option to split into optimization groups both by the dynamic element and the retargeting/targeting value.

String

optimizationIntervalType

Defines the run times of the optimization engine (every X weeks/days).

String

optimizationInterval

Defines the numeric value of the threshold type

Internal

optimizationDataLookBackType

Defines on which data the optimization engine will make the decisions based on (i.e. only impressions from the last 30 days)

String

optimizationDataLookBack

Defines on which data the optimization engine will make the decisions based on (i.e. only impressions from the last 30 days)

Integer

optimizationThresholdType

Items that are measured in the optimization threshold field.

String

optimizationThreshold

Defines what is the minimal threshold for the automatic optimization engine to start optimizing.

Internal

minimumWeight

Defines the minimum weight that will be given to an optimization group by the AO engine

Double

endDate

Defines the end date of the AO run.

Long

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

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

Parents Object Definition

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

Children Object Definition

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

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

Comments

Powered by Zendesk