Retargeting Object – API Help Center

Related Entities

Endpoints Using the Retargeting Object

targetAudience Resource

Parent Objects

targetAudience Object

Retargeting 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 Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name	Description	Type	Required	Notes
advertiserId	ID of the advertiser to which the retargeting tags belong.	Integer	Required
cookieAge	Lookback window of the retargeting value selected, on the user's cookie.	Integer	Required

Object JSON Example

Retargeting Tag and Values Object Definition

Name	Description	Type	Required	Notes
tagID	ID of the retargeting tag.	Integer	Required
viewerExpose	Exposure state targeted.	String	Required	View values EXPOSE TO NOT_EXPOSED_TO
logicalOperator	Operator between two segments, if two are defined.	String	Required	View values AND OR

Object JSON Example

...
 "targetingItems": [{
            "type": "Retargeting",...
            "retargetingViewers": [{
                "tagId": 29560,
                "viewerExpose": "EXPOSE_TO",
                "logicalOperator": "AND",
                "tagOrdinal": null,
                "values": [7796105],
                "valuesOrdinal": []
            }, {
                "tagId": 18033,
                "viewerExpose": "EXPOSE_TO",
                "logicalOperator": "OR",
                "tagOrdinal": null,
                "values": [13226, 13227],
                "valuesOrdinal": []
            }],...
  }],
...

Related Entities

Endpoints Using the Retargeting Object

Parent Objects

Retargeting Object Definition

Note

Object JSON Example

Retargeting Tag and Values Object Definition

Object JSON Example

Comments