Skip to main content

GET All Ad Breaks

Overview


The following table contains important information about the GET method in regards to receiving all the adbreaks for specific ad schedules.

GET Adbreaks For Specific Ad Schedules
MethodGET
URL or Endpoint/api/projects/projectId/ad-schedules/adScheduleId/ad-breaks
HeadersAuthorization
ParametersadScheduleId, projectId, api-version
BodyNot Applicable

The description of the URL parameter is as follows:

Parameter NameMandatoryTypeDescription
adScheduleIdYesstringThe id of ad schedules.
projectIdYesstringThe id of the project.
api-versionNostringThe correct api version to use.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": [
{
"id": 0,
"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,
"adBreakType": {
"id": 0,
"name": "string"
},
"midrollType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string",
"icon": "string"
},
"distributionMethodType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string"
},
"adBreakSettings": [
{
"adBreakId": 0,
"fromSecond": 0,
"toSecond": 0,
"adsNumber": 0,
"percentages": [
0
]
}
],
"breakTimingType": {
"id": 0,
"name": "string"
},
"waterfallTags": [
{
"id": 0,
"adBreakId": 0,
"waterfallTagUrl": "string"
}
]
}
],
"resultInfo": "string",
"statusCode": 0
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)Id of the ad break.
adBreakTypeIdinteger($int32)Id of the ad break type.
adScheduleIdstringId of the ad schedule.
breakTimingTypeIdinteger($int32)Id of the break timing type.
breakTiminginteger($int32)The break timing of the ad.
liveVideoPrerollsNrinteger($int32)The number of live video prerolls.
midrollTypeIdinteger($int32)Id of midroll type.
secondsToRepeatstringSeconds for the ad to repeat.
protectFirstSecondsstringProtecting the first seconds.
protectLastSecondsstringProtecting the last seconds.
distributionMethodTypeIdinteger($int32)Id of the distribution method type.
nonLinearOverlayAdboolIndictaes whether ads that appear before, n between or after the video content appear.
skipableAfterSecondsboolIndictaes whether the ad is skipable after a certain number of seconds.
skipableAfterSecondsNrinteger($int32)The number of skipable ads after a certain number of seconds.
adBreakTypearray[Object]Returns the response object.
idinteger($int32)Id of the ad break type.
namestringThe name of the ad break type.
midrollTypearray[Object]Returns the response object.
idinteger($int32)Id of the midroll type.
namestringThe name of the midroll type.
valuestringValue of the midroll.
descriptionstringDescription of the midroll.
iconstringIcon of the midroll.
distributionMethodTypearray[Object]Returns the response object.
idinteger($int32)Id of the distribution method type.
namestringThe name of the distribution method type.
valuestringValue of the distribution method.
descriptionstringDescription of the distribution method.
adBreakSettingsarray[Object]Returns the response object.
adBreakIdinteger($int32)Id of the ad break in settings.
fromSecondinteger($int32)Second when ad begins.
toSecondinteger($int32)Second when ad ends.
adsNumberinteger($int32)The number of eds.
percentagesarray[Object]Returns the response object.
breakTimingTypearray[Object]Returns the response object.
idinteger($int32)Id of the break timing type.
namestringThe name of the break timing type.
waterfallTagsarray[Object]Returns the response object.
idinteger($int32)Id of the waterfall tag.
adBreakidinteger($int32)Id of the ad break.
waterfallTagUrlstringThe url of the waterfall tag.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

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