Integration for HTML5 Sites/Apps Updated May 13

Local callback error codes

When the player surfaces an error to the local callback, you can pull the details via getError():

{
  getError: () => {
    return {
      data: {
        type:
          "adsRequestNetworkError" |
          "assetFallbackFailed" |
          "autoplayDisallowed" |
          "companionAdLoadingFailed" |
          "companionRequiredError" |
          "consentManagementProviderNotReady" |
          "failedToRequestAds" |
          "invalidAdTag" |
          "invalidArguments" |
          "nonlinearDimensionsError" |
          "overlayAdLoadingFailed" |
          "overlayAdPlayingFailed" |
          "protectedAudienceApiError" |
          "streamInitializationFailed" |
          "unknownAdResponse" |
          "unknownError" |
          "unsupportedUrl" |
          "vastAssetNotFound" |
          "vastEmptyResponse" |
          "vastLinearAssetMismatch" |
          "vastLoadTimeout" |
          "vastMalformedResponse" |
          "vastMediaLoadTimeout" |
          "vastNoAdsAfterWrapper" |
          "vastNonlinearAssetMismatch" |
          "vastProblemDisplayingMediaFile" |
          "vastSchemaValidationError" |
          "vastTooManyRedirects" |
          "vastTraffickingError" |
          "vastUnexpectedDurationError" |
          "vastUnexpectedLinearity" |
          "vastUnsupportedVersion" |
          "vastWrapperError" |
          "videoPlayError" |
          "vpaidError",
        errorCode: number,
        errorMessage: string,
        innerError: string,
      },
    };
  };
}

Reference

adsRequestNetworkError — problem requesting ads from the server. IMA 1012
assetFallbackFailed — asset fallback error. IMA 1021
autoplayDisallowed — browser prevented playback initiated without user interaction. IMA 1205
companionAdLoadingFailed — deprecated. Companion ad failed to load or render. VAST 603
companionRequiredError — could not display required companions. Main ad discarded. VAST 602
consentManagementProviderNotReady — deprecated. CMP detected; consent not yet known. IMA 1300
failedToRequestAds — problem requesting ads. IMA 1005
invalidAdTag — ad tag URL was invalid (needs proper encoding). IMA 1013
invalidArguments — invalid arguments to SDK methods. IMA 1101
nonlinearDimensionsError — NonLinear ad creative dimensions don't fit display area. VAST 501
overlayAdLoadingFailed — deprecated. Overlay ad failed to load. VAST 502
overlayAdPlayingFailed — overlay ad failed to render. VAST 500
protectedAudienceApiError — protected audience API error. VAST 1014
streamInitializationFailed — stream init error during server-side ad insertion. IMA 1020
unknownAdResponse — ad response was not understood. IMA 1010
unknownError — unexpected error. VAST 900
unsupportedUrl — URL invalid or not supported. IMA 1022
vastAssetNotFound — no assets in VAST ad response. IMA 1007
vastEmptyResponse — VAST response had a single tag with no child tags. IMA 1009
vastLinearAssetMismatch — VAST assets for linear ad didn't match player capabilities. VAST 403
vastLoadTimeout — VAST URI unavailable or timed out (5s initial / wrapper). VAST 301
vastMalformedResponse — ad response not recognized as valid VAST. VAST 100
vastMediaLoadTimeout — failed to load media assets (default 8s). VAST 402
vastNoAdsAfterWrapper — no Ads response after one or more wrappers. VAST 303
vastNonlinearAssetMismatch — VAST assets for nonlinear ad didn't match player capabilities. VAST 503
vastProblemDisplayingMediaFile — playback stopped due to poor quality. VAST 405
vastSchemaValidationError — VAST schema validation error. VAST 101
vastTooManyRedirects — exceeded max VAST wrapper redirects. VAST 302
vastTraffickingError — unexpected ad type. VAST 200
vastUnexpectedDurationError — VAST duration differs from media file duration. VAST 202
vastUnexpectedLinearity — ad linearity differs from what player expects. VAST 201
vastUnsupportedVersion — unsupported VAST version. VAST 102
vastWrapperError — general VAST wrapper error. VAST 300
videoPlayError — error playing the video ad. VAST 400
vpaidError — VPAID error. VAST 901

Reference​

Reference