Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements and tag managers was disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Resource URL

https://adapi.sizmek.com/sas/tagManagers/retargetingDataValue

Objects Used by This Resource

The following objects are used by this endpoint:

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/rest/tagManagers/retargetingDataValue/{id}

Retrieve retargetingDataValue by ID.

GET

/rest/tagManagers/retargetingDataValue/?q={query}&max=500&from=0

Retrieve multiple retargetingDataValue objects by query parameters.

POST

/rest/tagManagers/retargetingDataValue

Save multiple retargetingDataValues.

Method Examples and Request Parameters

Important

Important:

  • For PUT calls, do the following:

    • For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.

    • You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:

       { "result": { "type": "Advertiser", ... } }

      You should make the following modifications, including your specific modifications, to the json object that you submit for the request.

       { "entities": [{ "type": "Advertiser", ... }] }

  • For POST calls, do the following:

    • Include the fields marked as Required, as indicated in the corresponding Object article.

    • Format the JSON object as follows:

       { "entities": [{ "type": "Advertiser", ... }] }

GET a retargetingDataValue by ID (GET)

Retrieve retargetingDataValue by ID.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

id

ID of the entity to be retrieved.

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/retargetingDataValue/{id}

Response Format

Example
{
    "metadata": {
        "total": 1
    },
    "debug": "dfe71cd3-c87d-4cfd-abfe-f17712a08bcf",
    "error": null,
    "result": [{
            "type": "RetargetingDataValue",
            "id": 1073741830,
            "acgModel": {
                "_type": "BasicAcgModel",
                "primaryAcg": {
                    "id": "2IZ4LRHVR7XKI",
                    "entityHint": "Primary RetargetingDataValue ==> 1073741829"…
                },
                "clientRefId": null,
                "version": 1576420982122676222,
                "createdBy": 1073741831,
                "createdByName": "User",
                "createdByAccount": 1073741826,
                "createdByAccountName": "Account",
                "createdOn": 1576420981833,
                "lastUpdatedBy": 1073741844,
                "lastUpdatedByName": "User",
                "lastUpdatedByAccount": 1073741855,
                "lastUpdatedByAccountName": "Account",
                "lastUpdateOn": 1576420981883,
                "value": "5a45vakd13226dasasdf6ffa4sd56ba",
                "retargetingActivityId": 1073741866,
                "valueOrdinal": null,
                "mm2valueId": null,
                "entityType": "RetargetingDataValue",
                "historyEntityType": "RetargetingDataValue",
                "historyEntityId": 1073741830,
                "name": "N/A"
            }
        ]
    }

GET Multiple retargetingDataValues by Query Parameters (GET)

Retrieves multiple retargetingDataValues. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new retargeting activities for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of retargeting activities to fetch for each page.

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}}

Note

Note: The date is according to the Unix epoch timestamp.

View values

NAME

DESCRIPTION

TYPE

VALUE

Value of the retargeting activity

String

RETARGETINGACTIVITYID

ID of the retargeting activity to which the retargetingData value is related.

Long

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/retargetingDataValue/?q={query}&max=500&from=0

Response Format

Example
{
    "metadata": {
        "total": 1
    },
    "debug": "e6cae5d2-eb71-4023-8ebc-855e0bb33212",
    "error": null,
    "result": [{
            "type": "RetargetingDataValue",
            "id": 1073741826,
            "acgModel": {
                "_type": "BasicAcgModel",
                "primaryAcg": {
                    "id": "2LZ0MHXYY9LFS",
                    "entityHint": "Primary RetargetingDataValue ==> 1073741825"…
                },
                "clientRefId": null,
                "version": 1578475571007651840,
                "createdBy": 1073741831,
                "createdByName": "User",
                "createdByAccount": 1073741877,
                "createdByAccountName": "Account",
                "createdOn": 1578475570979,
                "lastUpdatedBy": 1073741831,
                "lastUpdatedByName": "User",
                "lastUpdatedByAccount": 1073741826,
                "lastUpdatedByAccountName": "Account",
                "lastUpdateOn": 1578475570979,
                "value": "avi",
                "advertiserId": 1073741899,
                "retargetingActivityId": 1073741800,
                "valueOrdinal": null,
                "mm2valueId": null,
                "entityType": "RetargetingDataValue",
                "historyEntityType": "RetargetingDataValue",
                "historyEntityId": 1073741822,
                "name": "N/A"
            }
        ]
    }

Create One or More retargetingDataValues (POST)

Create one or more retargetingDataValues.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

Body

Request containing retargetingDataValue body to create.

JSON

Required

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/retargetingDataValue

Example
{
    "entities": [{
            "type": "RetargetingDataValue",
            "id": null,
            "retargetingActivityId": 1073741844,
            "advertiserId": 1073741833,
            "value": "yellow"
        },
        {
            "type": "RetargetingDataValue",
            "id": null,
            "retargetingActivityId": 1073741855,
            "advertiserId": 1073741866,
            "value": "chair"
        }
    ]
}

Response Format

Example
{
    "metadata": null,
    "debug": null,
    "error": [],
    "result": [{
                "type": "RetargetingDataValue",
                "id": 1073742214,
                "relationsBag": null,
                "uiPermissions": [{
                        "id": 1073741812,
                        "name": "DuplicateAd"
                    }, {
                        "id": 1073741811,
                        …],
                    "version": 1578478763612766208,
                    "createdBy": 1073741831,
                    "createdByName": "User",
                    "createdByAccount": 1073741826,
                    "createdByAccountName": "Account",
                    "createdOn": 1578478763613,
                    "lastUpdatedBy": 1073741831,
                    "lastUpdatedByName": "User",
                    "lastUpdatedByAccount": 1073741826,
                    "lastUpdatedByAccountName": "Account",
                    "lastUpdateOn": 1578478763613,
                    "retargetingActivityId": 1073741814,
                    "advertiserId": 1073741813,
                    "value": "yellow",
                    "valueOrdinal": null,
                    "mm2valueId": null
                },
                {
                    "type": "RetargetingDataValue",
                    "id": 1073742215,
                    "relationsBag": null,
                    "uiPermissions": [{
                            "id": 1073741816,
                            "name": "DuplicateAd"
                        }, {
                            "id": 1073741817,
                            …],
                        "version": 1578478932020232192,
                        "createdBy": 1073741831,
                        "createdByName": "User",
                        "createdByAccount": 1073741826,
                        "createdByAccountName": "Account",
                        "createdOn": 1578478932021,
                        "lastUpdatedBy": 1073741831,
                        "lastUpdatedByName": "User",
                        "lastUpdatedByAccount": 1073741826,
                        "lastUpdatedByAccountName": "Account",
                        "lastUpdateOn": 1578478932021,
                        "retargetingActivityId": 1073741825,
                        "advertiserId": 1073741818,
                        "value": "chair",
                        "valueOrdinal": null,
                        "mm2valueId": null
                    }
                ]
            }

Status Codes and Errors

The following table lists the possible HTTP status codes in responses.

CODE

DESCRIPTION

66107

RetargetingDataValues list is empty.

66108

Mismatch between retargeting activity and advertiser relation.

66109

RetargetingDataValues entities number size exceeded.

66110

RetargetingData list is not empty and UseRetargetingDataValueObject is ON. Please remove item from the list.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments