PRODUCT
Follow

Related Entities

Endpoints Using the piggyBack Object

Parent Objects

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

Strng

Required

PiggyBack

deduplication

Setting that determines how to handle redundent information.

String

Optional

firingMode

Setting that determines when to fire the activity.

String

Optional

siteName

Name of the site that, when selected as the winner site, triggers the 3rd party code.

String

Optional

siteId

ID of the site that, when selected as the winner site, triggers the 3rd party code.

Integer

Optional

deduplicationConversionAttributionModel

If deduplication is on, this is the attribution model that defines if the 3rd party activity code will run.

deduplicationConversionAttributionModel Object

Optional

Object JSON Example

deduplicationConversionAttributionModel Object

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

Note

Note: This object is only used when the deduplication setting is not Off.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Required

DeduplicationConversionAttributionModel

fire3rdPartyTracking

Attribution model that defines when the 3rd party activity code will run.

String

Optional

impressionValidUpTo

Defines the number of days, after a user saw an ad, that the ad can be attributed to a conversion.

Integer

Required

Mazimum is 90 days.

clickValidUpTo

Defines the number of days, after a user clicked an ad, that the ad can be attributed to a conversion.

Integer

Required

Maximum is 90 days.

Object JSON Example

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

Comments

Powered by Zendesk