GET Audio Player Script with Ad Schedule
Overview
The following table contains important information about the GET method in regards to receiving the audio player script with a specific ad schedule.
| GET Audio Player Script with Ad Schedule | |
|---|---|
| Method | GET |
| URL or Endpoint | /audio-player/playerId/audioId/adScheduleId.js |
| Headers | Not Applicable |
| Parameters | playerId, audioId, adScheduleId, startEpisode |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
playerId | Yes | string | Unique Id of the audio player. |
audioId | Yes | string | Unique Id of the audio. |
adScheduleId | Yes | string | Unique Id of the ad schedule to use for advertising. |
startEpisode | No | string (query) | The episode to start playback from (used for podcasts). |
Request Body
The request does not contain a request body
Response
Returns application/javascript content containing the audio player script configured for the specified audio with the given ad schedule applied.
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