COVERITLIVE API - EVENT/UPDATE (V. 2.0)

The Request

The Event Update method allows you to update event data once an event has been created. This version supports only preroll ad updates. Once set up you will be able to add preroll videos to your events (ads that run prior to a viewer gaining access to the content of the event). These updates are specific to an event, but can be called numerous times if you wish to change ad configuration during an event.

NOTE: This method is only available to users who have signed up for one of our Custom Plans. Please contact Customer Service for additional information.

Ad Code

In order to function correctly, the page called by the iframe must perform the following actions:

Start the ad. the page must call the startCustomAd.html file. The closebutton is optional, but can be used to override the setting provided when building the event.

Sample code for starting an ad:

// this method would be called from the onload event
function startAd() {
	var closebutton = "y";
	var i = document.createElement("iframe");
	i.style.display = "none";
	i.src = "http://cdnsl.coveritlive.com/startCustomAd.html?closebutton=" + closebutton;
	document.body.appendChild(i);
}

Close the ad. Ads can be removed using 2 methods:

1. Include a close button and the user can remove the ad at any time. This is ideal for static image ads.
2. Do not include a close button and have the page call the closeCustomAd.html file, which will close the ad for the viewer. Closing the ad using this method is ideal for video ads, which you may want the viewer to watch in their entirety before closing.

Sample code for closing an ad:

// this method would be called at the point in time you wish to close the ad
function closeAd() { 
	var i = document.createElement("iframe");
	i.style.display = "none";
	i.src = "http://cdnsl.coveritlive.com/closeCustomAd.html"
	document.body.appendChild(i);
}

The Response

There is no extra data returned from a event/update request, so the response has the same fields as a general response.

Example response to a successful content/create request:

{
	"result": "success",
	"message": "true",
	"type": "content",
	"action": "create",
	"version": 2
}

event/update Error Responses

A variety of error responses (in addition to the common error responses) to event/update requests, and instructions on how to rectify them: