In order to allow to deliver creatives in your newsletters and emails AdSpirit supports newsletter placement types. In order to use these, please enable the Newsletter Module under

Settings > (Global settings) > AdServer Module.

Once enabled you can create a newsletter placement:

Types of integration

Newsletter placement behave like normal banner placement, the only difference being that you get direct URLs or API interfaces instead of script or IFrame codes.

There are two options available to you: 

Both species have advantages and disadvantages which we would like to list here:

Direct integration (manual)

In this case, you directly select the link between the placement and the creative and receive a view and click URL that is explicitly intended for this creative. You integrate the data (manually) into your newsletter. Please note:

• The URLs do not generate a rotation but always explicitly show this one creative.
• Restrictions such as targeting, frequency capping, daily budget etc. do not apply; the creative is also displayed if these restrictions would apply.
• Once a mail has been sent, it no longer changes but always looks the same, even if the user views it later.
• It is possible to exchange the graphic and target URL, please change the data stored in the creative.

API Integration (Automatic)

The API integration offers more flexibility, but also means more effort for setup. Before a newsletter is sent, the newsletter system must query the data from our API, i.e. the e-mail tool asks the ad server for a suitable creative. The AdServer or API checks whether campaigns are active and responds with a suitable creative if necessary. This response must then be integrated into the e-mail and the e-mail sent. Please note:

• The API rotates campaigns, i.e. for each request made to the API it is checked again whether (still) campaigns are available.
• The API takes targetings, daily limits, frequency cappings and other restrictions into account, i.e. there may also be cases where no creative is returned.
• If the API is queried by a server system, certain things may not work or work differently because the server is recognized as one and the same "visitor". Especially geotargeting (not possible due to the IP of the server), browser, operating system and device type (not possible due to the "browser string" of the server) are not possible.
• If the API is queried by a server system, the server is perceived as a visitor, a set frequency capping therefore has a direct effect.
• An advertising material returned by the API that is packed into a newsletter and then sent does not change after it is sent.

Another possibility:

You can get a pure, uncoded ad space code (no XML, no JSON) of the currently booked ad space by calling the parameter API with the parameter "output=plain".

Daten von der Mail-API abfragen

There are three different output formats for querying the data from the Mail API: XML, JSON and JSONP. The output data varies depending on the output format and the stored creative.

Example XML Format / HTML-Creative:

Example JSON Format / HTML-Creative:

Example XML Format / Banner-Creative:

Example JSON Format / Banner-Creative:

Implementation of Targtings via Mail-API

If you want to implement targetings via Mail-API it is recommended to contact the API for each mail to be sent. You can then play out an individual campaign for each mail via parameter targeting, for example.

Example: You know that the mail recipient is male or female. Then you could transfer &sex=m or &sex=w to the mail API and create a corresponding targeting within the campaigns to deliver different advertising media to the user groups.

Implementation of Cappings via Mail-API

Since the time of sending the mail and the view of the mail (creative view) can be very far apart, in this case the mail API can only be used insufficiently to achieve a daily maximum or campaign maximum of views or clicks. To ensure this, the AdServer would need to know at the time the mail is sent whether it creates a view or not. Since this is not predictable, the best alternative is to use frequency cappings as a workaround for maximum views per day:

If you only want to send a maximum of 100 mails per day with a certain banner, set the frequency capping of the campaign to "100 per 24h". Since the mail server is regarded as the same visitor, frequency capping is applied to it and the mail server returns this campaign a maximum of 100 times a day.

Bitte beachten Sie

Please note that once e-mails have been sent, they can no longer be changed. At the same time, a mail can be opened and clicked as often as you like. This means that a single recipient can open the mail several times and generate several views and clicks - even long after the mail has been sent and the campaign has ended.

Please note that email clients (Outlook, Firebird and so on) will not execute JavaScript or IFrames. Therefore any html-creative should not contain any of this code.