v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB

Ads

List ads

Lists ads configured for a project.

get/projects/{project_id}/ads

Query parameters

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

filter[title]string

filter by title

Response

idinteger

Unique identifier for the object

type'custom' | 'vast'

The type of ad, either custom or vast. Ads of type custom must have title, url and media fields. Ads of type vast must have title and vast_url fields.

enabledboolean

Whether the ad will play in the BeyondWords player

placement'pre-roll' | 'mid-roll' | 'post-roll'

Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll

vast_urlstring uri nullable

A VAST-compliant URL that contains the ads to be played

titlestring nullable

The title of the ad

click_through_urlstring uri nullable

The click-through URL of the custom ad to show in the player

image_urlstring uri nullable

The image URL to show in the player while the ad is playing

media_urlstring uri nullable

The URL of the media file of the custom ad to play in the player

audio_urlstring uri nullable

The URL of the audio file of the custom ad to play in the player

video_urlstring uri nullable

The URL of the video file of the custom ad to play in the player

theme'auto' | 'dark' | 'light' nullable

The color theme to use for the ad when it is playing. Possible values are auto, dark, light. The auto theme is based on the user's light/dark mode system preference.

createdstring

Time at which the object was created (ISO 8601)

updatedstring

Time at which the object was updated (ISO 8601)