feat: add onAdError event listener (#3381)

* feat: add onAdError event listener * feat: remove onAdError event listener and use already existing * feat: add ERROR event to docs
TheWidlarzGroup · Dec 2, 2023 · 596c02d · 596c02d
1 parent 4d9334b
commit 596c02d
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 8 deletions.
diff --git a/android/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java b/android/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java
@@ -54,6 +54,10 @@ public Builder setAdEventListener(Object ignoredReactExoplayerView) {
             return this;
         }
 
+        public Builder setAdErrorListener(Object ignoredReactExoplayerView) {
+            return this;
+        }
+
         public ImaAdsLoader build() {
             return null;
         }

diff --git a/android/src/main/java/com/brentvatne/common/react/VideoEventEmitter.java b/android/src/main/java/com/brentvatne/common/react/VideoEventEmitter.java
@@ -12,6 +12,7 @@
 import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.uimanager.events.RCTEventEmitter;
+import com.google.ads.interactivemedia.v3.api.AdError;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
@@ -434,6 +435,19 @@ public void receiveAdEvent(String event) {
         receiveEvent(EVENT_ON_RECEIVE_AD_EVENT, map);
     }
 
+    public void receiveAdErrorEvent(AdError error) {
+        WritableMap map = Arguments.createMap();
+        map.putString("event", "ERROR");
+
+        WritableMap dataMap = Arguments.createMap();
+        dataMap.putString("message", error.getMessage());
+        dataMap.putString("code", String.valueOf(error.getErrorCode()));
+        dataMap.putString("type", String.valueOf(error.getErrorType()));
+        map.putMap("data", dataMap);
+
+        receiveEvent(EVENT_ON_RECEIVE_AD_EVENT, map);
+    }
+
     private void receiveEvent(@VideoEvents String type, WritableMap event) {
         eventEmitter.receiveEvent(viewId, type, event);
     }

diff --git a/android/src/main/java/com/brentvatne/exoplayer/ReactExoplayerView.java b/android/src/main/java/com/brentvatne/exoplayer/ReactExoplayerView.java
@@ -108,6 +108,7 @@
 import com.facebook.react.bridge.UiThreadUtil;
 import com.facebook.react.uimanager.ThemedReactContext;
 import com.google.ads.interactivemedia.v3.api.AdEvent;
+import com.google.ads.interactivemedia.v3.api.AdErrorEvent;
 import com.google.common.collect.ImmutableList;
 
 import java.net.CookieHandler;
@@ -132,7 +133,8 @@ public class ReactExoplayerView extends FrameLayout implements
         BandwidthMeter.EventListener,
         BecomingNoisyListener,
         DrmSessionEventListener,
-        AdEvent.AdEventListener {
+        AdEvent.AdEventListener,
+        AdErrorEvent.AdErrorListener {
 
     public static final double DEFAULT_MAX_HEAP_ALLOCATION_PERCENT = 1;
     public static final double DEFAULT_MIN_BACK_BUFFER_MEMORY_RESERVE = 0;
@@ -621,8 +623,10 @@ private void initializePlayerCore(ReactExoplayerView self) {
                         .setExtensionRendererMode(DefaultRenderersFactory.EXTENSION_RENDERER_MODE_OFF);
 
         // Create an AdsLoader.
-        adsLoader = new ImaAdsLoader.Builder(themedReactContext)
+        adsLoader = new ImaAdsLoader
+                .Builder(themedReactContext)
                 .setAdEventListener(this)
+                .setAdErrorListener(this)
                 .build();
 
         DefaultMediaSourceFactory mediaSourceFactory = new DefaultMediaSourceFactory(mediaDataSourceFactory);
@@ -2103,4 +2107,9 @@ public void onAdEvent(AdEvent adEvent) {
             eventEmitter.receiveAdEvent(adEvent.getType().name());
         }
     }
+
+    @Override
+    public void onAdError(AdErrorEvent adErrorEvent) {
+        eventEmitter.receiveAdErrorEvent(adErrorEvent.getError());
+    }
 }
diff --git a/android/src/main/java/com/google/ads/interactivemedia/v3/api/AdError.java b/android/src/main/java/com/google/ads/interactivemedia/v3/api/AdError.java
@@ -0,0 +1,10 @@
+package com.google.ads.interactivemedia.v3.api;
+
+import androidx.annotation.InspectableProperty;
+
+public abstract class AdError {
+    public abstract InspectableProperty getErrorCode();
+    public abstract InspectableProperty getErrorCodeNumber();
+    public abstract InspectableProperty getErrorType();
+    public abstract String getMessage();
+}
diff --git a/android/src/main/java/com/google/ads/interactivemedia/v3/api/AdErrorEvent.java b/android/src/main/java/com/google/ads/interactivemedia/v3/api/AdErrorEvent.java
@@ -0,0 +1,9 @@
+package com.google.ads.interactivemedia.v3.api;
+
+public abstract class AdErrorEvent {
+    public abstract AdError getError();
+
+    public interface AdErrorListener {
+        public void onAdError(AdErrorEvent adErrorEvent);
+    }
+}
diff --git a/docs/pages/component/events.md b/docs/pages/component/events.md
@@ -370,6 +370,7 @@ Enum `AdEvent` possible values for [Android](https://developers.google.com/inter
 | `CONTENT_RESUME_REQUESTED` | Android       | Fires when content should be resumed. This usually happens when an ad finishes or collapses.                                                                                                                |
 | `CUEPOINTS_CHANGED`        | iOS           | Cuepoints changed for VOD stream (only used for dynamic ad insertion).                                                                                                                                      |
 | `DURATION_CHANGE`          | Android       | Fires when the ad's duration changes.                                                                                                                                                                       |
+| `ERROR`                    | Android, iOS  | Fires when an error occurred while loading the ad and prevent it from playing.                                                                                                                              |
 | `FIRST_QUARTILE`           | Android, iOS  | Fires when the ad playhead crosses first quartile.                                                                                                                                                          |
 | `IMPRESSION`               | Android       | Fires when the impression URL has been pinged.                                                                                                                                                              |
 | `INTERACTION`              | Android       | Fires when an ad triggers the interaction callback. Ad interactions contain an interaction ID string in the ad data.                                                                                        |

diff --git a/ios/Video/Features/RCTIMAAdsManager.swift b/ios/Video/Features/RCTIMAAdsManager.swift
@@ -118,8 +118,22 @@ class RCTIMAAdsManager: NSObject, IMAAdsLoaderDelegate, IMAAdsManagerDelegate, I
             print("AdsManager error: " + error.message!)
         }
 
+        guard let _video = _video else {return}
+
+        if _video.onReceiveAdEvent != nil {
+            _video.onReceiveAdEvent?([
+                "event": "ERROR",
+                "data": [
+                    "message": error.message ?? "",
+                    "code": error.code,
+                    "type": error.type,
+                ],
+                "target": _video.reactTag!
+            ])
+        }
+
         // Fall back to playing content
-        _video?.setPaused(false)
+        _video.setPaused(false)
     }
 
     func adsManagerDidRequestContentPause(_ adsManager: IMAAdsManager) {

diff --git a/ios/Video/RCTVideo.swift b/ios/Video/RCTVideo.swift
@@ -146,7 +146,7 @@ class RCTVideo: UIView, RCTVideoPlayerViewControllerDelegate, RCTPlayerObserverH
             name: UIApplication.willResignActiveNotification,
             object: nil
         )
-                
+
         NotificationCenter.default.addObserver(
             self,
             selector: #selector(applicationDidBecomeActive(notification:)),
@@ -1346,11 +1346,11 @@ class RCTVideo: UIView, RCTVideoPlayerViewControllerDelegate, RCTPlayerObserverH
             _playerObserver.removePlayerTimeObserver()
         }
     }
-    
+
     @objc func handleAVPlayerAccess(notification:NSNotification!) {
         let accessLog:AVPlayerItemAccessLog! = (notification.object as! AVPlayerItem).accessLog()
         let lastEvent:AVPlayerItemAccessLogEvent! = accessLog.events.last
-        
+
         onVideoBandwidthUpdate?(["bitrate": lastEvent.observedBitrate, "target": reactTag])
     }
 }
diff --git a/src/Video.tsx b/src/Video.tsx
@@ -13,7 +13,6 @@ import NativeVideoComponent, {
 } from './VideoNativeComponent';
 
 import type {StyleProp, ImageStyle, NativeSyntheticEvent} from 'react-native';
-import type {ReactVideoProps} from './types/video';
 import {getReactTag, resolveAssetSourceForVideo} from './utils';
 import {VideoManager} from './VideoNativeComponent';
 import type {
@@ -35,7 +34,8 @@ import type {
   OnVideoAspectRatioData,
   OnVideoErrorData,
   OnVideoTracksData,
-} from './types/events';
+  ReactVideoProps,
+} from './types';
 
 export type VideoSaveData = {
   uri: string;

diff --git a/src/types/Ads.ts b/src/types/Ads.ts
@@ -63,6 +63,10 @@ export enum AdEvent {
    * Android only: Fires when the ad's duration changes.
    */
   DURATION_CHANGE = 'DURATION_CHANGE',
+  /**
+   * Fires when an error is encountered and the ad can't be played.
+   */
+  ERROR = 'ERROR',
   /**
    * Fires when the ad playhead crosses first quartile.
    */