Skip to content

ADS-746 Ads: events can override the channel integrations - #943

Open
georgechoustoulakis wants to merge 1 commit into
mainfrom
ADS-746-event-integration-overrides
Open

georgechoustoulakis wants to merge 1 commit into
mainfrom
ADS-746-event-integration-overrides

Conversation

@georgechoustoulakis

Copy link
Copy Markdown
Member

Important

Do not merge before the OptiView Ads API release that contains event integration overrides reaches production. The live API does not expose event integrations, event templates, integration templates or the Break Manifest events list yet; these docs describe the post-release behaviour. Kept as a draft until then.

TODO before marking ready for review

  • The OptiView Ads API release with event integration overrides is in production
  • Regenerate the API reference from the live spec (npm run refresh-ads-api-docs) and commit the result on this branch
  • Mark ready for review

Summary

Events can now replace the channel's integrations for their duration, for example to run one game of a 24/7 channel on its own Google Ad Manager live stream. The docs are centred on that; delivery rules and ad start delay are covered briefly as the other event overrides.

  • concepts/events.mdx
    • New Integrations during an event: the event integrations endpoint, overridesIntegrations (false: channel integrations apply; true: the event's replace them as a whole, none if the event has none), one integration per type and vendor, asset keys may be reused by events, copies not references, and which integrations a break uses (the ones in effect at its start; cue breaks once the event has started).
    • Short Delivery and ad start delay subsection.
    • New Event templates: event templates (/templates/events) referencing integration templates (/templates/integrations), with an example of creating an event from a template; omitted integrationTemplateIds keeps the channel integrations, [] runs without any; snapshot semantics; channelIds is only a list filter.
    • Events are only available on live wallclock channels, so the PTS rule under "Breaks under an event" is removed. "Templates for an event" is renamed "Break templates for an event".
  • concepts/break-manifest.mdx: the events list (Break Manifest 1.9.0) — the top level stays the channel's, each event carries only what it replaces, and the player switches by playback position.
  • concepts/templates.mdx: break templates live under /templates/breaks; pointer to event and integration templates.
  • integrations/index.mdx: channel integrations are the defaults, events can replace them. Also fixes a related-resources row that still referred to the channel-level customAssetKey field, which was removed from channels.
  • concepts/channels.mdx: Integrations rows describe the channel's default integrations.

Validation

prettier --check and mdxlint --frail (spellcheck) pass for the changed files. Broken-link checking is left to the preview build.

Events can replace the channel's integrations for their duration, and
event templates let a repeated event (a season of games) carry its
integrations through integration templates. Delivery rules and ad start
delay are covered briefly as the other event overrides. The Break
Manifest documents the events list added in version 1.9.0.

Co-authored-by: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@theoplayer-bot

theoplayer-bot Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
Documentation preview
🚀 View preview at
https://docs-preview.optiview.dolby.com/pr-943/

Deployed from commit 0a86598 at 2026-10-30 14:54 UTC.

@georgechoustoulakis
georgechoustoulakis marked this pull request as ready for review October 30, 2026 14:40
@georgechoustoulakis
georgechoustoulakis requested a review from a team as a code owner October 30, 2026 14:40

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants