POST Ad Break

Overview

---

The following table contains important information about the POST method in regards to the managing process.

POST Ad Break
Method	POST
URL or Endpoint	/api/projects/projectId/ad-schedules/adScheduleId/ad-breaks
Parameters	projectId, adScheduleId, api-version
Body	Check the request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	No	string	Unique id of the project.
adScheduleId	Yes	string	The id of ad schedules.
api-version	No	string	The correct api version to use.

Request Body

{
  "adBreakTypeId": 0,
  "adScheduleId": "string",
  "breakTimingTypeId": 0,
  "breakTiming": 0,
  "liveVideoPrerollsNr": 0,
  "midrollTypeId": 0,
  "secondsToRepeat": 0,
  "protectFirstSeconds": 0,
  "protectLastSeconds": 0,
  "distributionMethodTypeId": 0,
  "nonLinearOverlayAd": true,
  "skipableAfterSeconds": true,
  "skipableAfterSecondsNr": 0,
  "adBreakSettings": [
    {
      "adBreakId": 0,
      "fromSecond": 0,
      "toSecond": 0,
      "adsNumber": 0,
      "percentages": [
        0
      ]
    }
  ],
  "waterfallTags": [
    {
      "id": 0,
      "adBreakId": 0,
      "waterfallTagUrl": "string"
    }
  ]
}

Information about the fields that appear when you receive the response are displayed in the table below.

Parameter Name	Mandatory	Type	Description
adBreakTypeId	integer($int32)	Id of the ad break type.
adScheduleId	string	Id of the ad schedule.
breakTimingTypeId	integer($int32)	Id of the break timing type.
breakTiming	integer($int32)	The break timing of the ad.
liveVideoPrerollsNr	integer($int32)	The number of live video prerolls.
midrollTypeId	integer($int32)	Id of midroll type.
secondsToRepeat	string	Seconds for the ad to repeat.
protectFirstSeconds	string	Protecting the first seconds.
protectLastSeconds	string	Protecting the last seconds.
distributionMethodTypeId	integer($int32)	Id of the distribution method type.
nonLinearOverlayAd	bool	Indictaes whether ads that appear before, n between or after the video content appear.
skipableAfterSeconds	bool	Indictaes whether the ad is skipable after a certain number of seconds.
skipableAfterSecondsNr	integer($int32)	The number of skipable ads after a certain number of seconds.
adBreakSettings	array[Object]	Returns the response object.
adBreakId	integer($int32)	Id of the ad break in settings.
fromSecond	integer($int32)	Second when ad begins.
toSecond	integer($int32)	Second when ad ends.
adsNumber	integer($int32)	The number of eds.
percentages	array[Object]	Returns the response object.
waterfallTags	array[Object]	Returns the response object.
id	integer($int32)	Id of the waterfall tag.
adBreakid	integer($int32)	Id of the ad break.
waterfallTagUrl	string	The url of the waterfall tag.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed