Repository navigation
Ads: split the SDK docs by ad workflow (static assets, VAST, Google Pod Serving) - #891
Closed
MaartenRimaux wants to merge 1 commit into
Closed
MaartenRimaux wants to merge 1 commit into
MaartenRimaux wants to merge 1 commit into
Conversation
…od Serving) The SDK guides assumed Google Pod Serving: every platform page asked for Google Ad Manager values, so static-asset and VAST customers were told to set up configuration that does not apply to them. Platform pages are now workflow-neutral, and each workflow gets its own page with its platform requirements, supported layouts and troubleshooting. Also aligns the docs with SDK 1.0.0: the Google network code and custom asset key come from the Break Manifest (gam is only an opt-out), and break-level assetParameters win over SDK values. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
3 of 5 tasks
Contributor
Author
|
Superseded by #934, which restructures the workflow docs by use case (live, VOD) and ad source, and carries over the fixes from this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Jira: ADS-590
The OptiView Ads SDK guides were written around Google Pod Serving: every platform page asked for a Google Ad Manager
networkCodeandcustomAssetKey. Customers who only play static assets or VAST tags were told to set up configuration that doesn't apply to them, and the guides missed what those workflows do need.gam: { networkCode }examples are removed.ima3.js, which that guide never loads. The break lifecycle text is also fixed: non-Google breaks start inREADY.$OPTIVIEW_*macros.Corrections against SDK 1.0.0 (checked on the
v1.0.0tag in all three cores)GamConfighas nonetworkCode, and the SGAISessionConfighas nocustomAssetKey. Both come from the Break Manifest'svendorConfiguration.gamis only an opt-out (enabled: false). The old Web example fails TypeScript's excess-property check.assetParametersmerge order is session <updateAssetParameters()< Break Manifest. The break's value wins, the opposite of what the how-to said before. The Google Pod Serving integration page now separates the SDK behavior from the legacy OptiView Player behavior.ima3.js; Google Pod Serving needsima3_dai.js. Neither script was documented before.Legacy OptiView Player pages are out of scope.
Test plan
prettier --checkandnpm run lintpass@mdx-js/mdxbuildpasses (onBrokenLinks/onBrokenAnchors: throw)Generated with Devin