Release Notes

Please find below a list of notes related to the releases of the Revive Adserver REST API software.

Version 5.1.0 – released April 15, 2022

This version ensures that the Revive Adserver REST API is compatible with the changes introduced in Revive Adserver v5.4.x with regard to password functionality. While creating a new username using the Revive Adserver REST API, with Revive Adserver 5.4 or higher, it is now possible to omit the password in the body. Doing so will trigger Revive Adserver to send the “welcome new user” email. This email informs the new user that their username has been created, and what that username actually is. It also contains a link that the recipient can click, in order to enter their own initial password.

This version of the Revive Adserver REST API also contains new functionality that enables setting user permissions for any newly created or existing user.

The new functionality is described in great detail on the documentation page.

This version has the following known issue(s):

Version 5.0.2 – released March 9, 2021

This version fixes 1 issue that was discovered by our developers:

  • It was not possible to add a new banner via the REST API.

This version has the following known issue(s):

Version 5.0.1 – released February 19, 2021

This version fixes 2 issues that were discovered by our developers:

  • A PHP warning that would show up in the debug.log file of the Revive Adserver installation, whenever the API output was longer than 4 kilobytes.
  • An issue that might occur when trying to create or modify a campaign, and using a ‘revenue’ value with no decimals. This only occurred with certain client application types. The REST API might interpret the value it received as a string instead of a number.

This version has the following known issue(s):

Version 5.0.0 – released February 20, 2019

This version introduces the following enhancement:

  • a Paging feature, which can be used to retrieve statistics for long date ranges or large sets of objects in multiple ‘pages’ each consisting of a fixed number of response elements.

This version has the following known issue(s):

Version 4.5.0 – released November 28, 2018

This version introduces the following enhancement:

  • The getUser feature, which was missing from the code, has been added.

This version has the following known issue(s):

Version 4.4.0 – released October 22, 2018

This version introduces the following two enhancements:

  • It is now possible to retrieve all statistics with an hourly breakdown (in addition to daily, which was already available). Make sure to study the technical requirements for this enhancement.
    Update April 23, 2019: the enhancements needed to get the core Revive Adserver software to support the retrieval of hourly statistics using the REST API have been included in version 4.2.0 of the core Revive Adserver software.

This version has the following known issue(s):

Version 4.3.0 – released May 28, 2018

This version introduces the following improvement:

  • It is now possible to remove the delivery rules previously applied to a banner. To do this, call the setBannerTargeting method and pass it an empty array.

This version also has a bug fix.

  • In earlier versions, requesting the conversion statistics of a campaign, for a date range that actually had at least one conversion, would return a 500 error. This has now been fixed.

This version has the following known issue(s):

Version 4.2.0 – released July 12, 2017

This version introduces the following new feature:

  • It is now possible to retrieve the asynchronous javascript tag (async tag) that was introduced in Revive Adserver v3.2. See the Zone management documentation page for all details.

This version contains the following bug fixes:

  • The getBannerListByZoneID method didn’t work correctly for banners that were linked individually to a zone, all it returned were the banners that were linked to the zone by their parent campaign(s). This has now been fixed.
  • The fix for the setBannerTargeting method has been revised to properly load the default language file from the core Revive Adserver software instead of the temporary work-around that was introduced in an earlier release.

This version has the following known issue(s):

There are also several documentation updates and enhancements.

Version 4.1.0 – released March 21, 2017

Even though this version doesn’t have any new features, we still decided to make it a point release because there are several breaking changes (see below).

This version has the following bugs fixed:

  • The output of the getCampaignListByZoneID method was incorrect
  • The output of the getZoneListByCampaignID method was incorrect
  • The setBannerTargeting method was unable to set date/time related delivery limitations

This version has the following breaking changes:

  • The getAdvertiserListByAgencyID method now returns an unnamed array of all advertisers belonging to an agency
  • The getPublisherListByAgencyID method now returns an unnamed array of all publishers (websites) belonging to an agency
  • The getZoneListByPublisherID method now returns an unnamed array of all zones belonging to a publisher
  • The getCampaignListByZoneID method now returns an unnamed array of all campaigns linked to a zone
  • The getBannerListByZoneID method now returns an unnamed array of all banners linked to a zone
  • The getZoneListByCampaignID method now returns an unnamed array of all zones linked to a campaign

This version has the following known issues:

  • It is not possible to set the end date of a campaign to “don’t expire”.
    This is actually a bug in Revive Adserver itself that will be fixed in their next release, see revive-adserver/revive-adserver#768

There are also several documentation updates and enhancements.

Version 4.0.0 – released December 4, 2016

This version has the following new features:

  • Feature to request all information of all zones linked to a campaign
  • Feature to request all information of all campaigns linked to a zone
  • Feature to request all information of all banners linked to a zone

This version has the following improvements:

  • API now returns all details of newly created entities, instead of just {OK}
  • readability of JSON output when requesting information about existing entities

This version has the following bug fixes:

  • Campaign end dates ignored when adding or changing campaigns
  • Unable to link or unlink a campaign to/from a zone

This version has the following known issues:

  • It is not possible to set the end date of a campaign to “don’t expire”.
    This is actually a bug in Revive Adserver itself that will be fixed in their next release, see revive-adserver/revive-adserver#768

There are also several documentation updates and enhancements.

Version 1.4.2 – released February 2013

  • Our initial release of this software, originally as “OpenX Source REST API” after acquiring the software from the original developer in December 2012;
  • Later renamed to Revive Adserver REST API after the release of Revive Adserver in September 2013.