Sizmek FAQs

This article provides information to help you get started with the Help Center and Training materials.

Give Us Feedback

When you use the Help Center, we want your experience to be the best it can be. If you did not find what you were looking for, or if you have a question about an article, please let us know. You can click the Feedback link on any page to open a Feedback window.

Raw Data Feeds

Open a Ticket

In addition to providing feedback, you can always open a ticket with Sizmek Support. They will forward it to the documentation team for review.

Button

Description

Follow/Unfollow

Click to follow (or unfollow) an article. When we update the article, you'll know right away.

Use these buttons to create documentation tickets.

Button

Description

Follow/Unfollow

Click to follow (or unfollow) an article. When we update the article, you'll know right away.

Use

Sizmek Support uses this option to tag an article when closing a specific ticket.

Fix

If you think that an article needs some modifications, use this option to suggest changes.

Flag

If you find a broken link or missing image, use this link to flag the article. (Additional reasons for flagging an article include inaccurate/outdated/insufficient information or missing attachment.)

Add

Sizmek Support uses this option to add an article to the Help Center.

Request

Use this option to request a new article for the Help Center.

Upgrading from Sizmek MDX to Sizmek Ad Suite

If you are a Sizmek MDX user upgrading to Sizmek Ad Suite, we have a dedicated section in the Help Center with many articles that describe differences between the two applications, such as terminology and methodology. Please see Upgrading from MDX to SAS for more details.

Training Videos

The Help Center includes many informative videos that include examples for common workflows.

Article with Video

Description

Introduction to Sizmek Ad Suite

Describes navigation, views, and search in Sizmek Ad Suite.

Creating a Campaign and Adding Placements

Describes how to set up a campaign and manage your media plan.

Working with Event Rules in Your Campaign

Describes shows how to define rules for click-through URLs and 3rd party tracking events that repeat for specific placement types, ad formats, or sites.

Creating Delivery Groups

Describes and shows how to work with delivery groups when working in the Advanced Trafficking mode.

Attaching Delivery Groups to Placements

Describes and shows how to traffic a large campaign that includes multiple ads for multiple placements, and requires the use of delivery groups.

Publishing Placements and Generating Tags

Describes and shows how to publish placements and generate placements' tags.

Building an HTML5 Standard Ad

Describes how to build static image ads or HTML5 coded ads using a blank ad or the ad creation wizard.

In-Stream Ads and Video Auto-Transcoding

Describes how to create In-Stream VAST and VAST Enhanced ads.

Aggregated Reports

Describes how to create and manage Aggregated reports.

Path to Conversion Reports

Describes how to create and manage Path to Conversion reports.

Describes how to create and manage Raw Data Feeds.

Overview

Raw Data Feeds (RDF), an upgrade from Cookie-Level Data (CLD) in Sizmek MDX, are now available in Sizmek Ad Suite (SAS). Since our clients are upgrading from MDX to SAS and using RDF, these important points will help to ensure a smooth transition:

The data fields in CLD and RDF are almost the same, but there are some differences due to different data fields in MDX and SAS. For the exact data fields in RDF, please refer to the following links:

Standard Feed Fields

Interaction Feed Fields

Conversion Feed Fields

Site Activity Fields

At the bottom of each article, there are sample feeds. You can refer to these samples to see the format of the fields and how they vary between CLD and RDF.

You should use RDF metadata files to match between the metadata and the RDF data feeds. Similarly, you should use CLD metadata files to match between the metadata and the CLD data feeds.

For example, for City, you should use:

RDF: Sizmek_RDF_Match_CityMatchFile_EntityType_EndityID_FromData_ToDate.csv

CLD: MM_CLD_Match_CityMatchFile_EntityType_EndityID _Daily_Date.csv

Important

Important: CLD match files are fully extracted for every CLD run. RDF match files are incremental and include only updates/new entities created since the last run.

RDF and CLD Fields

This table illustrates the differences between RDF and CLD fields.

Item

RDF

CLD (Daily)

CLD (Incremental)

Feed setup

UI or RESTful API

Custom dev

Custom dev

Number of files in each feed

Based on user selection of maximum rows per file

Based on number of rows

30*4 plus match files (four times a day)

Delivery method

FTP (Sizmek)

S3 or FTP (Sizmek)

S2 or FTP (Sizmek)

Format

csv or txt

csv

txt

Delimiter

comma, dot, pipe, 7F (Hex)

comma

7F (Hex)

Number of rows

500K (minimum) to 1M (maximum)

1M

All data is divided into 30 files

Headers

Configurable (include or do not include headers)

Entities/Match files

One-time snapshot plus ongoing increments, which include added/modified entities

Snapshot

Snapshot

TimeZone

UTC

UTC

UTC

Frequency of execution

Single delivery every hour

Daily delivery

Four deliveries each day (only three with data)

Filename format

Sizmek_RDF_<Data Feed>_<Entity Level>_<EntityID>_<Date_From>_<Date_To>.tar.gz

Compression

Gzip

Zip/Gzip

Zip

Data availability

Events occurred up to three hours back

Previous day

Three times a day, events from previous 8 hours

Retention policy (FTP)

One month

Seven days

Seven days

Done file

Checksum

Archives (Tar)

Reprocessing Metadata

Reprocessing Data

Support team

Custom dev

Custom Dev

SEM Data

(After SEM is released in SAS)

C4SS Data

(Currently AdWords and Bing)

Type of data

SAS data only

MDX data only

MDX data only

Media > Advertisers > [Advertiser_Name] > Tag Management > Tag Managers

Important

Important: To activate this feature, please contact your customer success manager

Note

Note: This feature is protected by the following permission:

Tag Manager - Allow server to server calls

Overview

There are times when a Sizmek client wants to track conversions or be able to re-target users, but it is impossible to use the Tag Manager JavaScript (JS) code for these tasks.

For example, it is not possible to use the Tag Manager JS code in a mobile app, but a client would like to track users who have seen Sizmek ads for a particular app, and then installed the app. In cases like these, we can establish a process by which a server implements code to call the Sizmek server directly, similar to an API call. In this example, the server that calls Sizmek Tag Manager is a server that belongs to an app attribution vendor like AppsFlyer or Tune.

Define and Use the Tag Manager for Server to Server

Procedure

Create a tag manager.

In the Developer's tab, verify that the check box for server to server calls is enabled.

Verify that the server that calls the Sizmek server does not send a User-Agent in the request header.

If the server sends a User-Agent and is listed in the IAB whitelist, Sizmek will process the call.

If the server sends a User-Agent and is not listed in the IAB whitelist, it is considered a bot and will be dropped.

The following is an example of the URL that is used in a server-to-server call: http://bs.serving-sys.com/Serving?cn=ot&onetagid=[tag_manager_id]&dispType=js&sync=0&pageurl=[URL_provided_by_vendor]&activityValues=$$[activity_values]$$&acp=$$[conditional_parameter]$$&ns=1&ebaddid=[advertising_device_id]&rnd=[unix time stamp]&usercookie=u2=[sizmek_user_ID_received_on_the_click_event]

The code must include either a device ID (ebadid) or user cookie (usercookie=u2=X).

For more information about device tokens, see Adding Tokens to URLs.

For more information about activity values, see <noscript> Mode.

Troubleshooting

To prevent potential problems, verify that:

User-Agent is either on the whitelist or is not sent at all.

IP address of the sending server is not on the blacklist. Contact Sizmek Support to confirm the IP address.

Overview

Tag Manager enables you to use a retargeting activity in an exposed to/not exposed logic when you want to target users:

That visited an advertiser's website.

That viewed a specific product.

However, there may be instances when an agency wants to target users that were exposed to/not exposed to a specific ad.

For example, to check when one ad is serving better than another ad, A/B testing can be run. In this scenario, every user that sees ad A will always see ad A, and every user that sees ad B will always see ad B. Then, the agency can analyze which ad performed better.

As a workaround, Sizmek Ad Suite allows you to set a retargeting activity as a 3rd party event on the master ad, and then create a target audience based on this retargeting activity.

How Does It Work?

The basic steps to implement this workaround include the following:

Create a retargeting activity. For more information, see Work with Retargeting Activities.

On the master ad, add an impression tracking event using one of the following scripts:

Retargeting tag script

Tag manager script

Create a target audience based on your retargeting activity.

Add a Retargeting Activity as a 3rd Party Event Using Retargeting Script

Procedure

Important

Important: Before you start, make sure that a retargeting activity exists.

Click Creative > Ads, and select the master ad to which you want to add the retargeting activity as a 3rd party event.

In the Click-through & Events section, click Events.

Add an impression tracking event, and in the URL box paste the following script:

http://bs.serving-sys.com/serving?cn=dt&tid=[\%retargeting_activity_ID\%]&ns=1

target audience

Note

Note: If you want to set up a retargeting value using the retargeting activity, you should implement the following script:

http://bs.serving-sys.com/serving?cn=dt&tid=[\%retargeting_activity_ID\%]&TVAL=[\%retargeting_activity_value\%]&ns=1

Replace [\%retargeting_activity_ID\%] with the retargeting activity ID. For example, http://bs.serving-sys.com/serving?cn=dt&tid=1083741908&ns=1.

Click Save.

Create a target audience based on your retargeting activity.

Add a Retargeting Activity as a 3rd Party Ad Event Using Tag Manager Script

Procedure

Important

Important: Before you start, make sure that a retargeting activity exists.

Click Creative > Ads, and select the master ad to which you want to add the retargeting activity as a 3rd party event.

In the Click-through & Events section, click Events.

Add an impression tracking event, and in the URL box paste the following no script code from your tag manager:

https://bs.serving-sys-int.com/Serving?cn=ot&onetagid= [\%Tag_manager_ID\%] &ns=1&activityValues=$$Session=[Session]$$&dynamicRetargetingValues=$$$$&acp=$$some_param=valueA$$

Replace the following values:

[\%Tag_manager_ID\%] with your tag manager ID.

some_param=[\%some_param_value\%] with the conditional variable name and the value you want to pass.

Click Media > Tag Managers, and select your tag manager.

Click Activity Rules.

Click New ActivityRule and do the following actions:

In the IF section, add a variable that is based on a variable criterion for the some_param variable.

In the THEN section, select the retargeting activity that you created.

Create a based on your retargeting activity.

Note

Note: Access to this article does not require a login on Sizmek Ad Suite.

The article can be shared with webmasters and other users who do not have a login for Sizmek Ad Suite.

Configure and Implement Tag Manager with DTM

Tag Manager can be integrated with Adobe DTM.

Procedure

The Sizmek customer success manager configures the Tag Manager in Sizmek Ad Suite.

The Sizmek customer success manager takes the the following code and replaces 123456789 with the relevant Tag Manager ID.

(function(e, s, t) {

t = t || {}, t.id = e, versaTagObj = {

$: [],

onready: function(e) {

this.$.push(e)

}

};

var n = s.getElementsByTagName('body')[0],

ebprotocol = window.location.protocol=="https:"?"https://secure-":"http://",

r = s.createElement("script");

r.options = t, r.async = !0, r.src = ebprotocol + "ds.serving-sys.com/SemiCachedScripts/ebOneTag.js?id=" + e, r.options = t, n.appendChild(r, n)

})("123456789", document, {

dataLayer: "SizmekDataLayer"

});

The Sizmek customer success manager sends the edited tag manager code to the DTM administrator.

In DTM, the administrator opens the account, and selects Open Rules > Page Load rules > Create New Rule.

Enter a name for the rule.

If Tag Manager requires activity parameters, use the metadata setting to map these parameters.

Under Conditions, set the Tag Manager rule to trigger at Bottom of Page.

Leave Rule Conditions empty so Tag Manager always fires without a condition.

In the Javascript/Third Party Tags section, select Non-sequential.

Click Add new script and perform the following actions:

Name the tag Sizmek_SAS_Tag_Manager.

Select Type > Non-sequential Javascript.

Paste the code from step 2, and click Save.

If your DTM has any approvals, make sure the rule is fully approved, set to active, and published to live status.

Make sure that the rule that fires Tag Manager is not included in any DTM rule groups that are scheduled for only specific times/dates.

Fire Tag Manager on Clicks and Buttons within DTM

In DTM, the administrator creates a new event based rule.

Procedure

Open Rules > Event Based Rules > Create New Rule.

Name the new rule.

Under Conditions, do the following actions:

In the Event section, for Event Type, select click.

In the Tag section, for Element Tag or Selector, set the relevant CSS selector for the target element.

Leave Rule Conditions empty to that the rule always fires without a condition.

In the Javascript/Third Party Tags section, select Non-sequential .

Click Add new script and enter a name for the tag.

Select Type > Non-sequential Javascript.

Paste the following code below and replace DummyURL with any string that references the element being clicked.

versaTagObj.onready(function(){

versaTagObj.generateRequest("http://www.DummyURL.com");

});

Note

Note: Make sure that you communicate the selected string to the Sizmek team, so that they can set up the Tag Manager rule that fires the relevant conversion tag when the element is clicked.

Click Save Code.

If your DTM has any approvals, make sure the rule is fully approved, set to active, and published to live status.

Make sure Tag Manager is not included in any DTM rule groups that are scheduled for only specific times/dates.

Note

Note: Access to this article does not require a login on Sizmek Ad Suite.

The article can be shared with webmasters and other users who do not have a login for Sizmek Ad Suite.

Overview

This page explains how to use the Tag Manager API to trigger Tag Manager calls from within a web page, and how to populate parameters programmatically.

This is useful for cases in which the webmaster (or similar user) wants more control over when and how the tag manager collects the data.

Tag Manager can easily handle these types of situations:

You have sections of your website that generate new pages or dialogs without explicitly changing URLs.

You want Tag Manager to recognize these virtual pages so that you can build activity rules around them.

Important

Important:

The Tag Manager API overrides Tag Manager UI settings.

The Tag Manager API is not supported on pages with multiple Sizmek Tag Managers.

Getting Started

Tag Manager Code Structure

Note

Note: It is a best practice to insert Tag Manager code in the <body> of the webpage, after the optional dataLayer code.

<script type="text/javascript">

(function(e, d, o) {

var c, t, n, a, i;

o = o || {}, o.id = e, t = d.getElementsByTagName("script")[0], n = d.createElement("script"), a = [], i = encodeURIComponent;

for (c in o) o.hasOwnProperty(c) && a.push(i(c) + "=" + i(o[c]));

n.async = !0, n.src = (o.ptcl || "https") + "://secure-ds.serving-sys-int.com/SemiCachedScripts/ebOneTag.js", "s" !== n.src.charAt(4) && (n.src = n.src.replace("secure-", "")), n.src += "?" + a.join("&"), t.parentNode.insertBefore(n, t)

})("1073742147", document, {

ptcl: "http",

dataLayer: "versatagObj",

dispType: "iFrame",

});

</script>

Options Object

Name

Limitation

Description

Notes

ptcl

Optional

Overrides the protocol with which the tag manager will generate the call to the Sizmek server that was defined in Sizmek Ad Suite.

Possible Values:

https

http

dataLayer

Optional

Overrides the data layer name that was defined in Sizmek Ad Suite.

Possible Values:

Any valid JavaScript variable name.

dispType

Optional

Overrides the Return Server Response as that was defined in Sizmek Ad Suite, which determines how the server returns its response.

Possible Values:

iFrame

js

Overriding Existing Configuration

Whenever the tag manager is published, a configuration file with all the tag manager configuration (such as dataLayer name and all of the variables in use) is created.

There are cases in which the webmaster does not want the tag manager to collect the data to send to Sizmek, but rather override what the tag manager collected and send different data.

The webmaster can override the configuration file settings (which are the settings that were defined on the platform) or set values for parameters using the following code:

<codeclass="javascript">

<scripttype="text/javascript">

(function(e, d, o){

var c, t, n, a, i;

o=o||{}, o.id=e, t=d.getElementsByTagName("script")[0], n=d.createElement("script"), a=[], i=encodeURIComponent;

for(c in o) o.hasOwnProperty(c)&&a.push(i(c)+"="+i(o[c]));

n.async=!0, n.src=(o.ptcl||"https")+"://secure-ds.serving-sys-int.com/SemiCachedScripts/ebOneTag.js", "s"!==n.src.charAt(4)&&(n.src=n.src.replace("secure-", "")), n.src+="?"+a.join("&"), t.parentNode.insertBefore(n, t)

})("1073742147", document, {

ptcl: "http",

dataLayer: "versatagObj",

dispType: "iFrame",

parameters: {

conversion: [{

param1: {

value: "1234",

type: "CONST"

}

}],

retargeting: [{

123456789: {

value: "blue",

type: "CONST"

}

}],

conditional: [{

condParam: {

value: "abcd",

type: "CONST"

}

}]

}

});

</script>

Parameters

Name

Limitation

Description

Notes

conversion

Optional

Array of activity parameters that will override values retrieved from the page that are meant to be used in conversion activities (triggered by the tag manager).

Structure for each activity parameter is

\%activity_param_name\%: {

value: "\%activity_param_value\%",

type: "CONST"

}

retargeting

Optional

Array of retargeting activity values that will override values retrieved from the page that are meant to be used in retargeting activities (triggered by the tag manager).

Structure for each retargeting activity value is

\%retargeting_activity_id\%: {

value: "\%retargeting_activity_value\%",

type: "CONST"

}

conditional

Optional

Array of conditional parameters that will override values retrieved from the page that are meant to be used in an activity rule (evaluated by the tag manager).

Structure for each conditional parameter is

\%conditional_parameter_name\%: {

value: "\%conditional_parameter_value\%",

type: "CONST"

}

API Methods

To use the Tag Manager JavaScript (JS) methods, it is recommended that the webmaster include the onready code below the Tag Manager code. For example:

<script type="text/javascript">

(function(e, d, o) {

var c, t, n, a, i;

o = o || {}, o.id = e, t = d.getElementsByTagName("script")[0], n = d.createElement("script"), a = [], i = encodeURIComponent;

for (c in o) o.hasOwnProperty(c) && a.push(i(c) + "=" + i(o[c]));

n.async = !0, n.src = (o.ptcl || "https") + "://secure-ds.serving-sys-int.com/SemiCachedScripts/ebOneTag.js", "s" !== n.src.charAt(4) && (n.src = n.src.replace("secure-", "")), n.src += "?" + a.join("&"), t.parentNode.insertBefore(n, t)

})("1073742147", document, {

ptcl: "http",

dataLayer: "versatagObj",

dispType: "iFrame",

});

versaTagObj.onready(function() {

// VersaTagObj is ready for API use - this part will override the config file

versaTagObj.setActivityParam("key", "value");

versaTagObj.setConditionalParam("key", "value");

versaTagObj.setDynamicRetargetParam("key", "value");

// Request is fired once generateRequest is called

versaTagObj.generateRequest();

});

</script>

onready

Description

The onready method allows the webmaster to safely trigger any of the Tag Manager JS calls, while assuring that the versatagObj exists. The onready funciton is triggered once the versatagObj is created.

generateRequest

Description

The generateRequest method allows the webmaster to trigger a call to Sizmek servers.

The webmaster can use this method to trigger a call when an event happened on the page (for example, an end-user entered text to an input), or to pass a different URL, which is very useful for single page websites where the page content changes but the page URL does not change.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

versaTagObj.generateRequest(“fakeURL”);

});

</script>

Request Parameters

Name

Limitation

Description

Notes

URL

Optional

Allows to pass a URL that will be evaluated by the Sizmek tag manager logic engine.

The someVirtualUrl must include http or https depending on the protocol of the page.

The call should be called only after the versatagObj exists.

To make sure it exists, it is recommended to generate the call within the onready function.

getActivityParam

Description

The getActivityParam method allows the webmaster to get a specific conversion activity parameter's value.

If there is no value for the conversion activity paramater, the function returns null.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var orderID = versaTagObj.getActivityParam("OrderID"); console.log("this is the orderID: " + orderID);

});

</script>

Request Parameters

Name

Limitation

Description

Parameter Name

Mandatory

Conversion activity parameter name from which to pull the data.

setActivityParam

Description

The setActivityParam method allows the webmaster to define a conversion activity value to a parameter, overriding the value set by the tag manager code.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var userAge = $('#age-input').val();

versaTagObj.setActivityParam("age", userAge);

versaTagObj.generateRequest();

});

</script>

Request Parameters

Name

Limitation

Description

Parameter name

Mandatory

Conversion activity parameter name into which data is populated.

Parameter value

Mandatory

Value to populate into the parameter.

clearActivityParam

Description

The clearActivityParam method allows the webmaster to clear all conversion activity parameters.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

versaTagObj.clearActivityParam();

versaTagObj.setActivityParam("productinfo", "the tracking band concert 09/25/2018");

versaTagObj.generateRequest();

});

</script>

getDynamicRetargetParam

Description

The getDynamicRetargetParam method allows the webmaster to get the retargeting activity value for any retargeting activity ID.

If there is no value for the retargeting activity ID, the function returns null.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var genre = versaTagObj.getDynamicRetargetParam("30541");

console.log("this is the retargeting value according to genre: " + genre);

});

</script>

Request Parameters

Name

Limitation

Description

Retargeting Activity ID

Mandatory

ID of the retargeting activity that holds the data.

setDynamicRetargetParam

Description

The setDynamicRetargetParam method allows the webmaster to define a value to a retargeting activity, overriding the previous value.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var concert_dates = $('#date-input').val()

versaTagObj.setDynamicRetargetParam("15778", concert_dates);

versaTagObj.generateRequest();

});

</script>

Request Parameters

Name

Limitation

Description

Retargeting Activity ID

Mandatory

ID of the retargeting activity into which to set the value.

Retargeting Value

Mandatory

Value to populate into the retargeting activity.

clearDynamicRetargetParam

Description

The clearDynamicRetargetParam method allows the webmaster to clear all retargeting activity values.

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

versaTagObj.clearDynamicRetargetParam();

versaTagObj.setDynamicRetargetParam("15778", "05/14/2018");

versaTagObj.generateRequest();

});

</script>

getConditionalParam

Description

The getConditionalParam method allows the webmaster to retrieve a parameter that is part of an activity rule criteria.

Example

If this is the criteria:

then using getConditionalParam will allow the user get the value on the zipcode variable as seen below.

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var zipcodeVar = versaTagObj.getConditionalParam("zipcode");

console.log("this is the value according of the zipcode variable: " + zipcodeVar);

});

</script>

Request Parameters

Name

Limitation

Description

Conditional Parameter Name (name of variable in the Sizmek platform)

Mandatory

Name of the variable in the platform for which the webmaster wants to pull data.

For example:

setConditionalParam

Description

The setConditionalParam method allows the webmaster to set a value to a conditional parameter manually, overriding the previous value (usually set by the tag manager code).

Example

<script type=”text/JavaScript”>

versaTagObj.onready(function(){

var userZipcode= $('#zipc').val()

versaTagObj.setConditionalParam("zipcode", userZipcode);

versaTagObj.generateRequest();

});

</script>

Request Parameters

Name

Limitation

Description

Conditional Parameter Name (name of variable in the Sizmek platform)

Mandatory

Name of the variable in the platform about which the webmaster wants to pull data.

For example:

Conditional Parameter Value

Mandatory

Value to populate into the conditional parameter.

clearConditionalParam

Description

The clearConditionalParam method allows the webmaster to clear allconditional parameter values.

Overview

The Tag Manager feature includes a Chrome browser extension that a user (client services manager, trafficker, or an agency/advertiser analytics expert) can use to analyze retargeting cookies that exist on the browser and understand the current navigation journey.

To install the Chrome extension, see Installing the Chrome Extension.

Note

Note: This extension works in the Chrome browser only.

How Does It Work?

If there are retargeting cookies set on the browser, this tool displays data about the retargeting cookies, such as advertiser ID and name, retargeting activity ID and name, and value.

Procedure

Important

Important: Before you begin, confirm that the pages that set the retargeting activities are either running without the Chrome extension, or while the Chrome extension Data Collection mode is set to Partial. For more information, see Test Sizmek Advertiser Tags on a Web Page.

Note

Note: This tool only works for Sizmek Ad Suite Retargeting cookies.

Navigate to a web page.

Click the Chrome extension icon and select Retargeting Cookie Analyzer.

Log into Sizmek Ad Suite.

The following pane appears and displays the cookies for the user's browser navigation history.

Overview

The Tag Manager feature includes a Chrome browser extension that a user (customer success manager, trafficker, or an agency/advertiser analytics expert) can use to analyze a web page for variables.

To install the Chrome extension, see Installing the Chrome Extension.

Note

Note: This extension works in the Chrome browser only.

Important

Important: Rules that are triggered in an iFrame window, and relevant to the iFrame window, will be recognized by the Tag Tester tool; however, the Tag Tester tool will not be able to detect rules in the main window when fired from Tag Managers within iFrames.

How Does It Work?

If there is a tag manager on the web page, the extension can scan the page and add variables to the advertiser for which the tag manager is defined.

Procedure

Navigate to a web page.

Click the Chrome extension icon and select Test Sizmek advertiser tags on the webpage.

The Sizmek Chrome extension shows Sizmek activities on this page.

Note

Note: There are three modes for the collection tool. You can click the Data Collection option to change the mode:

None: While the Chrome extension is on, no data (conversion or retargeting) is being collected or set to analytics, and no 3rd party activities are being triggered.

Partial: Conversion and retargeting data is being collected; conversion data is sent to analytics and retargeting is collected for future targeting. No 3rd party activities are being triggered.

Full: Conversion and retargeting data is being collected; conversion data is sent to analytics and retargeting is collected for future targeting. 3rd party activities are being triggered.

You can use each tab to see which activity was triggered. Each entry in the grid is a link that refers to the entity on Sizmek Ad Suite.

The test tool keeps collecting the triggered activities even if you navigate to a different page that has a tag manager on it (or even if you refresh the page).

If you want to start a fresh session without the activities that were collected so far, you should open the same page on a new browser tab.

Click a link in the Name column to open the entity in Sizmek Ad Suite.

The Time Line tab shows the activities that were triggered and the time details for each trigger event.

Click to collapse this tool.

Overview

The Tag Manager feature includes a Chrome browser extension that a user (Customer Service Manager, trafficker, or an agency/advertiser analytics expert) can use to analyze a web page for variables. This extension can identify the tag manager's advertiser and create variables for that advertiser. It can also recognize data layer variables according to the data layer defined in Sizmek Ad Suite.

To install the Chrome extension, see Installing the Chrome Extension.

Note

Note: This extension works in the Chrome browser only.

How Does It Work?

If there is a tag manager on the web page, the extension can scan the page and add variables to the advertiser for which the tag manager is defined.

If there is no tag manager on the web page, the extension will create variables under an advertiser that is specified by the user (according to the advertisers to which the user has access). The extension scan tool tries to obtain variables from one of the following data layers:

dataLayer (Google data layer)

utag_data (Tealium data layer)

universal_variable (Ensighten data layer)

tm_param (Tagman data layer)

If there is more than one data layer on a page, the user must select one.

In addition to data layer variables and global JavaScript (JS) variables, the extension scans for query string variables.

Procedure

Navigate to a web page.

Click the Chrome extension icon and select Analyze the webpage for variables.

If there are no data layer variables from any of the aforementioned data layers, the Chrome extension prompts the user to supply the data layer name and will try to analyze the page with the given data layer name.

If there is no data layer, the extension will only scan for global JavaScript variables and query string parameters.

Select the variables to add to the tag manager or advertiser and click Create on Sizmek Ad Suite.

The selected variables are added in one of the following ways:

To the advertiser that was specified by the user

To the tag manager’s advertiser, if there is a tag manager on the page

The selected variables are added to the advertiser that was specified by the user (or to the tag manager's advertiser, if there is a tag manager on the page).

Note

Note: The Exists on Server column includes variables that already exist in Sizmek Ad Suite for the tag manager.

The Tag Management feature includes a Chrome browser extension that you can use to test a tag manager. Follow these steps to install and use the Chrome extension.

Note

Note: This extension works in the Chrome browser only. The extension does not work with the Sizmek MDX VersaTag tester. We recommend that you disable the Sizmek MDX VersaTag tester when using the Test Tag Manager feature in Chrome.

Installing the Chrome Extension

Procedure

Click here to install the Sizmek Tags Tester from the Chrome Web Store.

Note the new icon that appears in the address bar:

Retargeting Cookie Analyzer

Using the Chrome Extension

Note

Note: Users who are not logged into Sizmek Ad Suite can still see results for the Chrome extension; however, certain values are visible (such as Parameters and 3rd Party Tags) and others are blocked (such as Name and Counting Method).

To see the blocked values, you can use the link to log into Sizmek Ad Suite.

Click the icon to reveal the menu. Options include:

Analyze the webpage for variables

Test Sizmek advertiser tags on the webpage

Media > Advertisers > [Advertiser Name] > Tag Management > Tag Manager > Activity Rules

Important

Important: This feature entails additional costs. For more information, please contact your customer success manager.

Note

Note: This feature is protected by the following permission:

Create/Edit Site Activity

Overview

Advertisers use site activities to measure user actions that are not ad-related (clicks/impressions) or conversions. The following examples represent common site activity use cases.

Natural Search:

A user views a Sizmek-served ad for Concertified.com (a concert ticket website).

Two days later, the user searches (in a search engine) for a rock concert near Amsterdam and one of the results is a concert sold by Concertified.com.

The user clicks the Concertified.com natural search result (not a paid search ad) and lands on Concertified.com where there is a tag manager that triggers a conversion activity.

As a result, if a natural search site activity rule is enabled for Concertified.com in the tag manager, Concertified.com can generate a path to conversion or raw data feed that includes the ad served, a site activity named Search, and the conversion.

Supported search engines include:

Custom:

A user views a Sizmek-served ad for Concertified.com for The Tracking Band concert, clicks the ad, and is redirected to Concertified.com.

On Concertified.com, the end-user sees a recommendation for another concert, clicks it, and buys concert tickets.

As a result, if a rule exists that triggers a custom site activity when the user clicks the recommendation, and a conversion is triggered when the user purchases tickets, Concertified.com can generate a path to conversion or raw data feed that includes the ad served, a custom site activity with a name defined in Sizmek Ad Suite, and the conversion.

Note

Note: Site visits are included as events in the path to conversion, but cannot be the winner event.

In addition to natural search and custom site tracking, site activity also includes social tracking.

If a user was referred from one of the supported social networks (without a paid click-tracker) and landed on a page with a tag manager that has social site activity enabled, the event data in the path will be classified as a social event and be associated with the corresponding social network.

Click trackers for social ads are used to classify clicks from social ads as paid media; therefore, traffic that originates from an ad on a social network will not collect social site activity data.

Supported social networks include:

For more information, see Path to Conversion Report Fields and Site Activity Fields.

Site Activity Rules

When you create a tag manager, Sizmek Ad Suite creates three site activity rules, which are disabled by default:

Social Referral Rule: The referral URL belongs to one of the social networks.

Search Referral Rule: The referral URL belongs to one of the search engines.

Other Referral Rule: The referral URL is not from any of the search engines or social networks.

Note

Note: In the case of a global advertiser with local advertisers, three rules are created for each advertiser.

For example, if a tag manager has a global advertiser and two local advertisers, there will be nine site activity rules created by default.

Note

Note: Access to this article does not require a login on Sizmek Ad Suite.

The article can be shared with webmasters and other users who do not have a login for Sizmek Ad Suite.

The following article details the Tag Manager integration with Google Tag Manager (GTM).

Sizmek is currently testing Tag Manager with other tag management systems and will release those integration instructions when testing is complete.

Google Tag Manager (GTM)

Configure and Implement Tag Manager with GTM

Tag Manager can be integrated with GTM.

Procedure

Sizmek customer success manager configures and generates the Tag Manager code in Sizmek Ad Suite.

Sizmek customer success manager sends the Tag Manager code to the GTM administrator.

In the GTM, the administrator opens the account and creates a new tag.

The administrator names the tag Tag Manager and selects Custom HTML for the tag type.

The administrator pastes the Tag Manager code, provided by Sizmek, into the HTML box.

The administrator selects the Support document.write check box.

The administrator selects the default All Pages trigger in the Triggering section.

Advanced Scenarios

You can pass variables to Tag Manager to use for sales conversion activities and dynamic retargeting activities.

Procedure

Administrator creates a new User-Defined Variable for each parameter to be collected.

Give the variable a name.

Select a variable type (either Data Layer Variable, JavaScript Variable or URL Query String Param) and set the Data Layer or global variable name.

Reference this user-defined variable by name in the appropriate parameter portion of the Tag Manager code using the following syntax:

"parameterName":"{{variableName}}"

Follow the steps under Configure and Implement Tag Manager with GTM.

Fire Tag Manager onClicks and Buttons within GTM

Procedure

In GTM, the administrator creates a User-Defined Variable.

Give the variable a name.

Select the Auto-Event Variable as the variable type.

Select Element ID from the Variable Type list, and click SAVE.

In GTM, administrator creates a new tag.

Name the Tag TM_generateRequest and choose Custom HTML as tag type.

Paste the following into the HTML box:

<script> versaTagObj.onready(function() { versaTagObj.generateRequest("http://www.{{Page Hostname}}/{{VariableName}}"); }); </script>

Note

Notes:

GTM automatically replaces {{Page Hostname}} with the site’s domain (and subdomain, if applicable).

The reference {{VariableName}} is used to illustrate the example. The actual value within the brackets {{}} should be replaced by the name given to the variable in step 1. For example, If the variable was named SubmitButtonClick, then the reference to it in the generateRequest method would be:versaTagObj.generateRequest("http://www.{{Page Hostname}}/{{SubmitButtonClick}}");.

Under Advanced Settings > Tag Sequencing do the following actions:

Select Fire a tag before TM_generateRequest fires and select Tag Manager as the setup tag.

Select Don’t fire TM_generateRequest() if Tag Manager fails.

This will ensure that TM_generateRequest() only fires after Tag Manager has successfully fired.

Add a trigger to initiate the firing of the TM_generateRequest tag, commonly on user clicks:

Add a new trigger using All Elements type.

Select Some Clicks.

Define firing conditions based on the elementID (taken from the Page source/HTML tag properties) that is stored by the variable created in step 1.

Select Save.

Overview

This article explains, for Sizmek Ad Suite, how Sizmek counts Impressions, Ad Starts, Clicks, and Ad Requests to determine reasons for possible discrepancies.

Impression Counting

Impression counting is client-side. When an ad request arrives at the server, the server logs the request.

Sizmek Ad Suite counts impressions when a single asset finishes loading and starts rendering.

3rd Party impression tags are fired immediately after Sizmek sends the impression to be loaded.

Note

Note: Since there is no code, tracking pixels impressions are counted as soon as the call reaches the server.

Ad Start

Ad Start occurs when the ad is loaded into the end-user environment, for example, into the browser or mobile app. Sizmek reports the Ad Start only if the ad is fully loaded and only when Verification and Viewability are enabled.

The system uses different methods for Image, HTML5, and Flash to detect the exact timing for loading the actual content:

Image: Sizmek triggers the Ad Start event when the image is fully loaded.

HTML5: Sizmek triggers the Ad Start event when the main iFrame is fully loaded.

Flash: If the browser permits, Sizmek reports Ad Start when the second frame is played; otherwise it reports Ad Start as soon as the flash is played.

Click

Sizmek Ad Suite only counts the first click, for any single ad session, as a click; any additional clicks are considered interactions. Sizmek Ad Suite is IAB click certified and uses click data for analytics purposes.

Note

Note: The first click is also counted as an interaction.

Ad Request

Note

Note: Ad Request is only supported in Sizmek Ad Suite.

IAB defined a standard, for impressions, in which served impressions are counted only when the ad is loaded into the browser. This standard led to discrepancies between the serving platforms and the publishers impressions because the publishers count a higher number of impressions than the serving platforms.

To align these two counters, Sizmek has introduced a metric that counts the requested impressions (and not only the served impressions).

If this information is required for MDX2.0 (for publisher certification), it can be extracted by client services.

MDX: Manage > Ads > New > Design New HTML5 Ad

Sizmek Ad Suite: Creative > Ads > New Ad > Design HTML5 Ads

Overview

Events occur when a user engages with the ad. It can occur following automatic ad upload or upon user interaction with the ad, for example: a mouse in, tap or click. When an event runs, you can assign actions to follow thereby increasing consumer engagement with the ad. These actions can include expanding panels, routing click-throughs to predefined pages, and adding a set of cool animations. The dynamic timeline in Ad Builder enables you to view, move, and organize the actions and animations to gain the Sizmek effect.

The Actions and Animations pane is accessible from the taskbar. You can easily hide, detach, move, and drag the pane to any location on the canvas.

Note

Note: The default action duration scale is set to five seconds. You can change the scale by clicking '+' on the scale located at the bottom of the 'Actions and Animations' pane.

Assigning Events

The following table describes the supported events.

Event

Description

On Load

This is a touch gesture.

Tap/Click

Opens, selects, or activates whatever you tap. Same as clicking with a mouse.

Double Click

An event is triggered when the user performs a mouse double-click on the component.

Mouse In

An event is triggered when the user moves the mouse towards the component.

Mouse Out

An event is triggered when the moves the mouse away from the component.

Mouse Down

An event is triggered when the user depresses the mouse button on this component.

Mouse Up

An event is triggered when the user releases the mouse button from this component.

Custom Sequence

You can copy a sequence of actions and animations from one component to another by setting the target object as Self. For more information, see Custom Sequence.

Mobile-Related Events

Shake

An event is triggered when the user shakes the mobile phone.

Swipe Up

This is a touch navigation gesture that applies to mobile phones and IPADs.

Swipe Right

This is a touch navigation gesture that applies to mobile phones and IPADs.

Swipe Down

This is a touch navigation gesture that applies to mobile phones and IPADs.

Swipe Left

This is a touch Navigation gesture that applies to mobile phones and IPADs.

Video-Related Events

On Video Play

An event is triggered while a video is running. An event that is triggered only once when the video is first played (either manually by the user, by another event, or via autoplay).

On Video End

An event is triggered when the component has ended running.

On Video Pause

An event is triggered if the user pauses the component.

On Error

An event is triggered if the video fails to play due to an error.

On Cue Point (0.0 sec)

This event enables you to assign actions and animations to execute at specific cue points within a video. This event allows creative users to author animations, which are connected to what is happening in the video, without writing code.

For more information, see Create Time Sync Ads with Video Cue Points.

Expandable Ads

On Visible

Applicable to Banners and Panels.

This event is triggered when 50\% of the banner or the panel area becomes visible to the user, for 0 milliseconds (instantly), in case the banner was less visible previously. For more information, see Triggering Events based on Panel and Banner Visibility.

On Not Visible

Applicable to Banners and Panels.

This event fires when 50\% of the banner's area becomes invisible to the user, for 0 milliseconds (instantly), in the case the banner was more visible previously. For more information, see Triggering Events based on Panel and Banner Visibility.

In-Stream Ads

On Skip Enabled

When the Allow Skip After X Seconds field is selected, the Skip Enabled event fires after x seconds after the ad starts. The timing of this start is when the video starts playing and not when the ad is loaded. This event acts like any other trigger in Ad Builder, (for example, Click, Mouse In, Video Play, and more), and is found in the Master Banner’s event list.

On Close Enabled

This event enables you to provide ways for the user to close the ad manually. If the Disable Auto Close action was used anywhere in the ad, then instead of closing the ad when it is completed the On Close Enabled event will trigger. For more information, see Work with HTML5 In-Stream Interactive Ads.

Note

Note: You cannot assign events or actions to the HTML, Pinterest, and Twitter Feed components.

Triggering Actions and Animations from Events

Procedure

Select a component from the Components list.

The component's properties are displayed in the right pane. This could be a textbox, an image or other components. If you would like to define actions that take place upon ad load, select the banner itself.

Click the Actions and Animations drop-down arrow to expand this section.

Click Create New Event and select an event from the drop-down list. These events apply to ads running on PCs and mobiles although the terminology may differ such as Tap your mobile ad as apposed to clicking an ad on your PC.

Click Add Action.

The New Actiontimeline slot opens, highlighted in blue, and the Action:Select drop-down list is displayed below.

Select the action type from the arrow drop-down list.

As displayed in the following example, when the user clicks the 'text1' ad component, the 'Goto URL' action routes the user to the defined URL.

By default, the first action is set to On Trigger.

[Optional] When adding multiple actions, you can decide whether to run an action after a previously defined action or parallel to it. This feature allows you to accurately and easily schedule multiple actions on the timeline.

In addition you can drag and stretch/shrink the duration of the actions within the timeline.

The following example displays two actions associated with the "Tap\Click" event.

Click Play to simulate the actions in the timeline.

Assign Multiple Actions to an Event

You can assign multiple actions to an event. Multiple actions added to a single event run one after another.When one action finishes, the following action starts. This is default behavior, however you can change the actions to run in parallel with the previous action.

Assign a JavaScript to an Action

From the Actions drop-down list, select Custom Actions > Run JavaScript.

Scroll down and click Open Code Editor.

An internal code editor opens.

Define your JavaScript object and click Apply.

Verify that your code is running correctly on the ad.

Assign Mobile Actions to Events

Ad Builder allows you to easily add dedicated mobile actions to your ads.

From the Actions drop-down list, select Mobile Actions > Call Number\SMS Number\Email.

Proceed to configure the following mobile-related actions:

Action

Description

Comments

Call Number

Triggers a 'call' action to a phone number.

When a "Call Number" action occurs, it launches the phone's default dialer and enters the number to be called. It does not call the number automatically. It is configured using the international phone number format.

SMS Number

Triggers a 'send SMS' action to a mobile number.

When a "Send SMS" action occurs, it launches the phone's default SMS client, enters the recipient's number and the body text. It does not send the message automatically. The user has to click "send".

Email

Triggers a 'send email 'action

When a "Send email" action occurs, it launches the phone's default email client, enters the recipient's and cc'd email addresses, email subject and the body text. It does not send the message automatically. The user has to click "send"

Assign an Animation Action to an Event

From the Action drop-down list, select Animation> Play; Stop; Pause; Replay; Mute; Unmute.

From the Target: Select drop-down list, select an animation to run.

Configure the following fields:

Field

Description

Start x

End x

Indicates the position where the component should start before activation.

Allows you to drag the animation to the target destination on the ad.

Duration

Indicates the duration of the animation in milliseconds.

Loop

Indicates the number of times to run the animation.

Repeat Times: Runs the animation the number of time indicated by the user.

Repeat Forever: Runs the animation in a loop.

Ease

Easing indicates the nature of the motion applied to your animation and makes your animations feel more natural.

None: No motion is applied.

Ease In: Applies motion to the animation that starts slowly and accelerates.

Ease Out: Applies motion to the animation that starts quickly and decelerates.

Ease in and Out: Applies a combination of the Ease In and Ease Out.

Ease Power

Ease Power is enabled when the an Ease type is selected in the Ease field. It indicates the intensity of the motion. The higher the Ease Power value, the greater the acceleration and deceleration of the Ease motion.

The following values are supported:

1,2,3,4

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example

"relationsBag": {

"parents": {

"account": {

"id": 16674,

"name": "[TEST] migrated account",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

Parents Object

Related Entities

Endpoints Using the Parents Object

Advertiser Resource

Campaign Resource

Placement Resource

Parents 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

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1072241834,

"name": "testing account",

"internal": false

}

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741822,

"name": "AAA"

}

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741833,

"name": "BBB"

}

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741831,

"name": "ccc"

}

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741853,

"name": "ddd"

}

Object JSON Example

Example

"parents": {

"account": {

"id": 1072241834,

"name": "testing account",

"internal": false

},

"advertiser": {

"id": 1073741822,

"name": "AAA"

},

"brand": {

"id": 1073741833,

"name": "BBB"

},

"campaign": null,

"site": null

},

Children Object

Related Entities

Endpoints Using the Children Object

Advertiser Resource

Campaign Resource

Placement Resource

Children 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

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only

Object JSON Example

Example

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the piggyBack Object

3rdPartyActivity Resource

Parent Objects

3rdPartyActivity Object

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

View deduplication values

Off

AttributedSite

AttributedSearchDisplay

firingMode

Setting that determines when to fire the activity.

String

Optional

View firingMode values

Always

Inherited

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

Example

...

"piggyBack":{

"type":"PiggyBack",

"deduplication":"AttributedSite",

"firingMode":"Inherited",

"siteName":"00X1Fkdrm0de111",

"siteId":1083782050,

"deduplicationConversionAttributionModel":{

"type":"DeduplicationConversionAttributionModel",

"fire3rdPartyTracking":"LastEventImpressionOrClick",

"impressionValidUpTo":30,

"clickValidUpTo":30

}

},

...

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

View fire3rdPartyTracking values

LastEventImpressionOrClick

ClicksOverImpressions

LastClickDisregardImpressions

LastEventfilterOutNonViewable

LastEventPreferViewableImpressionsOverNonViewable

ClickOverImpressionsFilterOutNonViewable

ClickOverImpressionsPreferViewableImpressionsOverNonViewable

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

Example

...

"deduplicationConversionAttributionModel":{

"type":"DeduplicationConversionAttributionModel",

"fire3rdPartyTracking":"LastEventImpressionOrClick",

"impressionValidUpTo":30,

"clickValidUpTo":30

}

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

This article lists the condition objects that can be used in activity rules.

Related Entities

Endpoints Using the Condition Objects

Activity Rule Resource

Condition Objects 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.

String

Required

View orCondition type values

PageUrlInnerCondition

ReferralUrlInnerCondition

VariableInnerCondition

ClickedElementInnerCondition

CurrentUserPageViewInnerCondition

UserPageViewDuringSessionInnerCondition

UserBrowsingHistoryInnerCondition

criteriaType

Entries that comprise the condition part of an activity rule.

String

Required

View criteriaType values

PageURL

ReferralURL

ClickedElement

UserPageViewDuringSession

CurrentUserPageView

UserBrowsingHistory

Variable

orConditions

orCondition Object

Object JSON Example

Example

"conditions": [{

"type": "PageUrlCondition",

"criteriaType": "PageURL",

"orConditions": [{

"type": "PageUrlInnerCondition",

"operator": "ContainsOneOfTheFollowing",

"values": [

"contains"

]

}]

},

{

"type": "PageUrlCondition",

"criteriaType": "PageURL",

"orConditions": [{

"type": "PageUrlInnerCondition",

"operator": "DoesNotContainOneOfTheFollowing",

"values": [

"notcontains"

]

}]

},

{

"type": "ReferralUrlCondition",

"criteriaType": "ReferralURL",

"orConditions": [{

"type": "ReferralUrlInnerCondition",

"operator": "EqualsOneOfTheFollowing",

"values": [

"http://www.google.com"

]

}]

},

{

"type": "ClickedElementCondition",

"criteriaType": "ClickedElement",

"orConditions": [{

"type": "ClickedElementInnerCondition",

"operator": "MatchesOneOfTheFollowingCSSselectors",

"values": [

"div"

]

}]

},

{

"type": "UserPageViewDuringSessionCondition",

"criteriaType": "UserPageViewDuringSession",

"orConditions": [{

"type": "UserPageViewDuringSessionInnerCondition",

"operator": "Equals",

"values": [

7

]

}]

},

{

"type": "CurrentUserPageViewCondition",

"criteriaType": "CurrentUserPageView",

"orConditions": [{

"type": "CurrentUserPageViewInnerCondition",

"operator": "Equals",

"values": [

6

]

}]

},

{

"type": "UserBrowsingHistoryCondition",

"criteriaType": "UserBrowsingHistory",

"orConditions": [{

"type": "UserBrowsingHistoryInnerCondition",

"operator": "IncludesAllOfTheFollowingActivities",

"values": [{

"type": "ActivityRelation",

"id": 1091028248,

"entityType": "RetargetingActivity",

"name": 1091028248

},

{

"type": "ActivityRelation",

"id": 1083759988,

"entityType": "ConversionActivity",

"name": 1083759988

}

]

}]

},

{

"type": "VariableCondition",

"criteriaType": "Variable",

"orConditions": [{

"type": "VariableInnerCondition",

"andConditions": [{

"type": "AndVariableInnerCondition",

"operator": "Equals",

"values": [

55

],

"variableId": 1073742872,

"variableName": "intVar_1",

"variableDataType": "Integer"

},

{

"type": "AndVariableInnerCondition",

"operator": "EqualsOneOfTheFollowing",

"values": [

"66"

],

"variableId": 1073742871,

"variableName": "strVar_1",

"variableDataType": "String"

}

]

},

{

"type": "VariableInnerCondition",

"andConditions": [{

"type": "AndVariableInnerCondition",

"operator": "EqualsOneOfTheFollowing",

"values": [

"123"

],

"variableId": 1083752586,

"variableName": "var1",

"variableDataType": "String"

}]

}

{

"type": "TimeSpentOnPageCondition",

"criteriaType": "TimeSpentOnPage",

"orConditions": [

{

"type": "TimeSpentOnPageInnerCondition",

"operator": "GreaterThanAndEquals",

"values": [

7

],

"timeUnit": "Milliseconds"

}

]

}

]

}

],

orConditions Object

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

String

Read-only

View orCondition type values

PageUrlInnerCondition

ReferralUrlInnerCondition

VariableInnerCondition

ClickedElementInnerCondition

CurrentUserPageViewInnerCondition

UserPageViewDuringSessionInnerCondition

UserBrowsingHistoryInnerCondition

operator

Operator used in the condition.

String

Required

View operator values

ContainsOneOfTheFollowing

DoesNotContainOneOfTheFollowing

EqualsOneOfTheFollowing

MatchesOneOfTheFollowingCSSSelectors

Equals

IncludeAllOfTheFollowingActivities

DoesNotEqualOneOfTheFollowing

values

Values for the condition.

Array of values

Required

andConditions

Conditions joined with an AND logic operator.

andConditions Object

Optional

Permitted only with URLs.

variableId

ID of the variable used in the condition.

Long

Required

variableName

Name of the variable used in the condition.

String

Required

variableDataType

Type of the variable.

String

Required

View variableDataType values

Integer

String

Object JSON Example

Example

...,

"orConditions": [{

"type": "PageUrlInnerCondition",

"values": [

"www.google.com"

],

"operator": "EqualsOneOfTheFollowing"

}],...

andConditions Object

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

String

Required

AndVariableInnerCondition

operator

Available actions according to criteria type.

String

Required

View PageURL/ReferralURL operator values

ContainsOneOfTheFollowing

DoesNotContainOneOfTheFollowing

EqualsOneOfTheFollowing

EqualsAnyValue

DoesNotEqualOneOfTheFollowng(wildcardUsageSupported)

DoesNotEqualOneOfTheFollowing

EqualsOneOfTheFollowing(WildcardUsageSupported)

View Variable operator values

ContainsOneOfTheFollowing

DoesNotContainOneOfTheFollowing

EqualsOneOfTheFollowing

EqualsAnyValue

HasNoValue

DoesNotEqualOneOfTheFollowng(wildcardUsageSupported)

DoesNotEqualOneOfTheFollowing

EqualsOneOfTheFollowing(WildcardUsageSupported)

View ClickedElement operator values

MatchesOneOfTheFollowingCSSSelectors

DoesNotMatchOneOfTheFollowingCSSSelectors

View NumberOfSessionPageViewsForCurrentUser/NumberOfTotalPageViewsForCurrentUser operator values

=

>

<

View User'sBrowsingHistory operator values

IncludesAllOfTheFollowingActivities

DoesNotIncludeAnyOfTheFollowingActivities

View TimeSpentOnPage operator values

>=

values

Values for which to assess the operator.

Array of items

Required

Criteria Type

Values

Page URL/Referral URL

URL.

Variable

Values depend on selected variable. See variableID, variableName, variableDataType.

Clicked Element

CSS selector.

Number of session page views/ Number of total page views

Integer.

User's Browsing History

IDs of retargeting and/or conversion activities.

Time spent on page

Integer and unit. Units include:

Milliseconds

Seconds

Minutes

variableId

ID of the variable.

Long

Read-only

For Variable criteria only.

variableName

Name of the variable.

String

Required

For Variable criteria only.

variableDataType

Type of the variable data.

String

Required

For Variable criteria only.

View variableDataType values

Integer

String

Object JSON Example

Example

...

"andConditions": [

{

"type": "AndVariableInnerCondition",

"operator": "Equals",

"values": [

55

],

"variableId": 1073742872,

"variableName": "intVar_1",

"variableDataType": "Integer"

},

{

"type": "AndVariableInnerCondition",

"operator": "EqualsOneOfTheFollowing",

"values": [

"66"

],

"variableId": 1073742871,

"variableName": "strVar_1",

"variableDataType": "String"

}

]

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the 3rdPartyActivity Object

3rdPartyActivity Resource

Child Objects

Condition Objects

relationsBag Object

piggyBack Object

3rdPartyActivity 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 the entity.

String

Required

ThirdPartyActivity

id

ID of the 3rd party activity.

Long

Read-only

Auto-generated, read-only value

name

Name of the entity.

String

Required

activityType

Type of 3rd party activity.

String

Required

View activityType values

ThirdPartyConversionTracking

ThirdParty

advertiserId

ID of the advertiser.

Integer

Required

Read-only parameter, auto-generated.

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdBy

ID of the user who created the entity.

Long

Read-only

createdByName

Name of the user who created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (date epoch).

Long

Read-only

lastUpdatedBy

ID of the user who was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user who was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to updated the entity.

Long

Read-only

lastUpdateByAccountName

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of the last update (date epoch).

Long

Read-only

rulesCount

Number of activity rules.

Integer

Read-only

tagManagersCount

Number of tag managers that use this 3rd party activity.

Integer

Read-only

conversionsCount

Number of conversions that use this 3rd party activity.

Integer

Read-only

tagManagerIds

Array of IDs for tag managers that use this 3rd party activity.

Array of integer

Read-only

accessLevel

Internal.

Internal

Internal

nxtTagManagement

Flag that indicates whether the activity was migrated from MDX2.

Boolean

Read-only

code

3rd party URL or code. You can add tokens or variables as required.

String

Required

noScriptMode

Enables runnng 3rd party activities when JavaScript cannot run on the web page.

Boolean

Optional

piggyBack

Use this object to attach a 3rd party activity to a conversion activity.

piggyBack Object

Required

conditions

Events that, when met, cause the platform to fire a 3rd party activity.

Condition Objects

Required

conversionIds

Internal.

Internal

Internal

codeVariableIds

IDs of variable tokens that are included in the 3rd party code.

Array of integer

Optional

Object JSON Example

Example

{

"type": "ThirdPartyActivity",

"id": 1083878971,

"relationsBag": {

"parents": {

"account": {

"id": 1073744288,

"name": "reutAccountDemo0",

"internal": false

},

"advertiser": {

"id": 1083762304,

"name": "reut adv3333"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1561451016021803000,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1561448933204,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1561451016017,

"name": "fff",

"activityType": "ThirdPartyConversionTracking",

"advertiserId": 1083762304,

"rulesCount": null,

"tagManagersCount": null,

"conversionsCount": 2,

"tagManagerIds": null,

"accessLevel": "Full",

"nxtTagManagement": true,

"code": "ff",

"noScriptMode": false,

"piggyBack": {

"type": "PiggyBack",

"deduplication": "AttributedSite",

"firingMode": "Inherited",

"siteName": "00X1Fkdrm0de111",

"siteId": 1083782050,

"deduplicationConversionAttributionModel": {

"type": "DeduplicationConversionAttributionModel",

"fire3rdPartyTracking": "LastEventImpressionOrClick",

"impressionValidUpTo": 30,

"clickValidUpTo": 30

}

},

"conditions": [

{

"type": "VariableCondition",

"orConditions": [

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"tttt"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

},

{

"type": "AndVariableInnerCondition",

"values": [

"43534345"

],

"variableId": 1083753342,

"variableName": "666",

"variableDataType": "String",

"operator": "DoesNotEqualOneOfTheFollowing"

}

]

},

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"7777"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

}

]

}

],

"criteriaType": "Variable"

}

],

"conversionIds": null,

"codeVariableIds": null

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Resource URL

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

https://api.sizmek.com/rest/tagManagers/thirdparty

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

Note

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

Objects Used by This Resource

The following objects are used by this endpoint:

3rdPartyActivity Object

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/tagManagers/thirdparty

Retrieves all 3rd party activities.

GET

/tagManagers/thirdparty/{id}

Retrieves a 3rd party activity by ID.

POST

/tagManagers/thirdparty

Creates a 3rd party activity.

PUT

/tagManagers/thirdparty/{id}

Updates an existing 3rd party activity.

DELETE

/tagManagers/thirdparty/{id}

Deletes a 3rd party activity.

POST

/tagManagers/thirdparty/delete

Deletes 3rd party activities in bulk.

GET

/tagManagers/thirdparty/existsInConversion/{id}

Searches for 3rd party activities that exist in the conversion activity.

GET

/tagManagers/thirdparty/getByConversionId/{id}

Determines whether a 3rd party activity exists in a conversion activity.

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 3rd Party Activities (GET)

Retrieves multiple 3rd party activities. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new 3rd party activities for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of 3rd party 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 query string values

NAME

DESCRIPTION

TYPE

ADVERTISER

Name of advertiser to which the 3rd party activity belongs.

String

ADVERTISERID

ID of advertiser to which the 3rd party activity belongs.

Long

TYPE

Type of entity.

String

DEDUPLICATION

Deduplication setting.

String

CREATEDBY

Name of the user that created the 3rd party activity.

String

UPDATEDBY

Name of the user that was last to update the 3rd party activity.

String

CREATEDON

Date 3rd party activity was created.

Long

UPDATEDON

Date of last update (Date epoch).

Long

TRIGGERINGCONVERSIONACTIVITIES

Number of conversion activities that trigger this 3rd party activity.

Integer

TRIGGERINGTAGMANAGERS

Number of tag managers that trigger this 3rd party activity.

Integer

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 tag manager.

Long

Optional

enrichWithEntitiesCounts

Determines whether to enrich tag manager 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:

https://api.sizmek.com/rest/tagManagers/thirdparty?from=0&max=250

https://adapi.sizmek.com/sas/tagManager/thirdparty?from=0&max=250

Note

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

Response Format

Example

{"result": [{

"type": "ThirdPartyActivity",

"id": 1083878971,

"relationsBag": {

"parents": {

"account": {

"id": 1073744288,

"name": "AccountDemo0",

"internal": false

},

"advertiser": {

"id": 1083762304,

"name": "reut adv3333"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1561451016021803000,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1561448933204,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1561451016017,

"name": "fff",

"activityType": "ThirdPartyConversionTracking",

"advertiserId": 1083762304,

"rulesCount": null,

"tagManagersCount": null,

"conversionsCount": 2,

"tagManagerIds": null,

"accessLevel": "Full",

"nxtTagManagement": true,

"code": "ff",

"noScriptMode": false,

"piggyBack": {

"type": "PiggyBack",

"deduplication": "AttributedSite",

"firingMode": "Inherited",

"siteName": "00X1Fkdrm0de111",

"siteId": 1083782050,

"deduplicationConversionAttributionModel": {

"type": "DeduplicationConversionAttributionModel",

"fire3rdPartyTracking": "LastEventImpressionOrClick",

"impressionValidUpTo": 30,

"clickValidUpTo": 30

}

},

"conditions": [

{

"type": "VariableCondition",

"orConditions": [

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"tttt"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

},

{

"type": "AndVariableInnerCondition",

"values": [

"43534345"

],

"variableId": 1083753342,

"variableName": "666",

"variableDataType": "String",

"operator": "DoesNotEqualOneOfTheFollowing"

}

]

},

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"7777"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

}

]

}

],

"criteriaType": "Variable"

}

],

"conversionIds": null,

"codeVariableIds": null

}

]

}

GET a 3rd Party Activity (GET)

Retrieve a 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party 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/thirdparty/{id}

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

Response Format

Example

{

"type": "ThirdPartyActivity",

"id": 1083878971,

"relationsBag": {

"parents": {

"account": {

"id": 1073744288,

"name": "reutAccountDemo0",

"internal": false

},

"advertiser": {

"id": 1083762304,

"name": "reut adv3333"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1561451016021803000,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1561448933204,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1561451016017,

"name": "fff",

"activityType": "ThirdPartyConversionTracking",

"advertiserId": 1083762304,

"rulesCount": null,

"tagManagersCount": null,

"conversionsCount": 2,

"tagManagerIds": null,

"accessLevel": "Full",

"nxtTagManagement": true,

"code": "ff",

"noScriptMode": false,

"piggyBack": {

"type": "PiggyBack",

"deduplication": "AttributedSite",

"firingMode": "Inherited",

"siteName": "00X1Fkdrm0de111",

"siteId": 1083782050,

"deduplicationConversionAttributionModel": {

"type": "DeduplicationConversionAttributionModel",

"fire3rdPartyTracking": "LastEventImpressionOrClick",

"impressionValidUpTo": 30,

"clickValidUpTo": 30

}

},

"conditions": [

{

"type": "VariableCondition",

"orConditions": [

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"tttt"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

},

{

"type": "AndVariableInnerCondition",

"values": [

"43534345"

],

"variableId": 1083753342,

"variableName": "666",

"variableDataType": "String",

"operator": "DoesNotEqualOneOfTheFollowing"

}

]

},

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"7777"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

}

]

}

],

"criteriaType": "Variable"

}

],

"conversionIds": null,

"codeVariableIds": null

}

Create a 3rd Party Activity (POST)

Create a new 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing 3rd party 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/thirdparty

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

Example

{

"entities": [

{

"type": "ThirdPartyActivity",

"id": "",

"name": "test",

"activityType": "ThirdParty",

"advertiserId": 1073747395,

"relationsBag": {

"parents": {

"account": {

"id": 1073746545,

"name": "Testing Account",

"internal": null

},

"advertiser": {

"id": "",

"name": ""

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"code": "[\%newVar\%]",

"noScriptMode": false,

"piggyBack": null,

"conditions": null,

"advertiserName": "!!!eidanAdvertiser11072017"

}

]

}

Response Format

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

Update an Existing 3rd Party Activity (PUT)

Updates an existing 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the 3rd party activity.

Long

Required

Body

Request containing 3rd party activity body to update.

JSON

Required

Request Format

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

PUT https://api.sizmek.com/rest/thirdparty/{id}

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

Example

{"entities": [{

"type": "ThirdPartyActivity",

"id": 1083878971,

"relationsBag": {

"parents": {

"account": {

"id": 1073744288,

"name": "reutAccountDemo0",

"internal": false

},

"advertiser": {

"id": 1083762304,

"name": "reut adv3333"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1561451016021803000,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1561448933204,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1561451016017,

"name": "fff",

"activityType": "ThirdPartyConversionTracking",

"advertiserId": 1083762304,

"rulesCount": null,

"tagManagersCount": null,

"conversionsCount": 2,

"tagManagerIds": null,

"accessLevel": "Full",

"nxtTagManagement": true,

"code": "ff",

"noScriptMode": false,

"piggyBack": {

"type": "PiggyBack",

"deduplication": "AttributedSite",

"firingMode": "Inherited",

"siteName": "00X1Fkdrm0de111",

"siteId": 1083782050,

"deduplicationConversionAttributionModel": {

"type": "DeduplicationConversionAttributionModel",

"fire3rdPartyTracking": "LastEventImpressionOrClick",

"impressionValidUpTo": 30,

"clickValidUpTo": 30

}

},

"conditions": [

{

"type": "VariableCondition",

"orConditions": [

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"tttt"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

},

{

"type": "AndVariableInnerCondition",

"values": [

"43534345"

],

"variableId": 1083753342,

"variableName": "666",

"variableDataType": "String",

"operator": "DoesNotEqualOneOfTheFollowing"

}

]

},

{

"type": "VariableInnerCondition",

"andConditions": [

{

"type": "AndVariableInnerCondition",

"values": [

"7777"

],

"variableId": 1083753345,

"variableName": "111",

"variableDataType": "String",

"operator": "EqualsOneOfTheFollowing"

}

]

}

],

"criteriaType": "Variable"

}

],

"conversionIds": null,

"codeVariableIds": null

}

]

}

Response Format

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

Delete a 3rd Party Activity (DELETE)

Deletes a single 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party 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/thirdparty/{id}

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

Response Format

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

Delete 3rd Party Activities in Bulk (POST)

Deletes a single 3rd party activity.

Request Format

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

POST https://api.sizmek.com/rest/tagManagers/thirdparty/delete

POST https://adapi.sizmek.com/sas/tagManagers/thirdparty/delete

Response Format

A successful request returns the HTTP 200 OK status code; the 3rd party activities are deleted.

Retrieve 3rd Party Activity in a Conversion Activity (GET)

Retrieves a 3rd party activity within a conversion activity.

Request Format

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

POST https://api.sizmek.com/rest/tagManagers/thirdparty/getByConversionId/{ConversionActivityID}?from=0&max=250&order=asc&sort=name

POST https://adapi.sizmek.com/sas/tagManagers/thirdparty/getByConversionId/{ConversionActivityID}?from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and an array of the 3rd party activities in the conversion activity.

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the Variable Object

Variable Resource

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

String

Required

TagManagerVariable

id

ID of variable.

Long

Read-only

Auto-generated, read-only value.

version

Internal.

String

Internal

createdBy

ID of the user that created the variable.

Long

Read-only

createdByName

Name of the user that created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Parent advertiser analytics settings.

String

Read-only

lastUpdateOn

Date of last update (date epoch).

Long

Read-only

name

Name of variable.

String

Required

advertiserId

ID of the advertiser to which the variable belongs.

Long

Read-only

variableType

Type of the variable.

String

Required

View variableType values

DataLayerVariable

GlobalJavascriptVariable

QueryStringVariable

dataType

Type of data for the variable.

String

Required

View dataType values

String

Number

variableName

Name of the variable.

String

Required

defaultValue

Defines a default value if there is no value for the variable.

String

Optional

globalData

Internal.

Internal

Internal

Object JSON Example

Example

"result": {

"type": "TagManagerVariable",

"id": 1083751548,

"version": 1552312103703609300,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1552312103706,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1552312103706,

"name": "var3",

"advertiserId": 1083759741,

"variableType": "DataLayerVariable",

"dataType": "String",

"variableName": null,

"defaultValue": null,

"globalData": null

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

You can use the variable resource to retrieve a specific variable or create a variable.

Resource URL

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

https://api.sizmek.com/rest/tagManagers/variables

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

Note

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

Objects Used by This Resource

The following objects are used by this endpoint:

Variable Object

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/tagManagers/variables/{Id}

Retrieve a specific variable.

POST

/tagManagers/variables

Create a variable.

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 a Variable (GET)

Retrieve a specific variable.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of the requested campaign

Integer

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/campaigns/1073869571

GET https://adapi.sizmek.com/sas/tagManagers/variables/1083751595

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the variable details. If there is no variable, the request returns an empty response.

Example

"result": {

"type": "TagManagerVariable",

"id": 1083751548,

"version": 1552312103703609300,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1552312103706,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1552312103706,

"name": "var3",

"advertiserId": 1083759741,

"variableType": "DataLayerVariable",

"dataType": "String",

"variableName": null,

"defaultValue": null,

"globalData": null

}

Create a Variable (POST)

Create a new variable.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing campaign 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/variables

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

Example

{

"entities": [

{

advertiserId: "1083759741"

dataType: "String"

name: "var2"

type: "TagManagerVariable"

variableType: "DataLayerVariable"

}

]

}

Response Format

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

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the siteKeywords Object

targetAudience Resource

Parent Objects

targetAudience Object

siteKeywords 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

Keywords

Keywords for the targeted site.

Array of strings

Required

Can add && (AND relation) or || (OR relation)

additionalKeywords

Internal.

Internal

Internal

Object JSON Example

Example

...

"targetingItems": [{

"type": "SiteKeywordTargeting",

"branchItemClientIds": [],

"siteKeywords": [{

"site": "MySite",

"keywords": "Keyword1,Keyword2",

"additionalKeywords": null

}],

"nodeType": "SiteKeywordTargeting"

}],

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

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 Sizmek 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

Example

...

"targetingItems": [{

"type": "Retargeting",

"branchItemClientIds": [],

"advertiserId": 63039,

"cookieAge": null,...

}],

...

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 viewerExpose values

EXPOSE TO

NOT_EXPOSED_TO

logicalOperator

Operator between two segments, if two are defined.

String

Required

View logicalOperator values

AND

OR

Object JSON Example

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": []

}],...

}],

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Overview

You can use the geo endpoint to retrieve the following information for targeting:

Countries, states, or cities, and their IDs

Countries or states that support DMA targeting, or DMAs available for a specific state

Countries or states that support area code targeting, or area codes available for a specific state

Countries that support postal code targeting

Countries that support ISP targeting

ISPs available for a specific country

Resource URL

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

https://api.sizmek.com/rest/csb/strategies/targetingData

https://adapi.sizmek.com/sas/csb/strategies/targetingData

Note

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

Objects Used by This Resource

Geo Object

HTTP Method and URI List

HTTP Method

URI

Description

GET

rest/csb/strategies/targetingData/countries

Retrieves all available countries and their IDs for targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

Retrieves all available states and their IDs for targeting.

GET

rest/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all available cities and their IDs for targeting.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

Retrieves all available countries that support DMA targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

Retrieves all available states that support DMA targeting.

GET

rest/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all DMAs available for targeting for a specific state.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode

Retrieves all available countries that support area code targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode

Retrieves all available states that support area code targeting.

GET

rest/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all area codes available for targeting for a specific state.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

Retrieves all available countries that suppport postal code targeting.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=isp

Retrieves all available countries that support ISP targeting.

GET

rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Retrieves all ISPs availabe for targeting for a specific country.

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 Countries

Retrieves all available countries and their IDs for targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/countries?from=0&max=250

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countriesadvertisers?from=0&max=250

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries and IDs.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 4,

"name": "Afghanistan",

"shortName": null,

"iso2Name": null

},

{

"id": 8,

"name": "Albania",

"shortName": null,

"iso2Name": null

},

{

"id": 10,

"name": "Antarctica",

"shortName": null,

"iso2Name": null

},

{

"id": 12,

"name": "Algeria",

"shortName": null,

"iso2Name": null

},

{

"id": 16,

"name": "American Samoa",

"shortName": null,

"iso2Name": null

},

{

"id": 20,

"name": "Andorra",

"shortName": null,

"iso2Name": null

},...

]

}

Get All States for a Country (GET)

Retrieves all available states and their IDs for targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available states and IDs.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 1,

"countryId": 840,

"name": "Alabama",

"shortName": "al"

},

{

"id": 2,

"countryId": 840,

"name": "Alaska",

"shortName": "ak"

},

{

"id": 8931,

"countryId": 840,

"name": "Aol",

"shortName": "aol"

},

{

"id": 3,

"countryId": 840,

"name": "Arizona",

"shortName": "az"

},

{

"id": 4,

"countryId": 840,

"name": "Arkansas",

"shortName": "ar"

},...

]

}

Get All Cities for a State (GET)

Retrieves all available cities and their IDs for targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available cities and IDs.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 29423,

"countryId": 428,

"name": "ViesīTes Novads",

"shortName": "107"

},

{

"id": 29399,

"countryId": 428,

"name": "StopiņU Novads",

"shortName": "095"

},

{

"id": 29067,

"countryId": 340,

"name": "Gracias A Dios",

"shortName": "gd"

},

{

"id": 29233,

"countryId": 422,

"name": "Aakkar",

"shortName": "ak"

},

{

"id": 30227,

"countryId": 882,

"name": "Aana",

"shortName": "aa"

},...

]

}

Get All Countries with DMA (GET)

Retrieves all countries that support DMA targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries that support DMA targeting.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 36,

"name": "Australia",

"shortName": null,

"iso2Name": null

},

{

"id": 124,

"name": "Canada",

"shortName": null,

"iso2Name": null

},

{

"id": 156,

"name": "China",

"shortName": null,

"iso2Name": null

},

{

"id": 208,

"name": "Denmark",

"shortName": null,

"iso2Name": null

},

{

"id": 246,

"name": "Finland",

"shortName": null,

"iso2Name": null

},...

]

}

Get All States with DMA (GET)

Retrieves all states that support DMA targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available states with DMA.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 1,

"countryId": 840,

"name": "Alabama",

"shortName": "al"

},

{

"id": 2,

"countryId": 840,

"name": "Alaska",

"shortName": "ak"

},

{

"id": 8931,

"countryId": 840,

"name": "Aol",

"shortName": "aol"

},

{

"id": 3,

"countryId": 840,

"name": "Arizona",

"shortName": "az"

},

{

"id": 4,

"countryId": 840,

"name": "Arkansas",

"shortName": "ar"

},...

]

}

Get DMAs by State (GET)

Retrieves DMAs available for targeting for a specific state.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available DMAs for a specific state.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 532,

"name": "Albany-Schenectady-Troy",

"regionId": 33,

"countryId": 840

},

{

"id": 502,

"name": "Binghamton",

"regionId": 33,

"countryId": 840

},

{

"id": 514,

"name": "Buffalo",

"regionId": 33,

"countryId": 840

},

{

"id": 523,

"name": "Burlington-Plattsburgh",

"regionId": 33,

"countryId": 840

},

{

"id": 565,

"name": "Elmira (Corning)",

"regionId": 33,

"countryId": 840

},...

]

}

Get All Countries with Area Codes (GET)

Retrieves all available countries that support area code targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all countries with area codes.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 16,

"name": "American Samoa",

"shortName": null,

"iso2Name": null

},

{

"id": 28,

"name": "Antigua And Barbuda",

"shortName": null,

"iso2Name": null

},

{

"id": 40,

"name": "Austria",

"shortName": null,

"iso2Name": null

},

{

"id": 44,

"name": "Bahamas",

"shortName": null,

"iso2Name": null

},

{

"id": 48,

"name": "Bahrain",

"shortName": null,

"iso2Name": null

},...

]

}

Get All States with Area Codes (GET)

Retrieves all available states that support area code targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=namecsb/strategies/targetingData/countries

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=namecsb/strategies/targetingData/countriesadvertisers?from=0&max=250

Request Format

GET https://api.sizmek.com/rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all states with area codes.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 1,

"countryId": 840,

"name": "Alabama",

"shortName": "al"

},

{

"id": 2,

"countryId": 840,

"name": "Alaska",

"shortName": "ak"

},

{

"id": 8931,

"countryId": 840,

"name": "Aol",

"shortName": "aol"

},

{

"id": 3,

"countryId": 840,

"name": "Arizona",

"shortName": "az"

},

{

"id": 4,

"countryId": 840,

"name": "Arkansas",

"shortName": "ar"

},...

]

}

Get All Area Codes by State (GET)

Retrieves all area codes available for targeting for a specific state.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all area codes for a specific state.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 212,

"regionId": 33,

"countryId": 840

},

{

"id": 315,

"regionId": 33,

"countryId": 840

},

{

"id": 347,

"regionId": 33,

"countryId": 840

},

{

"id": 516,

"regionId": 33,

"countryId": 840

},

{

"id": 518,

"regionId": 33,

"countryId": 840

},...

]

}

Get All Countries with Postal Codes (GET)

Retrieves all available countries that support postal code targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries with postal code support.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 124,

"name": "Canada",

"shortName": null,

"iso2Name": null

},

{

"id": 276,

"name": "Germany",

"shortName": null,

"iso2Name": null

},

{

"id": 826,

"name": "United Kingdom",

"shortName": null,

"iso2Name": null

},

{

"id": 840,

"name": "United States",

"shortName": null,

"iso2Name": null

}

]

}

Get All Countries with ISP (GET)

Retrieves all available countries that support ISP targeting.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/countries?&from=0&max=250&order=asc&sort=name&type=isp

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?&from=0&max=250&order=asc&sort=name&type=isp

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all countries with ISP support.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 4,

"name": "Afghanistan",

"shortName": null,

"iso2Name": null

},

{

"id": 8,

"name": "Albania",

"shortName": null,

"iso2Name": null

},

{

"id": 10,

"name": "Antarctica",

"shortName": null,

"iso2Name": null

},

{

"id": 12,

"name": "Algeria",

"shortName": null,

"iso2Name": null

},

{

"id": 16,

"name": "American Samoa",

"shortName": null,

"iso2Name": null

},...

]

}

Get ISPs by Country (GET)

Retrieves all ISPs availabe for targeting for a specific country.

Request Format

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

GET https://api.sizmek.com/rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all ISPs for a specific country.

Example

{

"metadata": null,

"debug": null,

"error": null,

"result": [

{

"id": 39117,

"name": "0",

"countryId": 840

},

{

"id": 8812,

"name": "Tellme Networks Idc 001",

"countryId": 840

},

{

"id": 9169,

"name": "Yahoo 01 As",

"countryId": 840

},

{

"id": 2146,

"name": "01.Com Inc.",

"countryId": 840

},

{

"id": 89247,

"name": "stratascale-01",

"countryId": 840

},...

]

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the Geo Object

targetAudience Resource

Parent Objects

targetAudience Object

Geo Targeting Items 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: Each geo targeting item has a list of objects with unique IDs that you must retrieve before adding the object to the target audience. For example, to target users from New York, you need to retrieve the country ID for the USA ("countryId": 840, and then the state ID for New York (regionId": 33). The following table includes the methods for retrieving this information. For more information about each method and code examples, see Geo Resource.

Name

Description

Type

required

Notes

branchItemClientIds

Internal

Read-only

countries

IDs of the countries targeted.

Array of integers

Optional

To retrieve the list of countries and IDs, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries

cities

IDs of the cities targeted.

Array of integers

Optional

To retrieve the list of cities and IDs, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

states/regions

IDs of the states/regions targeted.

Array of integers

Optional

To retrieve the list of states/regions and IDs, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

AreaCode

Targeted area codes.

Array of Geo Area Code Object Definition

Optional

To retrieve the list of countries and IDs that support area code targeting use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode

To retrieve the list of states/regions and IDs that support area code targeting use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode

To retrieve the list of area codes for a specific state, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

zipcodes

Targeted zip codes.

Array of Geo ZIP Code Object Definition

Optional

To retrieve the list of countries and IDs that support postal code targeting, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

nielsenDMAs

Targeted DMAs.

Array of Geo Nielsen DMA Object Definition

Optional

To retrieve the list of countries and IDs that support DMA targeting, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

To retrieve the list of states/regions and IDs that support DMA targeting, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

To retrieve the list of DMAs for a specific state, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

Isps

ISP IDs that are targeted.

Array of integers

Optional

To retrieve the list of countries and IDs that support ISP targeting, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=isp

To retrieve the the list of ISPs for a specific country, use this method:

GET https://api.sizmek.com /rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Object JSON Example

Example

...

{

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [376],

"cities": [8737],

"regions": [11867],

"areaCodes": [{...}],

"zipCodes": [{...}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{...}],

"isps": [58222]

},

...

Geo Area Code Object Definition

Name

Description

Type

required

Notes

Type

Type of geo targeting

String

Required

Value is AreaCode.

ID

ID of the area code targeted.

Array of integers

Required

countryId

ID of the country to which the area code belongs.

Long

Required

regionid

ID of the region to which the area code belongs.

Long

Required

Object JSON Example

Example

...

{

"type": "GeoTargeting",...

"areaCodes": [{

"type": "AreaCode",

"id": 684,

"clientRefId": null,

"relationsBag": null,

"uiPermissions": null,

"version": null,

"countryId": 16,

"regionId": "11571"

}],

"zipCodes": [{...}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{...}],

"isps": [58222]

},...

Geo ZIP Code Object Definition

Name

Description

Type

Required

Notes

countryid

ID of the country to which the ZIP code belongs.

Long

Required

countryZipCodes

Targeted ZIP code.

Array of integers

Required

type

Null.

Internal

Internal

Object JSON Example

Example

...

"zipCodes": [{

"countryId": 840,

"countryZipCodes": "59150",

"type": null

}, {

"countryId": 840,

"countryZipCodes": "51951",

"type": null

}],

...

Geo Nielsen DMA Object Definition

Name

Description

Type

Required

Notes

Type

Type of geo targeting.

String

Required

Value is NielsenDMA.

ID

ID of the Nielsen DMA targeted.

Array of integers

Required

countryId

ID of the country to which the Nielsen DMA belongs.

Long

Required

regionid

ID of the region to which the Nielsen DMA belongs.

Long

Required

Object JSON Example

Example

...

{

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [376],

"cities": [8737],

"regions": [11867],

"areaCodes": [{...}],

"zipCodes": [{...}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{

"type": "NielsenDMA",

"id": 36402,

"clientRefId": null,

"relationsBag": null,

"uiPermissions": null,

"version": null,

"countryId": 36,

"regionId": "689"

}],

"isps": [58222]

},...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the contextualTargeting Object

targetAudience Resource

Parent Objects

targetAudience Object

contextualTargeting 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

subCategoriesIds

IDs of the targeted Peer39 subcategories.

Array of integers

Required

Object JSON Example

Example

...

"targetingItems": [{

"type": "ContextualTargeting",

"branchItemClientIds": [],

"subCategoriesIds": [5334, 5319],

"nodeType": "ContextualTargeting"

}],

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using this Object

targetAudience Resource

Child Objects

Geo Object

Geo Resource

Retargeting Object

siteKeywords Object

DMP Object

relationsBag Object

contextualTargeting Object

targetAudience 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

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

Type

Object type.

String

Read-only

ID

ID of the target audience.

Long

Read-only

createdBy

ID of the user who created the object.

Long

Read-only

createdByName

Name of the user who created the object.

String

Read-only

createdByAccount

Account ID of the user who created the object.

Long

Read-only

createdByAccountName

Name of the account of the user who created the object.

String

Read-only

createdOn

Creation date.

Long

Read-only

lastUpdatedBy

ID of the user who last updated the object.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the object.

String

Read-only

lastUpdatedByAccount

Account ID of the user who last updated the object.

Long

Read-only

lastUpdatedByAccountName

Account name of the user who last updated the object.

String

Read-only

lastUpdateOn

Date the object was last updated .

Long

Read-only

accountId

Account ID of the object.

Long

Read-only

accountName

Account name of the object.

String

Read-only

name

Name of the target audience.

String

Required

campaignId

ID of the campaign.

Long

Read-only

campaignId, campaignname, numberOfCampaigns, targetAudienceType

Deprecated.

Deprecated

Read-only

strategyId

ID of the strategy (if the target audience was created as part of an audience strategy).

Long

Read-only

strategyName

Name of the strategy (if the target audience was created as part of an audience strategy).

String

Read-only

advertiserId

ID of the advertiser the target audience belongs to. The advertiser ID is only added to the target audience if the target audience is using advertiser related objects, such as retargeting, or data hub segments.

Long

Required

For target audiences that have Data Hub segments/retargeting.

advertiserName

Name of the advertiser to which the target audience belongs.

String

Read-only

targetingItemTypes

Decision rules that apply to this target audience.

Array of strings

External name

External name of the target audience.

String

Optional

campaignsData

Internal.

Internal

Internal

customCategoryMapIdNames

Names of the Peer39 custom categories used in this target audience.

String

Read-only

targetingItems

Targeting objects and the targeting values in the target audience.

Array of objects

Required

Objects include:

geo

retargeting

site keywords

DMP

contextual targeting

nodeType

Object type.

String

Required

View nodeType values

Value should be the same as the value for the Object type field.

Retargeting

SiteKeywordTargeting

GeoTargeting

ContextualTargeting

DMP

itemIdToNameTranslate

Internal.

Internal

Internal

Names of the targeting objects, for example, countries, used in the target audience.

Object JSON Example

Example

{

"result":

{

"type": "TargetAudience",

"id": 1073766199,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "MyAccount",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1514722029396754432,

"createdBy": 359567,

"createdByName": "John Smith",

"createdByAccount": 2,

"createdByAccountName": "MyAccount",

"createdOn": 1514722029395,

"lastUpdatedBy": 359567,

"lastUpdatedByName": "John Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "MyAccount",

"lastUpdateOn": 1514722029395,

"accountId": 2,

"accountName": "MyAccount",

"name": "API Target Audience x6",

"targetingItems": [{

"type": "Retargeting",

"branchItemClientIds": [],

"advertiserId": 63039,

"cookieAge": null,

"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": []

}],

"nodeType": "ReTargeting"

}, {

"type": "SiteKeywordTargeting",

"branchItemClientIds": [],

"siteKeywords": [{

"site": "MySite",

"keywords": "Keyword1,Keyword2",

"additionalKeywords": null

}],

"nodeType": "SiteKeywordTargeting"

}, {

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [376],

"cities": [8737],

"regions": [11867],

"areaCodes": [{

"type": "AreaCode",

"id": 684,

"relationsBag": null,

"version": null,

"countryId": 16,

"regionId": "11571"

}],

"zipCodes": [{

"countryId": 840,

"countryZipCodes": "59150",

"type": null

}, {

"countryId": 840,

"countryZipCodes": "51951",

"type": null

}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{

"type": "NielsenDMA",

"id": 36402,

"relationsBag": null,

"version": null,

"countryId": 36,

"regionId": "689"

}],

"isps": [58222]

}, {

"type": "DMP",

"branchItemClientIds": [],

"segments": [{

"id": 3485345,

"advertiserId": 63039,

"dataProviderId": null,

"order": 0,

"logicalOperator": "OR"

}],

"nodeType": "DMP"

}, {

"type": "ContextualTargeting",

"branchItemClientIds": [],

"subCategoriesIds": [5334, 5319],

"nodeType": "ContextualTargeting"

}],

"campaignId": null,

"campaignName": null,

"strategyId": null,

"strategyName": null,

"advertiserId": 63039,

"advertiserName": "!BTest!",

"defaultPriority": null,

"itemIdToNameTranslate": {

"6841157116": "6841157116",

"18033": "CSB Tag Test",

"5334": "Very High",

"58222": "level 3 communications inc.",

"11867": "Tel Aviv",

"3485345": "AA",

"376": "Israel",

"29560": "DCOTEST",

"7796105": "bla1",

"8737": "Abbeville",

"3640268936": "Adelaide - North",

"5319": "High",

"13226": "Sofa",

"13227": "Table"

},

"targetingItemTypes": ["ReTargeting", "SiteKeywordTargeting", "ContextualTargeting", "GeoTargeting", "DMP"],

"externalName": "Audience External Name x6",

"campaignsData": [],

"numberOfCampaigns": 0,

"customCategoryMapIdNames": null,

"targetAudienceType": null

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Overview

You can use the target audience endpoint to retrieve a specific target audience, create a new target audience, update an existing target audience, or delete an audience.

Resource URL

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

https://api.sizmek.com/rest/strategies/targetAudiences/

https://adapi.sizmek.com/sas/strategies/targetAudiences/

Note

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

Objects Used by this Resource

targetAudience Object

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

/strategies/targetAudiences/

Retrieves multiple target audiences.

GET

/strategies/targetAudiences/{ID}

Retrieves a specific target audience.

POST

/strategies/targetAudiences/

Creates a new target audience.

PUT

/strategies/targetAudiences/{ID}

Updates an existing target audience.

PUT

/strategies/targetAudiences/delete

Deletes an existing target audience.

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 Multiple Target Audiences (GET)

Retrieves multiple target audiences.

Request Query Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

from

Starting index by which to fetch new audiences for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of audiences to fetch for each page.

Long

Required

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

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 query string values

NAME

DESCRIPTION

TYPE

NAME

Name of target audience.

String

ID

ID of target audience.

Long

TYPE

Type of targeting decision.

String

STRATEGY

ID of strategy.

Long

ACCOUNT

ID of account.

Long

EXTERNALAUDIENCENAME

Unique name of the target audience.

String

ID

ID of audiences to retrieve.

Long

Required

Request Format

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

GET https://api.sizmek.com/rest/strategies/targetAudiencesV2?from=0&max=250&order=desc&sort=id

GET https://adapi.sizmek.com/sas/strategies/targetAudiencesV2?from=0&max=250&order=desc&sort=id

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the target audiences' details .

Example

{ "result": [{

"type": "TargetAudience",

"id": 1073770271,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "Testing",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1534336641093074944,

"createdBy": 359567,

"createdByName": "John Smith",

"createdByAccount": 2,

"createdByAccountName": "Testing",

"createdOn": 1534336641088,

"lastUpdatedBy": 359567,

"lastUpdatedByName": "John Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "Testing",

"lastUpdateOn": 1534336641088,

"accountId": 2,

"accountName": "Testing ",

"name": "Target Audience - USA (New York)",

"targetingItems": [{

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [840],

"cities": null,

"regions": null,

"areaCodes": null,

"zipCodes": null,

"nodeType": "GeoTargeting",

"nielsenDMAs": null,

"isps": null

}],

"campaignId": null,

"campaignName": null,

"strategyId": null,

"strategyName": null,

"advertiserId": null,

"advertiserName": null,

"strategyOrTACreationType": "TA_BUILDER",

"defaultPriority": null,

"itemIdToNameTranslate": {

"840": "United States"

},

"targetingItemTypes": ["GeoTargeting"],

"externalName": "",

"campaignsData": [],

"numberOfCampaigns": 0,

"customCategoryMapIdNames": null,

"targetAudienceType": null

}, {

"type": "TargetAudience",

"id": 1073770266,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "Testing",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1534336598213132288,

"createdBy": 359567,

"createdByName": "John Smith",

"createdByAccount": 2,

"createdByAccountName": "Testing",

"createdOn": 1534336576344,

"lastUpdatedBy": 359567,

"lastUpdatedByName": "John Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "Testing",

"lastUpdateOn": 1534336598209,

"accountId": 2,

"accountName": "Testing",

"name": "Target Audience - USA (California)",

"targetingItems": [{

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [840],

"cities": null,

"regions": null,

"areaCodes": null,

"zipCodes": null,

"nodeType": "GeoTargeting",

"nielsenDMAs": null,

"isps": null

}],

"campaignId": null,

"campaignName": null,

"strategyId": null,

"strategyName": null,

"advertiserId": null,

"advertiserName": null,

"strategyOrTACreationType": "TA_BUILDER",

"defaultPriority": null,

"itemIdToNameTranslate": {

"840": "United States"

},

"targetingItemTypes": ["GeoTargeting"],

"externalName": "",

"campaignsData": [],

"numberOfCampaigns": 0,

"customCategoryMapIdNames": null,

"targetAudienceType": null

}]

}

Get a Specific Target Audience (GET)

Retrieve a specific target audience.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of audience to retrieve.

Long

Required

Request Format

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

GET https://api.sizmek.com/rest/strategies/targetAudiences/1073766199

GET https://adapi.sizmek.com/sas/strategies/targetAudiences/1073766199

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the audience details.

Example

{

"result":

{

"type": "TargetAudience",

"id": 1073766199,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "MyAccount",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1514722029396754432,

"createdBy": 359567,

"createdByName": "Tom Smith",

"createdByAccount": 2,

"createdByAccountName": "My Account",

"createdOn": 1514722029395,

"lastUpdatedBy": 359567,

"lastUpdatedByName": "Tom Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "My Account",

"lastUpdateOn": 1514722029395,

"accountId": 2,

"accountName": "My Account",

"name": "API Target Audience x6",

"targetingItems": [{

"type": "Retargeting",

"branchItemClientIds": [],

"advertiserId": 63039,

"cookieAge": null,

"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": []

}],

"nodeType": "ReTargeting"

}, {

"type": "SiteKeywordTargeting",

"branchItemClientIds": [],

"siteKeywords": [{

"site": "MySite",

"keywords": "Keyword1,Keyword2",

"additionalKeywords": null

}],

"nodeType": "SiteKeywordTargeting"

}, {

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [376],

"cities": [8737],

"regions": [11867],

"areaCodes": [{

"type": "AreaCode",

"id": 684,

"relationsBag": null,

"version": null,

"countryId": 16,

"regionId": "11571"

}],

"zipCodes": [{

"countryId": 840,

"countryZipCodes": "59150",

"type": null

}, {

"countryId": 840,

"countryZipCodes": "51951",

"type": null

}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{

"type": "NielsenDMA",

"id": 36402,

"relationsBag": null,

"version": null,

"countryId": 36,

"regionId": "689"

}],

"isps": [58222]

}, {

"type": "DMP",

"branchItemClientIds": [],

"segments": [{

"id": 3485345,

"advertiserId": 63039,

"dataProviderId": null,

"order": 0,

"logicalOperator": "OR"

}],

"nodeType": "DMP"

}, {

"type": "ContextualTargeting",

"branchItemClientIds": [],

"subCategoriesIds": [5334, 5319],

"nodeType": "ContextualTargeting"

}

],

"campaignId": null,

"campaignName": null,

"strategyId": null,

"strategyName": null,

"advertiserId": 63039,

"advertiserName": "!MyAdvertiser",

"defaultPriority": null,

"itemIdToNameTranslate": {

"6841157116": "6841157116",

"18033": "CSB Tag Test",

"5334": "Very High",

"58222": "level 3 communications inc.",

"11867": "Tel Aviv",

"3485345": "AA",

"376": "Israel",

"29560": "DCOTEST",

"7796105": "bla1",

"8737": "Abbeville",

"3640268936": "Adelaide - North",

"5319": "High",

"13226": "Sofa",

"13227": "Table"

},

"targetingItemTypes": ["ReTargeting", "SiteKeywordTargeting", "ContextualTargeting", "GeoTargeting", "DMP"],

"externalName": "Audience External Name x6",

"campaignsData": [],

"numberOfCampaigns": 0,

"customCategoryMapIdNames": null,

"targetAudienceType": null

}

}

Create an Audience (POST)

Creates a new target audience.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing target audience body.

JSON

Required

Request Format

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

POST https://api.sizmek.com/rest/strategies/targetAudiences/

POST https://adapi.sizmek.com/sas/strategies/targetAudiences /

Example

{

"entities": [

{

"type": "TargetAudience",

"accountId": 2,

"name": "API Target Audience x9",

"targetingItems": [{

"type": "DMP",

"segments": [{

"id": 3485345,

"accountId": 2,

"advertiserId": 63039

}],

"advertiserId": 63039

}, {

"type": "Retargeting",

"retargetingViewers": [{

"logicalOperator": "AND",

"viewerExpose": "EXPOSE_TO",

"tagId": 29560,

"values": [7796105]

}, {

"logicalOperator": "OR",

"viewerExpose": "EXPOSE_TO",

"tagId": 18033,

"values": [13226, 13227]

}],

"advertiserId": 63039

}, {

"type": "GeoTargeting",

"countries": [376],

"regions": [11867],

"cities": [8737],

"nielsenDMAs": [{

"id": 36402,

"regionId": 689,

"countryId": 36,

"type": "NielsenDMA"

}],

"areaCodes": [{

"id": 684,

"regionId": 11571,

"countryId": 16,

"type": "AreaCode"

}],

"zipCodes": [{

"countryId": 840,

"countryZipCodes": "59150"

}, {

"countryId": 840,

"countryZipCodes": "51951"

}],

"isps": [58222]

}, {

"type": "ContextualTargeting",

"subCategoriesIds": [5319, 5334]

}, {

"type": "SiteKeywordTargeting",

"siteKeywords": [{

"site": "MySite",

"keywords": "Keyword1,Keyword2"

}]

}],

"externalName": "Audience External Name x9",

"advertiserId": 63039

}

]

}

Update an Existing Target Audience (PUT)

Updates an existing target audience.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of audience to retrieve.

Long

Required

Body

Request containing target audience to update.

JSON

Required

Request Format

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

PUT https://api.sizmek.com/rest/strategies/targetAudiences/1073766199

PUT https://adapi.sizmek.com/sas/strategies/targetAudiences/1073766199

Example

{

"entities": [

{

"type": "TargetAudience",

"id": 1073766199,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "MyAccount",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

,

"version": 1514722029396754432,

"createdBy": 359567,

"createdByName": "Tom Smith",

"createdByAccount": 2,

"createdByAccountName": "MyAccount",

"createdOn": 1514722029395,

"lastUpdatedBy": 359567,

"lastUpdatedByName": "Tom Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "MyAccount",

"lastUpdateOn": 1514722029395,

"accountId": 2,

"accountName": "MyAccount",

"name": "API Target Audience x6",

"targetingItems": [{

"type": "Retargeting",

"branchItemClientIds": [],

"advertiserId": 63039,

"cookieAge": null,

"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": []

}],

"nodeType": "ReTargeting"

}, {

"type": "SiteKeywordTargeting",

"branchItemClientIds": [],

"siteKeywords": [{

"site": "MySite",

"keywords": "Keyword1,Keyword2",

"additionalKeywords": null

}],

"nodeType": "SiteKeywordTargeting"

}, {

"type": "GeoTargeting",

"branchItemClientIds": [],

"countries": [376],

"cities": [8737],

"regions": [11867],

"areaCodes": [{

"type": "AreaCode",

"id": 684,

"relationsBag": null,

"version": null,

"countryId": 16,

"regionId": "11571"

}],

"zipCodes": [{

"countryId": 840,

"countryZipCodes": "59150",

"type": null

}, {

"countryId": 840,

"countryZipCodes": "51951",

"type": null

}],

"nodeType": "GeoTargeting",

"nielsenDMAs": [{

"type": "NielsenDMA",

"id": 36402,

"relationsBag": null,

"version": null,

"countryId": 36,

"regionId": "689"

}],

"isps": [58222]

}, {

"type": "DMP",

"branchItemClientIds": [],

"segments": [{

"id": 3485345,

"advertiserId": 63039,

"dataProviderId": null,

"order": 0,

"logicalOperator": "OR"

}],

"nodeType": "DMP"

}, {

"type": "ContextualTargeting",

"branchItemClientIds": [],

"subCategoriesIds": [5334, 5319],

"nodeType": "ContextualTargeting"

}

],

"campaignId": null,

"campaignName": null,

"strategyId": null,

"strategyName": null,

"advertiserId": 63039,

"advertiserName": "!BTest!",

"defaultPriority": null,

"itemIdToNameTranslate": {

"6841157116": "6841157116",

"18033": "CSB Tag Test",

"5334": "Very High",

"58222": "level 3 communications inc.",

"11867": "Tel Aviv",

"3485345": "AA",

"376": "Israel",

"29560": "DCOTEST",

"7796105": "bla1",

"8737": "Abbeville",

"3640268936": "Adelaide - North",

"5319": "High",

"13226": "Sofa",

"13227": "Table"

},

"targetingItemTypes": ["ReTargeting", "SiteKeywordTargeting", "ContextualTargeting", "GeoTargeting", "DMP"],

"externalName": "Audience External Name x6",

"campaignsData": [],

"numberOfCampaigns": 0,

"customCategoryMapIdNames": null,

"targetAudienceType": null

}

]

}

Response Format

A successful request returns the HTTP 200 OK status code with the updated target audience in the response body.

Delete a Target Audience (PUT)

Delete an existing target audience.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of audience to retrieve.

Long

Required

Request Format

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

PUT https://api.sizmek.com/rest/strategies/targetAudiences/delete

PUT https://adapi.sizmek.com/sas/strategies/targetAudiences/delete

Example

{

"entities": ["1083741990"]

}

Response Format

A successful request returns the HTTP 200 OK status code with the deleted target audience in the response body.

Example

{

"entities": ["1083741990"]

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the globalData Object

Advertiser Resource

Activity Rule Resource

conversionActivity Resource

tagManager Resource

Parent Objects

Advertiser Object

Activity Rule Object

conversionActivity Object

tagManager Object

globalData 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 object

String

Required

globalData

status

Defines the status of the advertiser in regards to its global feature.

String

Required

View status values

Global: Global advertiser

Local: Local advertiser

GlobalLocal: Local advertiser that is also global for other advertisers.

local

For a local advertiser, this field is populated with the global advertiser of the current advertiser.

localEntityData Object

Optional

LocalEntityData

global

Object that describes the global fields.

global Object

Optional

Object JSON Example

Example - Global Advertiser

...

},

"globalData": {

"type": "GlobalData",

"status": "Global",

"global": {

"type": "GlobalEntityData",

"allowUserAccessToLocalAdvertisers": true,

"localAdvertisers": [

{

"type": "AdvertiserIdName",

"id": 1083743325,

"name": "Concertified Japan",

"accountId": 1073747156,

"accountName": "b&eAadvertising",

"hasGlobalAdvertiserPermissionAccess": true,

"hasGlobalTagManagerPermissionAccess": true

},

{

"type": "AdvertiserIdName",

"id": 1083743330,

"name": "Concertified France",

"accountId": 1073747156,

"accountName": "b&eAadvertising",

"hasGlobalAdvertiserPermissionAccess": true,

"hasGlobalTagManagerPermissionAccess": true

},

{

"type": "AdvertiserIdName",

"id": 1083743326,

"name": "Concertified UK",

"accountId": 1073747156,

"accountName": "b&eAadvertising",

"hasGlobalAdvertiserPermissionAccess": true,

"hasGlobalTagManagerPermissionAccess": true

}

]

},

"local": null

}

}

}

Example - Local Advertiser

"globalData": {

"type": "GlobalData",

"status": "Local",

"global": null,

"local": {

"type": "LocalEntityData",

"globalAdvertisers": [{

"type": "AdvertiserIdName",

"id": 1073754146,

"name": "global advertiser for CS March preview",

"accountId": null,

"accountName": null

}]

}

}

global Object

global 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 object.

String

Read-only

GlobalEntityData

allowUserAccessToLocalAdvertisers

Determines whether each user under the account that holds this global advertiser has access to all of the local advertisers.

Boolean

Optional

localAdvertisers

Array of local advertiser objects.

Array of localAdvertisers Object

Optional

Object JSON Example

Example

...,

"global": {

"type": "GlobalEntityData",

"allowUserAccessToLocalAdvertisers": true,

"localAdvertisers": [{

"type": "AdvertiserIdName",

"id": 1083743325,

"name": "Concertified Japan",

"accountId": 1073747156,

"accountName": "b&eAadvertising",

"hasGlobalAdvertiserPermissionAccess": true,

"hasGlobalTagManagerPermissionAccess": true

}]

}

localAdvertisers Object

local 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 the entity

String

Read-only

AdvertiserIdName

id

ID of the local advertiser.

Long

Read-only

name

Name of local advertiser.

String

Read-only

accountId

ID of account that holds the local advertiser.

Long

Read-only

accountName

Name of account to which the local advertiser advertiser belongs.

String

Read-only

Object JSON Example

Example

...

{

"type": "AdvertiserIdName",

"id": 1083743325,

"name": "Concertified Japan",

"accountId": 1073747156,

"accountName": "b&eAadvertising",

},

...

localEntityData Object

localEntityData 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 object.

String

Read-only

LocalEntityData

globalAdvertisers

Represents a central location under which you can aggregate local advertisers that are managed by multiple accounts.

globalAdvertisers Object

Optional

Object JSON Example

Example

"local": {

"type": "LocalEntityData",

"globalAdvertisers": [{

"type": "AdvertiserIdName",

"id": 1073754146,

"name": "global advertiser for CS March preview",

"accountId": null,

"accountName": null

}]

}

globalAdvertisers Object

globalAdvertisers 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 object.

String

Read-only

AdvertiserIdName

id

ID of global advertiser.

Integer

Read-only

name

Name of global advertiser.

String

Required

accountId

ID of the account that holds the global advertiser.

Long

Optional

accountName

Name of the account to which the global advertiser belongs.

String

Optional

Object JSON Example

Example

...,

"local": {

"type": "LocalEntityData",

"globalAdvertisers": [{

"type": "AdvertiserIdName",

"id": 1073754146,

"name": "global advertiser for CS March preview",

"accountId": null,

"accountName": null

}]

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the siteTrackingAndTargeting Object

Site Resource

Parent Objects

Site Object

siteTrackingAndTargeting Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

type

Type of entity.

String

SiteTrackingAndTargeting

lineId

A dynamic token that allows publishers to pass data to Sizmek on the ad request. Sizmek will use its value on 3rd party tracking URLs that Sizmek fires on impressions or clicks. This allows publishers to leverage URL tokens to transfer data to third parties that track the campaign.

String

cacheBustingToken

The cache busting token is used by the ad server to track impressions and clicks. If you did not select a publisher ad server, or need to change the existing token, enter it here. The token can be obtained from the publisher's ad server support.

The Random Number option allows Sizmek to include a random cache busting token in the generated code automatically. This is typically used for sites without ad servers.

cacheBustingToken Object

impressionTrackingToken

Enables you to add the URL for tracking impressions by the selected ad server. The URL can be obtained from the publisher's ad server support.

String

clickTrackingToken

Enables you to add the URL for tracking clicks by the selected ad server. The URL can be obtained from the publisher's ad server support.

String

customPublisherParameter

Used for analytics purposes. Enables a custom parameter to be sent to Sizmek Ad Suite for every impression event. Data that is received is available in cookie-level data and custom reports.

String

Object JSON Example

Example

...

"siteTrackingAndTargeting":{

"type":"SiteTrackingAndTargeting",

"lineId":"1",

"cacheBustingToken":{

"adServer":"FALK",

"tokenString":"+Ads_Timestamp+"

},

"impressionTrackingToken":"CHiCNwwm7F",

"clickTrackingToken":"8zliVNAzwc",

"customPublisherParameter":"LzTy4JKtzW"

},

...

cacheBustingToken Object

cacheBustingToken Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

adServer

Type of cache busting.

String

tokenString

Token string used for cache busting.

String

Object JSON Example

Example

"cacheBustingToken":{

"adServer":"FALK",

"tokenString":"+Ads_Timestamp+"

},

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the siteTagSettings Object

Site Resource

Parent Objects

Site Object

siteTagSettings Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

type

Type of entity.

String

SiteTagSettings

clearEscapingOfNoscripTag

Relevant for the Create iFrame option. For the NoScript part of the code, the tag URL (variable) will not be escaped.

Boolean

referringURLToken

Adds the Referring URL Token to the generated placement tags for the vURL (verification/page URL) parameter. The token will be replaced by the publisher with the Referring URL.

String

trackingTagType

Code generated for tracking placements includes URLs for tracking impressions and clicks. This option determines whether to generate these URLs within IMG tags (required by certain ad servers) instead of within regular or script tags.

String

tagTypes

Enables you to select a default tag type for placements in this site:

Script: Generates code for serving ads by using a script.

iFrame: Serves the ads to an iFrame in the web page.

Auto Detect: Sizmek automatically determines whether the ad is being served into an iFrame, and then serves the ad appropriately. Please note that with this option, when iFrames are used to serve content, Auto Detect will identify the ad as an iFrame, and expand it beyond the content's boundaries.

Create iFrame: Creates the iFrame to which the ads will be served.

Array of Strings

createIFrameSupported

Adds the Create iFrame option to the publish settings for placements to run on this site. If you do not set this value to true, only Script, iFrame, and Auto Detect options are enabled.

Boolean

protocol

Determines whether the tag will be generated with a secure protocol (HTTPS) or non-secure protocol (HTTP).

For HTML5 and In-Stream ads, when a tag is generated with a secure protocol, the ad request and all subsequent Sizmek ad server calls will be over a secure protocol, regardless of whether the tag is placed on a secure page or a non-secure page.

For Adobe Flash Rich Media ads, because of Flash framework limitations, if a secure tag is placed on a non-secure page, the ad request is sent over a secure protocol; however, the ad's assets will use a non-secure protocol.

When generating a secure tag, make sure that you check that all other URLs, for example, 3rd party trackers, used by the ad are using the secure protocol.

String

View protocol values

HTTP

HTTPS

Object JSON Example

Example

...

"siteTagSettings":{

"type":"SiteTagSettings",

"clearEscapingOfNoscriptTag":true,

"referringURLToken":null,

"trackingTagType":"IMG",

"tagTypes":[

"Script"

],

"createIFrameSupported":true,

"protocol":"HTTPS"

},

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the sitePrivacy Object

Site Resource

Parent Objects

Site Object

sitePrivacy Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

type

Type of entity.

String

SitePrivacy

coppaCompliantSite

Sizmek clients must comply with all applicable laws when using the Sizmek Ad Suite platform.

By setting this to true, you confirm that this site complies with the U.S. Children’s Online Privacy Protection Act (COPPA), according to which cookies are not permitted. When a placement's site is COPPA-compliant, the placement setting inherits the privacy setting from the site.

Boolean

disableCookies

Disable or enable cookies for placement.

Boolean

Object JSON Example

Example

...

"sitePrivacy":{

"type":"SitePrivacy",

"disableCookies":false,

"coppaCompliantSite":false

},

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the siteAdDelivery Object

Site Resource

Parent Objects

Site Object

siteAdDelivery Object Definition

PARAMETER

DESCRIPTION

TYPE

NOTES

type

Type of entity.

String

SiteAdDelivery

inAppSDK

SDK on the mobile app that serves the ad.

String

allowHTML5DynamicExpansion

Enables the system to automatically detect the direction in which HTML5 expandable ads should expand during serving.

Boolean

Required in a programmatic environment, where the location of the ad that will be displayed is not known in advance.

minZIndex

The default minimum Z-index for the site or section. Determines the ad’s position in the order of layers on the page. For example, type 11000 for the ad to appear in front of the page that has a value of 10000.

Integer

Object JSON Example

Example

...

"siteAdDelivery":{

"type":"SiteAdDelivery",

"inAppSDK":"AdMarvel",

"allowHTML5DynamicExpansion":false,

"minZIndex":1

},

...

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the Site Object

Site Resource

Child Objects

siteAdDelivery Object

sitePrivacy Object

siteTagSettings Object

siteTrackingAndTargeting Object

Object Definition

Name

Description

Type

Notes

type

Type of entity.

String

siteGlobal

id

ID of site.

Long

Auto-generated, read-only value.

name

Name of site.

String

regionalSettings

Settings of the site's region.

regionalSettings Object

siteContacts

Internal.

Internal

siteTagSettings

Attributes that define how to generate a tag for placements that are served under this site.

siteTagSettings Object

siteAdDelivery

Attributes that define how the ad will be delivered.

siteAdDelivery Object

siteTrackingAndTargeting

Attributes that define geo tokens, mobile tokens, and site keywords and parameters.

siteTrackingAndTargeting Object

sitePrivacy

Attributes that determine COPPA and cookie settings.

sitePrivacy Object

siteSections

Sections of the site, for example xyz/sports, xyz/science, xyz/news.

Object

Object JSON Example

Example

result":[

{

"type":"SiteGlobal",

"id":1083765730,

"name":"00X1Fkdrm0",

"regionalSettings":{

"type":"RegionalSettings",

"defaultTimeZone":"GMT_Minus_11",

"market":{

"type":"Market",

"id":2,

"name":"Europe"

}

},

"siteContacts":null,

"siteTagSettings":{

"type":"SiteTagSettings",

"clearEscapingOfNoscriptTag":true,

"referringURLToken":null,

"trackingTagType":"IMG",

"tagTypes":[

"Script"

],

"createIFrameSupported":true,

"protocol":"HTTPS"

},

"siteAdDelivery":{

"type":"SiteAdDelivery",

"inAppSDK":"AdMarvel",

"allowHTML5DynamicExpansion":false,

"minZIndex":1

},

"siteTrackingAndTargeting":{

"type":"SiteTrackingAndTargeting",

"lineId":"1",

"cacheBustingToken":{

"adServer":"FALK",

"tokenString":"+Ads_Timestamp+"

},

"impressionTrackingToken":"CHiCNwwm7F",

"clickTrackingToken":"8zliVNAzwc",

"customPublisherParameter":"LzTy4JKtzW"

},

"sitePrivacy":{

"type":"SitePrivacy",

"disableCookies":false,

"coppaCompliantSite":false

},

"siteSections":null

},

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Overview

You can use the site resource to retrieve a set of sites, retrieve a specific site, retrieve sections from a specific site, and create site sections for a specific site.

Resource URL

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

https://api.sizmek.com/rest/sites/global

https://adapi.sizmek.com/sas/sites/global

Note

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

Objects Used by This Resource

Site Object

HTTP Method and URI List

HTTP Method

URI

Description

GET

/sites/global

Retrieves multiple sites.

GET

/sites/global/{Id}

Retrieves a specific sites.

GET

/siteSections/global

Retrieves multiple site sections.

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 Multiple Sites

Retrieves multiple Sites.

Request Query Parameters

Name

Description

Type

Required

Notes

advertiserId

Retrieves all sites under the specific advertiser.

Long

Optional

from

Starting index by which to fetch new sites for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of sites to fetch for each page.

Long

Required

accountId

ID of account.

Long

Optional

sort

Sort by field name (see here ).

String

Optional

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.

q

Filtering options for the request (see here ).

String

Optional

Example of query string: q={"1":{"NAME":["Test"]}}

Note

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

View query string values

name

description

type

Notes

NAME

Name of site.

String

advertiserId

ID of advertiser.

Long

Optional

Request Format

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

GET https://api.sizmek.com/rest/sites/global?from=0&max=250

GET https://adapi.sizmek.com/sas/sites/global?from=0&max=250

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the sites' details filtered by data ownership.

Example

{

"result": [{

"type": "site",

"id": 1073928827,

"clientRefId": null,

"relationsBag": {

"parents": null,

" "

},

}{

"type": "site",

"id": 1073928826,

"clientRefId": null,

"relationsBag": {

"parents": null,

" "

}

}]

}

Get a Site

Retrieves a specific site.

Request Parameters

Name

Description

Type

Required

Notes

id

ID of the requested site

Integer

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/sites/1083756754

GET https://adapi.sizmek.com/sas/sites/1083756754

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the site details filtered by data ownership. If there is no site or data ownership, the request returns an empty response.

Example

{

"result": {

"type": "site",

"id": 1083756754,

"relationsBag": {

"parents": {

"account": {

"id": 312,

"name": "Analytics Training",

"internal": false

},

"advertiser": {

"id": 37721,

"name": "#[2_LL_advp911"

},

"site": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"sites": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1536845374212866048,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1536844470767,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1536845374209,

"name": "Deb Test site-1",

"advertiserId": 37721,

"vertical": "Gaming",

"status": "Enabled",

"adminSettings": {

"type": "AdminSettings",

"regionalSettings": {

"type": "RegionalSettings",

"defaultTimeZone": "GMT_Plus_02",

"market": null

},

"defaultContacts": {

"relationsBag": null,

"sizmekContacts": [{

"type": "DefaultSizmekContact",

"id": 41016402804742,

"clientRefId": "4f23194a-87e2-5fed-0c57-f25e6e8c7c24",

"relationsBag": null,

"contactId": 1073741830,

"name": "FirstSizmekUser",

"campaignRole": "ClientServicesManager"

},

{

"type": "DefaultSizmekContact",

"id": 41016402804743,

"clientRefId": "783e6026-793b-4469-3259-fc3394475b4f",

"relationsBag": null,

"contactId": 1073741830,

"name": "FirstSizmekUser",

"campaignRole": "SalesManager"

}],

"campaignManagerContacts": [],

"creativeManagerContacts": [],

"creativeAccounts": [],

"siteContacts": []

},

"thirdPartyTracking": null,

"servingSettings": {

"type": "ServingSettings",

"collectBelowTheFold": false,

"dfCollectionID": null,

"pathLength": null,

"visibilityMinimumSurface": 0,

"visibilityMinimumDuration": 0,

"agencyVisibilityMinimumDuration": 0,

"agencyVisibilityMinimumSurface": 0,

"adChoicesCertificationProgramID": 0,

"adChoicesClickthroughURL": "",

"disableCookie": false,

"saveAdCookie": true,

"retargetingCookieWindow": 0,

"deviceIntelligenceTypeId": 0

},

"campaignSettings": {

"type": "CampaignSettings",

"hardStopMethod": "KEEP_SERVING_AS_USUAL",

"creativeManagerAccess": true,

"traffickingMode": "AdvancedMode",

"targetAudiencePriorityPolicy": "Server"

},

"privacy": {

"type": "Privacy",

"adMarker": {

"includeInAllAds": false,

"regulationProgram": "IAB_EU",

"markerClickthroughURL": null

},

"disableCookies": false

},

"video": {

"type": "Video",

"autoTranscode": true

}

},

"customFields": null,

"accessLevel": "Full"

}

}

Get a Site Section

Retrieves a specific site section.

Request Parameters

Name

Description

Type

Required

Notes

id

ID of the requested site

Integer

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/siteSections/global?from=0&max=250&order=asc&siteId=1073772236&sort=namehttps://developers.sizmek.com/hc/en-us/articles/360021102231

GET https://adapi.sizmek.com/sas/siteSections/global?from=0&max=250&order=asc&siteId=1073772236&sort=namehttps://developers.sizmek.com/hc/en-us/articles/360021102231

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the site details filtered by data ownership. If there is no site or data ownership, the request returns an empty response.

Example

"result":{

"type":"SiteSection",

"id":1073781162,

"relationsBag":{

"parents":{

"account":null,

"advertiser":null,

"brand":null,

"campaign":null,

"site":{

"id":1073767632,

"name":"01lQBLeljrTESTLiad"

}

},

"children":{

"advertisers":{

"count":0

},

"brands":{

"count":0

},

"campaigns":{

"count":0

},

"users":{

"count":0

}

},

"creativeAccountContact":false

},

"version":1517750561284161536,

"createdBy":1073741831,

"createdByName":"QaAdminUser",

"createdByAccount":1073741826,

"createdByAccountName":"QaAdminAccount",

"createdOn":1503825895058,

"lastUpdatedBy":1073741831,

"lastUpdatedByName":"QaAdminUser",

"lastUpdatedByAccount":1073741826,

"lastUpdatedByAccountName":"QaAdminAccount",

"lastUpdateOn":1517750561281,

"name":"P5FNXX5VrI42",

"siteId":1073767632,

"url":"",

"protocol":"HTTP",

"minZIndex":1

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the siteActivity Object

siteActivity Resource

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

String

Required

SiteActivity

id

ID of site activity.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdBy

ID of the user that created the site activity..

Long

Read-only

createdByName

Name of user that created the account.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (Date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of last update (Date epoch).

Long

Read-only

name

Name of activity.

Long

Required

activityType

Type of activity.

String

Required

advertiserId

ID of advertiser.

Integer

Read-only

rulesCount

Number of activity rules.

Integer

Read-only

tagManagersCount

Number of tag managers that use this site activity.

Integer

Read-only

conversionsCount

Number of conversions that use this site activity.

Integer

Read-only

tagManagerIds

Array of IDs for tag managers that use this site activity.

Array of integers.

Read-only

accessLevel

Internal.

Internal

Internal

nxtTagManagement

Flag that indicates whether the activity was migrated from MDX2.

Boolean

Read-only

defaultActivity

Type of default site activity.

Boolean

Read-only

View defaultActivity values

Other

Search

Social

siteActivityType

Custom site activity.

String

Optional

Object JSON Example

Example

{"result": {

"type": "SiteActivity",

"id": 1083859307,

"relationsBag": {

"parents": {

"account": {

"id": 1083749189,

"name": "Account1",

"internal": false

},

"advertiser": {

"id": 1083764657,

"name": "adv1"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1562146299841216512,

"createdBy": 1073741831,

"createdByName": "AdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "AdminAccount",

"createdOn": 1562146211329,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "AdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "AdminAccount",

"lastUpdateOn": 1562146299841,

"name": "siteActivityTest1",

"activityType": "Site",

"advertiserId": 1083764657,

"rulesCount": 0,

"tagManagersCount": 0,

"conversionsCount": null,

"tagManagerIds": [],

"accessLevel": "Full",

"nxtTagManagement": true,

"defaultActivity": false,

"siteActivityType": "Custom"

}

}

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example

"relationsBag": {

"parents": {

"account": {

"id": 16674,

"name": "[TEST] migrated account",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

Parents Object

Related Entities

Endpoints Using the Parents Object

Advertiser Resource

Campaign Resource

Placement Resource

Parents 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

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1072241834,

"name": "testing account",

"internal": false

}

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741822,

"name": "AAA"

}

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741833,

"name": "BBB"

}

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741831,

"name": "ccc"

}

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741853,

"name": "ddd"

}

Object JSON Example

Example

"parents": {

"account": {

"id": 1072241834,

"name": "testing account",

"internal": false

},

"advertiser": {

"id": 1073741822,

"name": "AAA"

},

"brand": {

"id": 1073741833,

"name": "BBB"

},

"campaign": null,

"site": null

},

Children Object

Related Entities

Endpoints Using the Children Object

Advertiser Resource

Campaign Resource

Placement Resource

Children 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

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only

Object JSON Example

Example

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the retargetingActivity Object

retargetingActivity Resource

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

String

Required

RetargetingActivity

id

ID of the entity.

Long

Read-only

Auto-generated, read-only value

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdBy

ID of the user who created the entity.

Long

Read-only

createdByName

Name of the user who created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (date epoch).

Long

Read-only

lastUpdatedBy

ID of the user who was the last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user who was the last to updated the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was the last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was the last to update the entity.

String

Read-only

lastUpdatedOn

Date of the last update (date epoch).

Long

Read-only

name

Name of entity.

String

Required

activityType

Type of activity.

String

Read-only

Retargeting

advertiserId

ID of the advertiser to which the retargeting activity belongs.

Long

Read-only

rulesCount

Number of activity rules defined for the retargeting activity.

Integer

Read-only

tagManagersCount

Number of tag managers that use this retargeting activity.

Integer

Read-only

conversionsCount

Number of conversions that use this retargeting activity.

Integer

Read-only

tagManagerIds

Array of IDs for tag managers that use this retargeting activity.

Array of integer

Read-only

accessLevel

Internal.

Internal

Internal

nxtTagManagement

Flag that indicates whether the activity was migrated from MDX2.

Boolean

Read-only

variableId

ID of the variable in the retargeting activity.

Long

Optional

variableName

Name of the variable.

String

Optional

Object JSON Example

Example

{

"result": {

"type": "RetargetingActivity",

"id": 1088886205,

"relationsBag": {

"parents": {

"account": {

"id": 2,

"name": "Testing Account",

"internal": true

},

"advertiser": {

"id": 1073758837,

"name": "Liz Horn Test Advertiser"

},

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"version": 1549984419555901402,

"createdBy": 389372,

"createdByName": "Jane Smith",

"createdByAccount": 2,

"createdByAccountName": "Testing Account",

"createdOn": 1549984419542,

"lastUpdatedBy": 389370,

"lastUpdatedByName": "Jane Smith",

"lastUpdatedByAccount": 2,

"lastUpdatedByAccountName": "Testing Account",

"lastUpdateOn": 1549984419542,

"name": "Classic Cars Retargeting",

"activityType": "Retargeting",

"advertiserId": 1073758832,

"rulesCount": 1,

"tagManagersCount": 1,

"conversionsCount": null,

"tagManagerIds": [

1073742895

],

"accessLevel": "Full",

"nxtTagManagement": true,

"variableId": null,

"variableName": null

}

}

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag 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

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example

"relationsBag": {

"parents": {

"account": {

"id": 16674,

"name": "[TEST] migrated account",

"internal": true

},

"advertiser": null,

"brand": null,

"campaign": null,

"site": null

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

Parents Object

Related Entities

Endpoints Using the Parents Object

Advertiser Resource

Campaign Resource

Placement Resource

Parents 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

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1072241834,

"name": "testing account",

"internal": false

}

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741822,

"name": "AAA"

}

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741833,

"name": "BBB"

}

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741831,

"name": "ccc"

}

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

{

"id": 1073741853,

"name": "ddd"

}

Object JSON Example

Example

"parents": {

"account": {

"id": 1072241834,

"name": "testing account",

"internal": false

},

"advertiser": {

"id": 1073741822,

"name": "AAA"

},

"brand": {

"id": 1073741833,

"name": "BBB"

},

"campaign": null,

"site": null

},

Children Object

Related Entities

Endpoints Using the Children Object

Advertiser Resource

Campaign Resource

Placement Resource

Children 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

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only

Object JSON Example

Example

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 1

},

"campaigns": {

"count": 231

},

"users": {

"count": 0

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

Related Entities

Endpoints Using the trackingOnly Placement Object

Placement Resource

Child Objects

customFields Object

mediaCostData Object

placementAnalyticsData Object

placementAttachmentData Object

servingAndCostData Object

tagBuilderParams Object

trackingOnly Placement 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

actualStartDate

First impression date (Date epoch).

Long

Read-only

allowHTML5DynamicExpansion

Enables the system to automatically detect the direction in which HTML5 expandable ads should expand during serving.

Boolean

Required

Required in a programmatic environment, where the location of the ad that will be displayed is not known in advance.

allowServingInAutoRefreshSite

Internal.

Internal

Internal

analyticsData

Contains a set of analytics metrics. Appears in a box on the placements page.

placementAnalyticsData Object

Read-only

View analyticsData fields

Status

Actual Start Date (GMT)

Total Impressions

Total Clicks

CTR

Delivery Rate

Last Served Impression (GMT)

Last Updated

Last Published

attached

Determines whether placement is attached to an ad.

Boolean

Read-only

bandwidth

Internal.

Internal

Internal

brandTimeZone

Time zone for brand. Used in the Delivery Group that is attached to the placement.

String

Read-only

View GMTOffset values

GMT_Minus_12

GMT_Minus_11

GMT_Minus_10

GMT_Minus_09

GMT_Minus_08

GMT_Minus_07

GMT_Minus_06

GMT_Minus_05

GMT_Minus_04

GMT_Minus_03

GMT_Minus_02

GMT_Minus_01

GMT

GMT_Plus_01

GMT_Plus_02

GMT_Plus_03

GMT_Plus_04

GMT_Plus_05

GMT_Plus_06

GMT_Plus_07

GMT_Plus_08

GMT_Plus_09

GMT_Plus_10

GMT_Plus_11

GMT_Plus_12

campaignId

Placement's campaign ID.

Long

Required

Searchable field for placement.

campaignName

Placement campaign name.

String

Read-only

Searchable field for placement.

cookieSyncType

Internal.

Internal

Internal

controlOverDelivery

Internal.

Internal

Internal

createdBy

ID of the user who created the placement.

Long

Read-only

createdByAccount

ID of the account of the user who created the placement.

Long

Read-only

createdByAccountName

Name of the account of the user who created the placement.

String

Read-only

createdByName

Name of the user who created the placement.

Long

Read-only

createdOn

Date and time on which the placement was created (Date epoch).

Long

Read-only

customFields

Custom fields display custom metadata that can be used, for example, as a token on click-throughs and 3rd party events, or in Sizmek reporting.

customFields Object

Optional

defaultTrackingAd

Internal.

Internal

Internal

deliveryRate

Internal.

Internal

Internal

disableCookies

Disable or enable cookies for placement.

Boolean

Optional

hardstop

Internal.

Internal

Internal

id

ID of the placement.

Long

Read-only

lastPublished

Last time placement was published.

Long

Read-only

Stored in Epoch time.

lastUpdatedBy

ID of the user who last updated the placement.

Long

Read-only

lastUpdatedByAccount

ID of the account of the user who last updated the placement.

Long

Read-only

lastUpdatedByAccountName

Name of the account of the user who last updated the placement.

String

Read-only

lastUpdatedByName

Name of the user who last updated the placement.

String

Read-only

lastUpdatedOn

Date and time on which the placement was last updated (Date epoch).

Long

Read-only

mobileApplicationAdEnabler

Type of mobile support .

String

Optional

View mobileApplicationAdEnabler values

AdMarvel

DFP

MOCEAN

MRAID

MRAID2

ORMMA

Custom

mode

Internal.

Internal

Internal

name

Name of the placement.

String

Required

packageId

Placement package ID.

Long

Optional

Searchable field for placement.

packageName

Name of package for this placement. Sizmek creates a default package if none exists for the placement.

String

Read-only

Searchable field for placement.

placementAdCount

Number of ads attached to placement.

Integer

Read-only

placementAttachmentData

Object that describes the placement's attachment.

placementAttachmentData Object

Read-only

placementDGData

Internal.

Internal

Internal

placementMV

Determines whether placement is mass version.

Boolean

Required

True when a placement is attached to a DCO ad.

placementType

Type of placement.

String

Required

TRACKING_ONLY

publisherTargetingIds

Media targeting audience assigned to placement.

Long

Optional

relationsBag

Internal.

relationsBag object

Internal

sectionId

ID of Site section where the placement will serve.

Long

Optional

sectionName

Name of Site section where the placement will serve.

String

Read-only

servingAndCostData

Serving and cost data for placement.

servingAndCostData Object

Required

siteId

Placement site ID.

Long

Required

Searchable field for placement and placement package.

specialInstructions

Internal.

String

Optional

status

Placement status.

String

Read-only

View placementStatus values

New

Published

Enabled

PendingIO

Live

Idle

Searchable field for placement.

tagBuilderParams

Parameters to build tag for placement.

tagBuilderParams Object

Optional

trackingAds

Internal.

Internal

Internal

type

Type of placement.

String

Required

VerificationTrackingPlacement

Object JSON Example

Example

{

"result":

{

"type": "TrackingOnlyPlacement",

"id": 1083933450,

"relationsBag": {

"parents": {

"account": {

"id": 1073741826,

"name": "QaAdminAccount",

"internal": false

},

"advertiser": {

"id": 1073745719,

"name": "AdverTestSLocator"

},

"brand": {

"id": 1073748479,

"name": "AdverTestSLocator"

},

"campaign": {

"id": 1073790880,

"name": "YoniCamp"

},

"site": {

"id": 1083765094,

"name": "01ActcKUQb"

}

},

"children": {

"advertisers": {

"count": 0

},

"brands": {

"count": 0

},

"campaigns": {

"count": 0

},

"users": {

"count": 0

}

},

"creativeAccountContact": false

},

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1534946069975,

"lastUpdatedBy": 1073741827,

"lastUpdatedByName": "BillingAppUser",

"lastUpdatedByAccount": 123,

"lastUpdatedByAccountName": null,

"lastUpdateOn": 1534946219108,

"name": "fasdfasdfadfs",

"campaignId": 1073790880,

"campaignName": "YoniCamp",

"siteId": 1083765094,

"sectionId": null,

"placementType": "TRACKING_ONLY",

"status": "Enabled",

"packageId": 1083930035,

"servingAndCostData": {

"mediaServingData": {

"units": null,

"hardStopMethod": "KEEP_SERVING_AS_USUAL",

"startDate": 1534896000000,

"endDate": 1536710399999

},

"mediaCostData": {

"type": "MediaCost",

"costModel": "CPM",

"rate": null,

"orderedUnits": null,

"actionType": null,

"customInteraction": null,

"conversionId": null,

"interactionId": null,

"ignoreOverDelivery": true,

"conversionActivityId": null

},

"placementLevel": true,

"isHardStop": false

},

"adsToAttach": null,

"selectedContacts": null,

"tagBuilderParams": {

"type": "TagBuilderParams",

"id": null,

"relationsBag": null,

"placementId": null,

"builderTagTypes": [

"AUTO_DETECT"

],

"siteServing": {

"secureServingProtocol": "HTTP",

"lineIdToken": "1",

"customToken": "FALK",

"zipCodeToken": null,

"countryToken": null,

"serverDomainName": "bs.serving-sys-int.com",

"cacheBustingToken": "+Ads_Timestamp+",

"publisherCustomParam": "o1xA5EClYY",

"minZIndex": "1",

"impTracking": "qWRYt28YpS",

"clickTracking": "26Iy_vSPBO",

"escapeNoScript": true,

"generateMultipleTags": true,

"generateIMGTag": true,

"firstPartyAdIdToken": null,

"disableCookies": false,

"generateKeywords": false

},

"placementType": null,

"exposeKwTag": null

},

"servingEnabled": false,

"analyticsData": null,

"sectionName": null,

"placementDGData": [

],

"lastPublished": null,

"adEnableBaseUrl": "",

"placementMV": false,

"testImpressions": 1000,

"targetingValue": "",

"disableCookies": false,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"controlOverDelivery": false,

"collectWebPage": false,

"impressionForWholePlacement": -1,

"flightTargetingInfo": "",

"mobileApplicationAdEnabler": "AdMarvel",

"supportMobileApplications": false,

"pluId": 0,

"placementAdCount": 1,

"placementAttachmentData": {

"attachedToUntargeted": false,

"targetAudienceIds": [

]

},

"packageName": "PKG::fasdfasdfadfs",

"actualStartDate": null,

"allowHTML5DynamicExpansion": false,

"brandTimeZone": "GMT_Plus_03",

"customFields": null,

"deliveryRate": null,

"publisherTargetingIds": null,

"mode": "ENABLED",

"specialInstructions": null,

"cookieSyncType": "INHERIT_FROM_PLACEMENT",

"allowServingInAutoRefreshSite": false,

"defaultTrackingAd": {

"type": "TrackingPixelAd",

"id": 1084399023,

"relationsBag": null,

"version": 1534946069960785920,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1534946069941,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1534946069957,

"name": "fasdfasdfadfs_1084399021",

"masterAdId": 1084399021,

"changed": true,

"adStatus": "NEW",

"enabled": true,

"adFormat": "TRACKING_PIXEL_AD",

"adFormatId": 16,

"adFormatName": "Tracking Pixel",

"accountId": 1073741826,

"accountName": "QaAdminAccount",

"placementId": 1083933450,

"placementName": "fasdfasdfadfs",

"placementType": "TRACKING_ONLY",

"siteId": 1083765094,

"siteName": "01ActcKUQb",

"adAssignmentData": {

"type": "AdAssignmentData",

"accountId": 1073741826,

"accountName": "QaAdminAccount",

"advertiserId": 1073745719,

"advertiserName": "AdverTestSLocator",

"brandId": 1073748479,

"brandName": "AdverTestSLocator",

"campaignId": 1073790880,

"campaignName": "YoniCamp"

},

"mainClickthrough": null,

"adURLs": null,

"pricingSize": 0,

"overallSize": 0,

"initialSize": 0,

"width": 1,

"height": 1,

"dimensions": "1x1",

"templateScriptName": "Tracking",

"urlTokens": null,

"minAudioVersion": 0,

"fourthPartyTag": "",

"adChoicesStatus": true,

"adChoicesLocation": null,

"qaStatus": "NOT_SUBMITTED",

"numberOfPlacementAds": 0,

"overallNumberOfPlacementAds": 0,

"servingMethod": null,

"analyticsData": {

"impressions": null,

"clicks": null,

"lastUpdated": null,

"ctr": null,

"actualStartDate": null

},

"analyticsSettings": null,

"customFields": null,

"massVersioning": false,

"usedAsTemplate": false,

"unSavedTemplateAd": false,

"adTemplateId": null,

"feedEnabled": null,

"feedStatus": null,

"enableTimeBasedServing": false,

"servingTimeZoneType": null,

"videoAudioAdAssetData": [

],

"adFeatures": [

],

"firstPartyAdId": "",

"firstPartyAdName": null,

"default": true,

"containsNonWorkspaceAssets": true,

"native": false,

"trackingType": "ImpressionsAndClicks"

},

"hardStop": false,

"asyncMode": false,

"bandwidth": false,

"adBlocking": false,

"supportMobileApplication": false,

"attached": true,

"trackingAds": [

{

"type": "TrackingPixelAd",

"id": 1084399022,

"relationsBag": null,

"version": 1534946069959606272,

"createdBy": 1073741831,

"createdByName": "QaAdminUser",

"createdByAccount": 1073741826,

"createdByAccountName": "QaAdminAccount",

"createdOn": 1534946069936,

"lastUpdatedBy": 1073741831,

"lastUpdatedByName": "QaAdminUser",

"lastUpdatedByAccount": 1073741826,

"lastUpdatedByAccountName": "QaAdminAccount",

"lastUpdateOn": 1534946069955,

"name": "fasdfasdfadfs_null",

"masterAdId": 1084399021,

"changed": true,

"adStatus": "NEW",

"enabled": true,

"adFormat": "TRACKING_PIXEL_AD",

"adFormatId": 16,

"adFormatName": "Tracking Pixel",

"accountId": 1073741826,

"accountName": "QaAdminAccount",

"placementId": 1083933450,

"placementName": "fasdfasdfadfs",

"placementType": "TRACKING_ONLY",

"siteId": 1083765094,

"siteName": "01ActcKUQb",

"adAssignmentData": {

"type": "AdAssignmentData",

"accountId": 1073741826,

"accountName": "QaAdminAccount",

"advertiserId": 1073745719,

"advertiserName": "AdverTestSLocator",

"brandId": 1073748479,

"brandName": "AdverTestSLocator",

"campaignId": 1073790880,

"campaignName": "YoniCamp"

},

"mainClickthrough": {

"type": "MainClickthrough",

"id": null,

"relationsBag": null,

"url": "",

"targetWindowType": null,

"showAddressBar": false,

"showMenuBar": false,

"closeAllAdParts": false

},

"adURLs": [

{

"type": "ThirdPartyURL",

"id": 2083150611824,

"relationsBag": null,

"url": "https://www.balls.com",

"urlType": "CLICK_TRACKING",

"enabled": false,

"urlSource": "AD",

"externalId": "1",

"uniqueIdentifier": "CLICK_TRACKING_1",

"customScriptId": null,

"disableServing": false

},

{

"type": "ThirdPartyURL",

"id": 2083150611823,

"relationsBag": null,

"url": "http://www.gogole.com",

"urlType": "IMPRESSION_TRACKING",

"enabled": false,

"urlSource": "AD",

"externalId": "1",

"uniqueIdentifier": "IMPRESSION_TRACKING_1",

"customScriptId": null,

"disableServing": false

}

],

"pricingSize": 0,

"overallSize": 0,

"initialSize": 0,

"width": 1,

"height": 1,

"dimensions": "1x1",

"templateScriptName": "Tracking",

"urlTokens": null,

"minAudioVersion": 0,

"fourthPartyTag": "",

"adChoicesStatus": true,

"adChoicesLocation": null,

"qaStatus": "NOT_SUBMITTED",

"numberOfPlacementAds": 0,

"overallNumberOfPlacementAds": 0,

"servingMethod": null,

"analyticsData": {

"impressions": null,

"clicks": null,

"lastUpdated": null,

"ctr": null,

"actualStartDate": null

},

"analyticsSettings": null,

"customFields": null,

"massVersioning": false,

"usedAsTemplate": false,

"unSavedTemplateAd": false,

"adTemplateId": null,

"feedEnabled": null,

"feedStatus": null,

"enableTimeBasedServing": false,

"servingTimeZoneType": null,

"videoAudioAdAssetData": [

],

"adFeatures": [

],

"firstPartyAdId": "",

"firstPartyAdName": "",

"default": false,

"containsNonWorkspaceAssets": true,

"native": false,

"trackingType": "ImpressionsAndClicks"

}

]

}

}

Contact Us

If you still need help, please contact Sizmek Support (< [email protected] >) to open a ticket.

If you have suggestions about the content in this article, please contact the Sizmek Documentation team at < [email protected] >.

placementAnalyticsData Object

placementAnalyticsData Object Definition

Note

Note: The Required column includes the following values: