Skip to main content

POST AdSchedule

Overview


The following table contains important information about the POST method in regards to posting an Ad Schedule.

POST AdSchedule
MethodPOST
URL or Endpoint/api/projects/projectId/ad-schedules
HeadersAuthorization
ParametersprojectId
BodyCheck the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"name":"New Ad Schedule - VAST",
"adSeenOnSubsequentVisitOptionId":null,
"timeBetweenAds":0,"startOnPlaylistItem":1,
"repeatOnInterval":1,
"adManagerId":1,
"adManager":
{
"id":1,
"Value":"VAST"
},
"enableBidding":false,
"biddingTemplatePublicId":null,
"vmapAdTag":"",
"adBreaks":[
{
"adBreakType":
{
"id":1,
"name":"Preroll"
},
"adBreakTypeId":1,
"breakTiming":null,
"breakTimingType":
{
"id":1,
"name":"Seconds into Video"
},
"breakTimingTypeId":1,
"nonLinearOverlayAd":true,
"skipableAfterSecondsNr":null,
"isDeleted":false,
"isVerified":true,
"waterfallTags":[
{
"id":1038,
"waterfallTagUrl":"https://preroll.com",
"adBreakId":1038,
"isDeleted":false
}],
"id":1038
}]
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Field NameTypeDescription
namestringThe name of the ad schedule.
adSeenOnSubsequentVisitOptionIdinteger($int32)Indicates that the video should play the preroll break.
timeBetweenAdsinteger($int32)Indicates the time ads should have between each other.
startOnPlaylistIteminteger($int32)Indicates on which playlist item the ad schedule should start
repeatOnIntervalinteger($int32)Indicates the interval at which the ad schedules should repeat.
adManagerIdinteger($int32)The id of the ad manager type.
adManagerObjectReturns the ad manager of the ad schedule.
idinteger($int32)The id of the ad manager.
ValuestringThe value of the ad manager,
enableBiddingboolIndicates whether bidding is enabled or disabled.
biddingTemplatePublicIdinteger($int32)The id of the bidding template.
vmapAdTagstringThe tag of the VMAP ad.
adBreaksarray[Object]Returns the ad breaks as an array of objects.
adBreakTypeObjectReturns the ad break type.
idinteger($int32)Id of the ad break type.
namestringName of the ad break type.
adBreakTypeIdinteger($int32)The ID of the ad break type.
breakTimingObjectThe break-timing object.
breakTimingTypeObjectReturns the break timing type.
idinteger($int32)Id of the break timing option.
namestringName of the break timing option.
breakTimingTypeIdinteger($int32)The ID of the break timing type.
nonLinearOverlayAdboolIndicates whether the ad overlay is nonlinear.
skipableAfterSecondsNrinteger($int32)Indicates after how many seconds can the ad be skipped.
isDeletedboolIndicates whether the ad schedule is deleted
isVerifiedboolIndicates whether the ad schedule is verified.
waterfallTagsarray[Object]Returns the waterfall tags as an array of objects.
idinteger($int32)Id of the waterfall tag.
waterfallTagUrlstringThe URL of the waterfall tag.
adBreakIdinteger($int32)The id of the ad break.
isDeletedboolIndicates whether the waterfall tag is deleted.
idinteger($int32)Id of the ad schedule.

Response

{
"success": true,
"errors": [],
"messages": [
"AddSchedule with Id smyrfdkj was added!"
],
"result": {
"adManagerId": 1,
"vpaidModeOptionId": null,
"publicId": "smyrfdkj",
"name": "New AdSchedule - VAST",
"adSeenOnSubsequentVisitOptionId": null,
"vmapAdTag": "",
"timeBetweenAds": 0,
"startOnPlaylistItem": 1,
"repeatOnInterval": 1,
"enableBidding": false,
"biddingTemplatePublicId": null,
"vpaidModeOption": null,
"adSeenOnSubsequentVisitOption": null,
"adManager": {
"id": 1,
"Value": "VAST"
},
"biddingTemplate": null,
"adBreaks": [
{
"id": 1039,
"adBreakTypeId": 1,
"breakTimingTypeId": 1,
"breakTiming": null,
"nonLinearOverlayAd": true,
"skipableAfterSeconds": false,
"skipableAfterSecondsNr": null,
"adBreakType": {
"id": 1,
"name": "Preroll"
},
"breakTimingType": {
"id": 1,
"name": "Seconds into Video"
},
"waterfallTags": [
{
"id": 1039,
"adBreakId": 1039,
"waterfallTagUrl": "https://preroll.com"
}
]
}
]
},
"resultInfo": null,
"statusCode": 200
}

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.
adManagerIdinteger($int32)The id of the ad manager type.
vpaidModeOptionIdinteger($int32)The id of the VPAID mode option.
publicIdstringThe id of the ad schedule.
namestringThe name of the ad schedule.
adSeenOnSubsequentVisitOptionIdinteger($int32)Indicates that the video should play the preroll break.
vmapAdTagstringThe tag of the VMAP ad.
timeBetweenAdsinteger($int32)Indicates the time ads should have between each other.
startOnPlaylistIteminteger($int32)Indicates on which playlist item the ad schedule should start
repeatOnIntervalinteger($int32)Indicates the interval at which the ad schedules should repeat.
enableBiddingboolIndicates whether bidding is enabled or disabled.
biddingTemplatePublicIdinteger($int32)The id of the bidding template.
vpaidModeOptionObjectReturns the VPAID mode option.
adSeenOnSubsequentVisitOptionObjectReturns the subsequent visit option of the ad schedule.
adManagerObjectReturns the ad manager of the ad schedule.
idinteger($int32)The id of the ad manager.
ValuestringThe value of the ad manager,
biddingTemplateObjectReturns the bidding template as an object.
adBreaksarray[Object]Returns the ad breaks as an array of objects.
idinteger($int32)ID of the ad break.
adBreakTypeIdinteger($int32)The ID of the ad break type.
breakTimingTypeIdinteger($int32)The ID of the break timing type.
breakTimingObjectReturns the break-timing object.
nonLinearOverlayAdboolIndicates whether the ad overlay is nonlinear.
skipableAfterSecondsboolIndicates whether the ad is skippable after a set number of seconds.
skipableAfterSecondsNrinteger($int32)Indicates after how many seconds can the ad be skipped.
adBreakTypeObjectReturns the ad break type.
idinteger($int32)Id of the ad break type.
namestringName of the ad break type.
breakTimingTypeObjectReturns the break timing type.
idinteger($int32)Id of the break timing option.
namestringName of the break timing option.
waterfallTagsarray[Object]Returns the waterfall tags as an array of objects.
idinteger($int32)Id of the waterfall tag.
adBreakIdinteger($int32)The 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