PUT Ad Schedule

Overview

---

The following table contains important information about the PUT method in regards to updating an ad schedule.

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

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.

Request Body

{
  "adManagerId": 0,
  "vpaidModeOptionId": 0,
  "publicId": "{publicId}",
  "name": "{name}",
  "adScheduleTypeId": 0,
  "adSeenOnSubsequentVisitOptionId": 0,
  "vmapAdTag": "{vmapAdTag}",
  "timeBetweenAds": 0,
  "startOnPlaylistItem": 0,
  "repeatOnInterval": 0,
  "enableBidding": false,
  "enableProgrammability": false,
  "skipAllAds": false,
  "enableDemandManager": false,
  "wrapperId": "{wrapperId}",
  "biddingTemplatePublicId": "{biddingTemplatePublicId}",
  "playerTypeId": 0,
  "playerType": "{playerType}",
  "adFrequencyTimingTypeId": 0,
  "adFrequency": 0,
  "initialDelayTimingTypeId": 0,
  "initialDelay": 0,
  "adCapping": 0,
  "adCycleDelayMs": 0,
  "adRetryLimit": 0,
  "adCycleRestartMs": 0,
  "vpaidModeOption": {
    "id": 0,
    "name": "{name}"
  },
  "adSeenOnSubsequentVisitOption": {
    "id": 0,
    "name": "{name}"
  },
  "adManager": {
    "id": 0,
    "Value": "{Value}"
  },
  "adScheduleType": {
    "id": 0,
    "name": "{name}",
    "value": "{value}",
    "description": "{description}"
  },
  "adWorkflows": [
    {
      "id": 0,
      "adScheduleId": "{adScheduleId}",
      "adFunctionId": 0,
      "adFunctionName": "{adFunctionName}",
      "order": 0
    }
  ],
  "adBanner": {
    "adUnitPath": "{adUnitPath}",
    "isEnabled": false,
    "adBannerSizes": [
      {
        "width": 0,
        "height": 0
      }
    ]
  }
}

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

Request Body Properties

Field Name	Type	Description
adManagerId	integer	The ID of the ad manager.
vpaidModeOptionId	integer or null	The ID of the VPAID mode option.
publicId	string	The public ID of the ad schedule.
name	string	The name of the ad schedule.
adScheduleTypeId	integer or null	The ID of the ad schedule type.
adSeenOnSubsequentVisitOptionId	integer or null	The ID of the ad seen on subsequent visit option.
vmapAdTag	string	The VMAP ad tag URL.
timeBetweenAds	integer or null	Time between ads in seconds.
startOnPlaylistItem	integer or null	The playlist item number on which the ad schedule should start.
repeatOnInterval	integer or null	The interval at which the ad schedule should repeat.
enableBidding	boolean	Indicates whether header bidding is enabled.
enableProgrammability	boolean	Indicates whether programmability features are enabled.
skipAllAds	boolean	Indicates whether all ads should be skipped.
enableDemandManager	boolean	Indicates whether the demand manager is enabled.
wrapperId	string	The public ID of the wrapper.
biddingTemplatePublicId	string	The public ID of the bidding template.
playerTypeId	integer or null	The ID of the player type.
playerType	string	The name of the player type.
adFrequencyTimingTypeId	integer or null	The ID of the ad frequency timing type.
adFrequency	integer or null	The ad frequency value.
initialDelayTimingTypeId	integer or null	The ID of the initial delay timing type.
initialDelay	integer or null	The initial delay before the first ad plays.
adCapping	integer or null	Maximum number of ads shown per session.
adCycleDelayMs	integer or null	Delay between ad cycles in milliseconds.
adRetryLimit	integer or null	Maximum number of ad retry attempts.
adCycleRestartMs	integer or null	Time in milliseconds before restarting the ad cycle.
vpaidModeOption	object	The VPAID mode option object.
adSeenOnSubsequentVisitOption	object	The ad seen on subsequent visit option object.
adManager	object	The ad manager object.
adScheduleType	object	The ad schedule type object.
adWorkflows	array[object]	The workflows associated with the ad schedule.
adBanner	object	The ad banner configuration object.

vpaidModeOption Properties

Field Name	Type	Description
id	integer	The ID of the VPAID mode option.
name	string	The name of the VPAID mode option.

adSeenOnSubsequentVisitOption Properties

Field Name	Type	Description
id	integer	The ID of the subsequent visit option.
name	string	The name of the subsequent visit option.

adManager Properties

Field Name	Type	Description
id	integer	The ID of the ad manager.
Value	string	The name of the ad manager.

adScheduleType Properties

Field Name	Type	Description
id	integer	The ID of the ad schedule type.
name	string	Name of the ad schedule type.
value	string	Value of the ad schedule type.
description	string	Description of the ad schedule type.

adWorkflows Properties

Field Name	Type	Description
id	integer or null	The ID of the ad workflow.
adScheduleId	string	The public ID of the associated ad schedule.
adFunctionId	integer	The ID of the ad function.
adFunctionName	string	The name of the ad function.
order	integer	The execution order of the workflow.

adBanner Properties

Field Name	Type	Description
adUnitPath	string	The ad unit path for the banner.
isEnabled	boolean	Indicates whether the ad banner is enabled.
adBannerSizes	array[object]	The list of banner size configurations.

adBannerSizes Properties

Field Name	Type	Description
width	integer	The width of the banner in pixels.
height	integer	The height of the banner in pixels.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "adManagerId": 0,
    "vpaidModeOptionId": 0,
    "publicId": "{publicId}",
    "name": "{name}",
    "adScheduleTypeId": 0,
    "adSeenOnSubsequentVisitOptionId": 0,
    "vmapAdTag": "{vmapAdTag}",
    "timeBetweenAds": 0,
    "startOnPlaylistItem": 0,
    "repeatOnInterval": 0,
    "enableBidding": false,
    "enableProgrammability": false,
    "skipAllAds": false,
    "enableDemandManager": false,
    "wrapperId": "{wrapperId}",
    "biddingTemplatePublicId": "{biddingTemplatePublicId}",
    "playerTypeId": 0,
    "playerType": "{playerType}",
    "adFrequencyTimingTypeId": 0,
    "adFrequency": 0,
    "initialDelayTimingTypeId": 0,
    "initialDelay": 0,
    "adCapping": 0,
    "adCycleDelayMs": 0,
    "adRetryLimit": 0,
    "adCycleRestartMs": 0,
    "vpaidModeOption": {
      "id": 0,
      "name": "{name}"
    },
    "adSeenOnSubsequentVisitOption": {
      "id": 0,
      "name": "{name}"
    },
    "adManager": {
      "id": 0,
      "Value": "{Value}"
    },
    "adScheduleType": {
      "id": 0,
      "name": "{name}",
      "value": "{value}",
      "description": "{description}"
    },
    "adWorkflows": [
      {
        "id": 0,
        "adScheduleId": "{adScheduleId}",
        "adFunctionId": 0,
        "adFunctionName": "{adFunctionName}",
        "order": 0
      }
    ],
    "adBanner": {
      "adUnitPath": "{adUnitPath}",
      "isEnabled": false,
      "adBannerSizes": [
        {
          "width": 0,
          "height": 0
        }
      ]
    }
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	object	Returns the updated ad schedule object.
adManagerId	integer	The ID of the ad manager.
vpaidModeOptionId	integer or null	The ID of the VPAID mode option.
publicId	string	The public ID of the ad schedule.
name	string	The name of the ad schedule.
adScheduleTypeId	integer or null	The ID of the ad schedule type.
adSeenOnSubsequentVisitOptionId	integer or null	The ID of the ad seen on subsequent visit option.
vmapAdTag	string	The VMAP ad tag URL.
timeBetweenAds	integer or null	Time between ads in seconds.
startOnPlaylistItem	integer or null	The playlist item number on which the ad schedule should start.
repeatOnInterval	integer or null	The interval at which the ad schedule should repeat.
enableBidding	boolean	Indicates whether header bidding is enabled.
enableProgrammability	boolean	Indicates whether programmability features are enabled.
skipAllAds	boolean	Indicates whether all ads should be skipped.
enableDemandManager	boolean	Indicates whether the demand manager is enabled.
wrapperId	string	The public ID of the wrapper.
biddingTemplatePublicId	string	The public ID of the bidding template.
playerTypeId	integer or null	The ID of the player type.
playerType	string	The name of the player type.
adFrequencyTimingTypeId	integer or null	The ID of the ad frequency timing type.
adFrequency	integer or null	The ad frequency value.
initialDelayTimingTypeId	integer or null	The ID of the initial delay timing type.
initialDelay	integer or null	The initial delay before the first ad plays.
adCapping	integer or null	Maximum number of ads shown per session.
adCycleDelayMs	integer or null	Delay between ad cycles in milliseconds.
adRetryLimit	integer or null	Maximum number of ad retry attempts.
adCycleRestartMs	integer or null	Time in milliseconds before restarting the ad cycle.
vpaidModeOption	object	The VPAID mode option object.
adSeenOnSubsequentVisitOption	object	The ad seen on subsequent visit option object.
adManager	object	The ad manager object.
adScheduleType	object	The ad schedule type object.
adWorkflows	array[object]	The workflows associated with the ad schedule.
adBanner	object	The ad banner configuration object.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

vpaidModeOption Properties

Field Name	Type	Description
id	integer	The ID of the VPAID mode option.
name	string	The name of the VPAID mode option.

adSeenOnSubsequentVisitOption Properties

Field Name	Type	Description
id	integer	The ID of the subsequent visit option.
name	string	The name of the subsequent visit option.

adManager Properties

Field Name	Type	Description
id	integer	The ID of the ad manager.
Value	string	The name of the ad manager.

adScheduleType Properties

Field Name	Type	Description
id	integer	The ID of the ad schedule type.
name	string	Name of the ad schedule type.
value	string	Value of the ad schedule type.
description	string	Description of the ad schedule type.

adWorkflows Properties

Field Name	Type	Description
id	integer or null	The ID of the ad workflow.
adScheduleId	string	The public ID of the associated ad schedule.
adFunctionId	integer	The ID of the ad function.
adFunctionName	string	The name of the ad function.
order	integer	The execution order of the workflow.

adBanner Properties

Field Name	Type	Description
adUnitPath	string	The ad unit path for the banner.
isEnabled	boolean	Indicates whether the ad banner is enabled.
adBannerSizes	array[object]	The list of banner size configurations.

adBannerSizes Properties

Field Name	Type	Description
width	integer	The width of the banner in pixels.
height	integer	The height of the banner in pixels.

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