PRODUCT
Follow

Resource URL

Depending on the API user that was created for you, use one of the following URLs:

  • https://api.sizmek.com/rest/tagManagers/retargeting

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

Note

Note: Confirm with your Sizmek customer success manager regarding the correct URL to use.

Objects Used by This Resource

The following objects are used by this endpoint:

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:

    • We recommend that for any PUT method that updates an object, 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.

    • 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

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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers/retargeting

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

Response Format

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers/retargeting/{id}

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

Response Format

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

Depending on the API user that was created for you, use one of the following URLs:

  • POST https://api.sizmek.com/rest/tagManagers/retargeting

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

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

Depending on the API user that was created for you, use one of the following URLs:

  • PUT https://api.sizmek.com/rest/tagManagers/retargeting/{id}

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

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

Depending on the API user that was created for you, use one of the following request formats:

  • DELETE https://api.sizmek.com/rest/tagManagers/retargeting/{id}

  • 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

Depending on the API user that was created for you, use one of the following request formats:

  • DELETE https://api.sizmek.com/rest/tagManagers/retargeting/delete

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

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

Comments

Powered by Zendesk