Microservice to add ad and zone data, and to forecast rate of impressions for all ads in a given zone. Forecasting the rate of impressions for each ad in a zone is calculated by:

1. keep track of the total daily ad impressions allowed for the zone
2. ads for the zone are sorted by priority
3. then for each ad:
4. calculate the number of days that the ad runs using it's start and end date.
5. calculate the number of impressions per day the ad can run to achieve it's goal impression.
6. if the total daily ad impressions is greater than zero, and less than the number of daily ad impressions for an ad, the total daily ad impression are divided by the number of daily ad impressions for an ad to get the impression rate for that ad.
7. if the total daily ad impressions is greater than the number of daily ad impressions for an ad, the daily ad impressions for the ad is subtracted from the total daily ad impression for a new remaining total daily ad impression for the zone and the ad impression rate is set to 100%.
8. if the total daily ad impressions is 0 then the ad impression rate is set to 0%.

Compile or download the adserver.jar.
cd to the directory where the adserver.jar is.
On the command line type: java -jar adserver.jar

Requires Java 1.7 JDK or higher; may require a fee account on Oracle.

To compile, be sure to have Apache Maven 3.5 installed.
cd to the directory where the adserver pom.xml is.
Run the following from the command line: mvn clean install.
The jar file will be located in a directory called 'target'.

Add Ad Data

To add ad data supply the following URL with a JSON object containing the ad data to add.

curl -H "Content-Type: application/json" -d "<JSON ad object, see below>" -X POST http://localhost:8080/adserver/services/add

{ 
	id: number, 
	zone: number, 
	start: 'YYYY-MM-DD', 
	end: 'YYYY-MM-DD', 
	creative: string,
	priority: number (greater than -1), 
	goal: number (greater than 0) 
}

Add Zone Data

To add zone data supply the following URL with a JSON object containing zone data to add.

curl -H "Content-Type: application/json" -d "<JSON zone object, see below>" -X POST http://localhost:8080/adserver/services/add/zone

{ 
	id: number, 
	title: string, 
	impressions: number (greater than 1) 
}

Bulk Adding

The micro service supports adding multiple zones and ad by encapulating the JSON object in a JSON array and encapulating that array in a JSON object such as:

{ 
	items: [{}, {}, {}...]
}

Forecast

The micro service supports calculating impression forecasts for a specific zone using the following URL.

http://localhost:8080/adserver/services/forecast/<ZONE_ID>?toDate="YYYY-MM-DD"

Note: "toDate is optional", if omitted today's date will be used.

Result will be a JSON array of JSON objects, each object reflects the data for a specific ad for a given zone id.

{
	"items":[
		{
			"adId":number,
			"impressionRate":number (between 0 and 1 inclusive),
			"adZoneId":number
		},
		...
	]
}

Error

Errors generate a JSON object in the form of:

{
	"code":number,
	"error":string (Error Name),
	"message":string
}

Error Codes

2018-04-02 (0.1.000):

• Initial release.