retargetingActivity Resource – API Help Center

Resource URL

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

Objects Used by This Resource

The following objects are used by this endpoint:

retargetingActivity Object

HTTP Method and URI List

HTTP METHOD	URI	DESCRIPTION
GET	/tagManagers/retargeting	Retrieves all retargeting activities.
GET	/tagManagers/retargeting/{id}	Retrieves a specific retargeting activity.
POST	/tagManagers/retargeting	Creates a new retargeting activity.
PUT	/tagManagers/retargeting/{id}	Updates a retargeting activity.
DELETE	/tagManagers/retargeting/{id}	Deletes a retargeting activity.
POST	/tagManagers/retargeting/delete	Deletes all retargeting activities.

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 all Retargeting Activities (GET)

Retrieves multiple retargeting activities. 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

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.

NAME	DESCRIPTION	TYPE
ACCOUNT	Name of account to which the retargeting activity belongs.	String
ACCOUNTID	ID of the account to which the retargeting activity belongs.	Long
ACTIVITYRULES	Number of rules in which this retargeting activity exists.	Integer
ADVERTISER	Name of the advertiser to which the retargeting activity belongs.	String
ADVERTISERID	ID of the advertiser to which the retargeting activity belongs.	Long
CREATEDBY	Name of the user that created the retargeting activity.	String
UPDATEDBY	Name of the user that was last to update the retargeting activity.	String
CREATEDON	Date retargeting activity was created.	Long
UPDATEDON	Date of last update (Date epoch).	Long
TAGMANAGERS	Number of tag managers in which this retargeting activity appears.	Integer
VALUES	Values used in the retargeting activity.	String

order

Sort order ASC or DESC, required if sort field name is specified (see here).

String

Optional

Note

Note: Required if a sort field name is specified.

By default, the API response is ascending.

sort

Sort by field name (see here).

String

Optional

advertiserID

Advertiser ID from which to retrieve retargeting activities.

Long

Optional

activityType

Type of the activity.

String

Required

Retargeting

enrichWithEntitiesCounts

Determines whether to enrich the retargeting activity with related entities' counts.

Boolean

Optional

Specify true if counts are required; otherwise, counts will be zero and performance is improved.

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/retargeting

Response Format

{
  "result": [{
    "type": "RetargetingActivity",
    "id": 1088886200,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 2,
          "name": "Testing Account",
          "internal": true
        },
        "advertiser": {
          "id": 1073758800,
          "name": "Test Advertiser"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1549984419555901400,
    "createdBy": 389370,
    "createdByName": "Jane Smith",
    "createdByAccount": 2,
    "createdByAccountName": "Testing Account",
    "createdOn": 1549984419547,
    "lastUpdatedBy": 389370,
    "lastUpdatedByName": "Jane Smith",
    "lastUpdatedByAccount": 2,
    "lastUpdatedByAccountName": "Testing Account",
    "lastUpdateOn": 1549984419547,
    "name": "Classic Cars Retargeting",
    "activityType": "Retargeting",
    "advertiserId": 1073758837,
    "rulesCount": 1,
    "tagManagersCount": 1,
    "conversionsCount": null,
    "tagManagerIds": [
      1073742894
    ],
    "accessLevel": "Full",
    "nxtTagManagement": true,
    "variableId": null,
    "variableName": null
  }
 ]
}

GET a Retargeting Activity (GET)

Retrieves a retargeting activity.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
id	ID of retargeting activity to fetch.	Long	Required

Request Format

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

Response Format

{
    "type": "RetargetingActivity",
    "id": 1088886200,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 2,
          "name": "Testing Account",
          "internal": true
        },
        "advertiser": {
          "id": 1073758800,
          "name": "Test Advertiser"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1549984419555901400,
    "createdBy": 389370,
    "createdByName": "Jane Smith",
    "createdByAccount": 2,
    "createdByAccountName": "Testing Account",
    "createdOn": 1549984419547,
    "lastUpdatedBy": 389370,
    "lastUpdatedByName": "Jane Smith",
    "lastUpdatedByAccount": 2,
    "lastUpdatedByAccountName": "Testing Account",
    "lastUpdateOn": 1549984419547,
    "name": "Classic Cars Retargeting",
    "activityType": "Retargeting",
    "advertiserId": 1073758837,
    "rulesCount": 1,
    "tagManagersCount": 1,
    "conversionsCount": null,
    "tagManagerIds": [
      1073742894
    ],
    "accessLevel": "Full",
    "nxtTagManagement": true,
    "variableId": null,
    "variableName": null
 }

Create a Retargeting Activity (POST)

Creates a new retargeting activity.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
Body	Request containing retargeting activity body to create.	JSON	Required

Request Format

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

{
  "result": {
    "type": "RetargetingActivity",
    "id": 1091033678,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 15229,
          "name": "Name",
          "internal": false
        },
        "advertiser": {
          "id": 1083743015,
          "name": "ttt1"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1562227125847851000,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1562227125849,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1562227125849,
    "name": "test Retargeting-DW2",
    "activityType": "Retargeting",
    "advertiserId": 1083743015,
    "rulesCount": 0,
    "tagManagersCount": 0,
    "conversionsCount": null,
    "tagManagerIds": [],
    "accessLevel": "Full",
    "nxtTagManagement": true,
    "variableId": null,
    "variableName": null
  }
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new retargeting activity resource.

Update an Existing Retargeting Activity (PUT)

Updates an existing retargeting activity.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
ID	ID of the retargeting activity.	Long	Required
Body	Request containing retargeting activity body to update.	JSON	Required

Request Format

PUT https://adapi.sizmek.com/sas/tagManagers/retargeting/{id}

{
  "result": {
    "type": "RetargetingActivity",
    "id": 1091033678,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 15229,
          "name": "Name",
          "internal": false
        },
        "advertiser": {
          "id": 1083743015,
          "name": "ttt1"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1562227289234735000,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1562227125849,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1562227289234,
    "name": "test Retargeting-DW2",
    "activityType": "Retargeting",
    "advertiserId": 1083743015,
    "rulesCount": 0,
    "tagManagersCount": 0,
    "conversionsCount": null,
    "tagManagerIds": [],
    "accessLevel": "Full",
    "nxtTagManagement": true,
    "variableId": 1083746819,
    "variableName": "some_param"
  }
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated retargeting activity resource.

Delete a Retargeting Activity (DELETE)

Deletes a single retargeting activity.

Note

Note: You can only delete a retargeting activity if it is not used in a tag manager.

Request Parameters

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
id	ID of retargeting activity to delete.	Long	Required

Request Format

DELETE https://adapi.sizmek.com/sas/tagManagers/retargeting/{id}

Response Format

A successful request returns the HTTP 200 OK status code; the requested retargeting activity is deleted.

Delete All Retargeting Activities (POST)

Deletes all retargeting activities.

Note

Note: You can only delete all retargeting activities if they are not used in a tag manager.

Request Format

DELETE https://adapi.sizmek.com/sas/tagManagers/retargeting/delete

Response Format

A successful request returns the HTTP 200 OK status code; the retargeting activities are deleted.

Resource URL

Objects Used by This Resource

HTTP Method and URI List

Method Examples and Request Parameters

Important

GET all Retargeting Activities (GET)

Request Query Parameters

Note

Note

Request Format

Response Format

GET a Retargeting Activity (GET)

Request Parameters

Request Format

Response Format

Create a Retargeting Activity (POST)

Request Parameters

Request Format

Response Format

Update an Existing Retargeting Activity (PUT)

Request Parameters

Request Format

Response Format

Delete a Retargeting Activity (DELETE)

Note

Request Parameters

Request Format

Response Format

Delete All Retargeting Activities (POST)

Note

Request Format

Response Format

Comments