Adds support for googletag.events.SlotOnloadEvent (#20) (#73)

Author: gabelew

docs/api/ReactGPT.md

@@ -25,6 +25,7 @@ A React component which renders [GPT](https://support.google.com/dfp_sb/answer/1
 - `onSlotRenderEnded`(optional) - An optional event handler function for `googletag.events.SlotRenderEndedEvent`.
 - `onImpressionViewable`(optional) - An optional event handler function for `googletag.events.ImpressionViewableEvent`.
 - `onSlotVisibilityChanged`(optional) - An optional event handler function for `googletag.events.slotVisibilityChangedEvent`.
+- `onSlotLoad`(optional) - An optional event handler function for `googletag.events.SlotOnloadEvent`.
 - `renderWhenViewable`(optional) - An optional flag to indicate whether an ad should only render when it's fully in the viewport area.
 - `viewableThreshold`(optional) - An optional number to indicate how much percentage of an ad area needs to be in a viewable area before rendering. Acceptable range is between `0` and `1`.
 - `onScriptLoaded`(optional) - An optional call back function to notify when the script is loaded.

examples/apps/log.js

@@ -42,4 +42,11 @@ GPT.on(Events.SLOT_VISIBILITY_CHANGED, event => {
     const divId = slot.getSlotElementId();
     const sizes = slot.getSizes();
     console.log(`SLOT_VISIBILITY_CHANGED for ${divId}(${JSON.stringify(sizes)}) to ${event.inViewPercentage}`, event);
+});
+
+GPT.on(Events.SLOT_LOADED, event => {
+    const slot = event.slot;
+    const divId = slot.getSlotElementId();
+    const sizes = slot.getSizes();
+    console.log(`SLOT_LOADED for ${divId}(${JSON.stringify(sizes)})`, event);
 });*/

src/Bling.js

@@ -19,6 +19,7 @@ import {createManager, pubadsAPI} from "./createManager";
  * @fires Bling#Events.SLOT_RENDER_ENDED
  * @fires Bling#Events.IMPRESSION_VIEWABLE
  * @fires Bling#Events.SLOT_VISIBILITY_CHANGED
+ * @fires Bling#Events.SLOT_LOADED
  */
 class Bling extends Component {
     static propTypes = {
@@ -154,6 +155,12 @@ class Bling extends Component {
          * @property onSlotVisibilityChanged
          */
         onSlotVisibilityChanged: PropTypes.func,
+        /**
+         * An optional event handler function for `googletag.events.SlotOnloadEvent`.
+         *
+         * @property onSlotLoad
+         */
+        onSlotLoad: PropTypes.func,
         /**
          * An optional flag to indicate whether an ad should only render when it's fully in the viewport area.
          *

src/Events.js

@@ -3,7 +3,8 @@ const Events = {
     RENDER: "render",
     SLOT_RENDER_ENDED: "slotRenderEnded",
     IMPRESSION_VIEWABLE: "impressionViewable",
-    SLOT_VISIBILITY_CHANGED: "slotVisibilityChanged"
+    SLOT_VISIBILITY_CHANGED: "slotVisibilityChanged",
+    SLOT_LOADED: "slotOnload"
 };
 
 export default Events;

src/createManager.js

@@ -186,7 +186,8 @@ export class AdManager extends EventEmitter {
             [
                 Events.SLOT_RENDER_ENDED,
                 Events.IMPRESSION_VIEWABLE,
-                Events.SLOT_VISIBILITY_CHANGED
+                Events.SLOT_VISIBILITY_CHANGED,
+                Events.SLOT_LOADED
             ].forEach(eventType => {
                 ["pubads", "content", "companionAds"].forEach(service => {
                     // there is no API to remove listeners.