POST AdSchedule

Overview

---

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

POST AdSchedule
Method	POST
URL or Endpoint	/api/projects/projectId/ad-schedules
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique 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 Name	Type	Description
name	string	The name of the ad schedule.
adSeenOnSubsequentVisitOptionId	integer($int32)	Indicates that the video should play the preroll break.
timeBetweenAds	integer($int32)	Indicates the time ads should have between each other.
startOnPlaylistItem	integer($int32)	Indicates on which playlist item the ad schedule should start
repeatOnInterval	integer($int32)	Indicates the interval at which the ad schedules should repeat.
adManagerId	integer($int32)	The id of the ad manager type.
adManager	Object	Returns the ad manager of the ad schedule.
id	integer($int32)	The id of the ad manager.
Value	string	The value of the ad manager,
enableBidding	bool	Indicates whether bidding is enabled or disabled.
biddingTemplatePublicId	integer($int32)	The id of the bidding template.
vmapAdTag	string	The tag of the VMAP ad.
adBreaks	array[Object]	Returns the ad breaks as an array of objects.
adBreakType	Object	Returns the ad break type.
id	integer($int32)	Id of the ad break type.
name	string	Name of the ad break type.
adBreakTypeId	integer($int32)	The ID of the ad break type.
breakTiming	Object	The break-timing object.
breakTimingType	Object	Returns the break timing type.
id	integer($int32)	Id of the break timing option.
name	string	Name of the break timing option.
breakTimingTypeId	integer($int32)	The ID of the break timing type.
nonLinearOverlayAd	bool	Indicates whether the ad overlay is nonlinear.
skipableAfterSecondsNr	integer($int32)	Indicates after how many seconds can the ad be skipped.
isDeleted	bool	Indicates whether the ad schedule is deleted
isVerified	bool	Indicates whether the ad schedule is verified.
waterfallTags	array[Object]	Returns the waterfall tags as an array of objects.
id	integer($int32)	Id of the waterfall tag.
waterfallTagUrl	string	The URL of the waterfall tag.
adBreakId	integer($int32)	The id of the ad break.
isDeleted	bool	Indicates whether the waterfall tag is deleted.
id	integer($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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
adManagerId	integer($int32)	The id of the ad manager type.
vpaidModeOptionId	integer($int32)	The id of the VPAID mode option.
publicId	string	The id of the ad schedule.
name	string	The name of the ad schedule.
adSeenOnSubsequentVisitOptionId	integer($int32)	Indicates that the video should play the preroll break.
vmapAdTag	string	The tag of the VMAP ad.
timeBetweenAds	integer($int32)	Indicates the time ads should have between each other.
startOnPlaylistItem	integer($int32)	Indicates on which playlist item the ad schedule should start
repeatOnInterval	integer($int32)	Indicates the interval at which the ad schedules should repeat.
enableBidding	bool	Indicates whether bidding is enabled or disabled.
biddingTemplatePublicId	integer($int32)	The id of the bidding template.
vpaidModeOption	Object	Returns the VPAID mode option.
adSeenOnSubsequentVisitOption	Object	Returns the subsequent visit option of the ad schedule.
adManager	Object	Returns the ad manager of the ad schedule.
id	integer($int32)	The id of the ad manager.
Value	string	The value of the ad manager,
biddingTemplate	Object	Returns the bidding template as an object.
adBreaks	array[Object]	Returns the ad breaks as an array of objects.
id	integer($int32)	ID of the ad break.
adBreakTypeId	integer($int32)	The ID of the ad break type.
breakTimingTypeId	integer($int32)	The ID of the break timing type.
breakTiming	Object	Returns the break-timing object.
nonLinearOverlayAd	bool	Indicates whether the ad overlay is nonlinear.
skipableAfterSeconds	bool	Indicates whether the ad is skippable after a set number of seconds.
skipableAfterSecondsNr	integer($int32)	Indicates after how many seconds can the ad be skipped.
adBreakType	Object	Returns the ad break type.
id	integer($int32)	Id of the ad break type.
name	string	Name of the ad break type.
breakTimingType	Object	Returns the break timing type.
id	integer($int32)	Id of the break timing option.
name	string	Name of the break timing option.
waterfallTags	array[Object]	Returns the waterfall tags as an array of objects.
id	integer($int32)	Id of the waterfall tag.
adBreakId	integer($int32)	The id of the ad break.
waterfallTagUrl	string	The URL of the waterfall tag.
resultInfo	string	Returns extra information about the result.
statusCode	integer($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