@playcraft/adsdk 1.0.6 → 1.0.8

package/defines.d.ts

@@ -88,6 +88,12 @@ interface Window {
     landUrl: string;
   };
 
+  // AppLovin Playable Analytics
+  // 文档: https://support.axon.ai/en/growth/promoting-your-apps/creatives/playable-analytics-integration
+  ALPlayableAnalytics?: {
+    trackEvent: (event: string) => void;
+  };
+
   // BigoAds SDK
   // 文档: https://www.bigoads.com/help/detail?id=143&moduleId=7&currentLan=CN
   BGY_MRAID: {

package/dist/esm/index.js

@@ -158,53 +158,174 @@ function ensureProtocol() {
 }
 
 // src/tracking.ts
+function trackURL(url) {
+  if (url) {
+    const trackingPixel = new Image();
+    trackingPixel.src = url;
+  }
+}
+function trackBigabidEvent(event) {
+  console.log(" trackBigabidEvent", event);
+  if (window.BIGABID_BIDTIMEMACROS && window.BIGABID_BIDTIMEMACROS[event]) {
+    trackURL(window.BIGABID_BIDTIMEMACROS[event]);
+  }
+}
+function trackInMobiEvent(event) {
+  console.log(" trackInMobiEvent", event);
+  if (window.INMOBI_DSPMACROS && window.INMOBI_DSPMACROS[event]) {
+    trackURL(window.INMOBI_DSPMACROS[event]);
+  }
+}
+function trackApplovinEvent(event) {
+  console.log(" trackApplovinEvent", event);
+  if (typeof window.ALPlayableAnalytics !== "undefined") {
+    window.ALPlayableAnalytics.trackEvent(event);
+  }
+}
+var totalInteractions = 0;
+var progressMilestones = [];
+function setTotalInteractions(total) {
+  totalInteractions = total;
+}
+function trackChallengeSuccess() {
+  if (AD_NETWORK === "applovin") {
+    trackApplovinEvent("CHALLENGE_SOLVED");
+  }
+  if (AD_NETWORK === "bigabid") {
+    trackBigabidComplete();
+  }
+  if (AD_NETWORK === "inmobi") {
+    trackInMobiEvent("Gameplay_Complete");
+  }
+}
+function trackChallengeFailed() {
+  if (AD_NETWORK === "applovin") {
+    trackApplovinEvent("CHALLENGE_FAILED");
+  }
+}
+function initProgressMilestones() {
+  if (totalInteractions <= 0) return;
+  if (AD_NETWORK === "applovin") {
+    progressMilestones = [
+      { percent: 25, triggered: false, callback: () => trackApplovinEvent("CHALLENGE_PASS_25") },
+      { percent: 50, triggered: false, callback: () => trackApplovinEvent("CHALLENGE_PASS_50") },
+      { percent: 75, triggered: false, callback: () => trackApplovinEvent("CHALLENGE_PASS_75") },
+      { percent: 100, triggered: false, callback: () => trackChallengeSuccess() }
+    ];
+  } else if (AD_NETWORK === "bigabid") {
+    progressMilestones = [
+      { percent: 100, triggered: false, callback: () => trackChallengeSuccess() }
+    ];
+  }
+}
+function checkInteractionProgress(currentInteractions) {
+  if (totalInteractions <= 0 || progressMilestones.length === 0) return;
+  const currentPercent = currentInteractions / totalInteractions * 100;
+  for (const milestone of progressMilestones) {
+    if (!milestone.triggered && currentPercent >= milestone.percent) {
+      milestone.triggered = true;
+      milestone.callback();
+    }
+  }
+}
+var bigabidCompleteTriggered = false;
+function trackBigabidComplete() {
+  if (!bigabidCompleteTriggered) {
+    trackBigabidEvent("complete");
+    bigabidCompleteTriggered = true;
+  }
+}
+var inmobiTimers = [];
+function startInMobiDurationTracking() {
+  const durations = [5, 10, 15, 20, 25, 30];
+  for (const sec of durations) {
+    const timer = setTimeout(() => trackInMobiEvent(`Spent_${sec}_Seconds`), sec * 1e3);
+    inmobiTimers.push(timer);
+  }
+}
+function clearInMobiDurationTracking() {
+  for (const timer of inmobiTimers) {
+    clearTimeout(timer);
+  }
+  inmobiTimers = [];
+}
 function initTrackingProtocols() {
-  if (AD_NETWORK === "bigabid" || AD_NETWORK === "inmobi") {
-    let trackURL2 = function(url) {
-      if (url) {
-        const trackingPixel = new Image();
-        trackingPixel.src = url;
-      }
-    };
-    var trackURL = trackURL2;
+  const supportedNetworks = ["bigabid", "inmobi", "applovin"];
+  if (!supportedNetworks.includes(AD_NETWORK)) {
+    return;
+  }
+  initProgressMilestones();
+  sdk.once("init", () => {
     if (AD_NETWORK === "bigabid") {
-      let trackBigabidEvent2 = function(event) {
-        if (window.BIGABID_BIDTIMEMACROS && window.BIGABID_BIDTIMEMACROS[event])
-          trackURL2(window.BIGABID_BIDTIMEMACROS[event]);
-      }, trackComplete2 = function() {
-        if (!completeTriggered) trackBigabidEvent2("complete");
-        completeTriggered = true;
-      };
-      var trackBigabidEvent = trackBigabidEvent2, trackComplete = trackComplete2;
-      var completeTriggered = false;
-      sdk.once("boot", () => trackBigabidEvent2("mraid_viewable"));
-      sdk.once("start", () => trackBigabidEvent2("game_viewable"));
-      sdk.once("interaction", () => trackBigabidEvent2("engagement"));
-      sdk.once("finish", trackComplete2);
-      sdk.on("interaction", (interactions) => {
-        if (interactions > 3) trackComplete2();
-      });
-      sdk.once("install", () => trackBigabidEvent2("click"));
-    } else if (AD_NETWORK === "inmobi") {
-      let trackInMobiEvent2 = function(event) {
-        if (window.INMOBI_DSPMACROS && window.INMOBI_DSPMACROS[event]) trackURL2(window.INMOBI_DSPMACROS[event]);
-      };
-      var trackInMobiEvent = trackInMobiEvent2;
-      sdk.once("boot", () => trackInMobiEvent2("Ad_Load_Start"));
-      sdk.once("start", () => trackInMobiEvent2("Ad_Viewable"));
-      sdk.once("interaction", () => trackInMobiEvent2("First_Engagement"));
-      sdk.once("finish", () => trackInMobiEvent2("Gameplay_Complete"));
-      sdk.once("install", () => trackInMobiEvent2("DSP_Click"));
-      sdk.once("start", () => {
-        setTimeout(() => trackInMobiEvent2("Spent_5_Seconds"), 5e3);
-        setTimeout(() => trackInMobiEvent2("Spent_10_Seconds"), 1e4);
-        setTimeout(() => trackInMobiEvent2("Spent_15_Seconds"), 15e3);
-        setTimeout(() => trackInMobiEvent2("Spent_20_Seconds"), 2e4);
-        setTimeout(() => trackInMobiEvent2("Spent_25_Seconds"), 25e3);
-        setTimeout(() => trackInMobiEvent2("Spent_30_Seconds"), 3e4);
-      });
+      trackBigabidEvent("mraid_viewable");
     }
-  }
+    if (AD_NETWORK === "inmobi") {
+      trackInMobiEvent("Ad_Load_Start");
+    }
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("LOADING");
+    }
+  });
+  sdk.once("start", () => {
+    if (AD_NETWORK === "bigabid") {
+      trackBigabidEvent("game_viewable");
+    }
+    if (AD_NETWORK === "inmobi") {
+      trackInMobiEvent("Ad_Viewable");
+      startInMobiDurationTracking();
+    }
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("LOADED");
+    }
+  });
+  sdk.once("interactive", () => {
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("DISPLAYED");
+    }
+  });
+  sdk.once("interaction", () => {
+    if (AD_NETWORK === "bigabid") {
+      trackBigabidEvent("engagement");
+    }
+    if (AD_NETWORK === "inmobi") {
+      trackInMobiEvent("First_Engagement");
+    }
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("CHALLENGE_STARTED");
+    }
+  });
+  sdk.on("success", (successCount) => {
+    checkInteractionProgress(successCount);
+  });
+  sdk.once("finish", () => {
+    if (AD_NETWORK === "bigabid") {
+      trackBigabidComplete();
+    }
+    if (AD_NETWORK === "inmobi") {
+      trackInMobiEvent("Gameplay_Complete");
+      clearInMobiDurationTracking();
+    }
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("ENDCARD_SHOWN");
+    }
+  });
+  sdk.on("install", () => {
+    if (AD_NETWORK === "bigabid") {
+      trackBigabidEvent("click");
+    }
+    if (AD_NETWORK === "inmobi") {
+      trackInMobiEvent("DSP_Click");
+      clearInMobiDurationTracking();
+    }
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("CTA_CLICKED");
+    }
+  });
+  sdk.once("retry", () => {
+    if (AD_NETWORK === "applovin") {
+      trackApplovinEvent("CHALLENGE_RETRY");
+    }
+  });
 }
 
 // src/assets/images.ts
@@ -483,7 +604,7 @@ var initCallback = () => {
 };
 function bootAd() {
   if (sdk.isReady) return;
-  emitEvent("boot");
+  emitEvent("init");
   document.body.oncontextmenu = function() {
     return false;
   };
@@ -800,7 +921,6 @@ function initSDK() {
   } else {
     startDefaultProtocol();
   }
-  emitEvent("init");
 }
 var _sdk = class _sdk {
   /**
@@ -808,6 +928,12 @@ var _sdk = class _sdk {
    * This must be called as earlier as possible.
    *
    * @param callback Optional function called when ad container is ready
+   * @param options Optional configuration options
+   * @param options.totalSuccessCount Total number of successful actions expected for progress tracking.
+   *   When set, the SDK will track success progress as a percentage and trigger
+   *   channel-specific milestone events (e.g., AppLovin: CHALLENGE_PASS_25/50/75, CHALLENGE_SOLVED).
+   *   Different channels monitor different percentage thresholds independently.
+   *   Set to 0 or omit to disable progress tracking.
    * @example
    * // Basic initialization
    * sdk.init();
@@ -817,13 +943,20 @@ var _sdk = class _sdk {
    *   new App(width, height)
    * });
    *
-   * @fires init When initialization starts
-   * @fires boot When the ad begins booting
-   * @fires ready When Ad Network is ready and playable ad can be initialized
+   * // Initialization with success count progress tracking
+   * sdk.init((width, height) => {
+   *   new App(width, height)
+   * }, { totalSuccessCount: 20 });
+   *
+   * @fires loading When SDK initialization starts
+   * @fires loaded When game instance is created and ready to load resources
    */
-  static init(callback) {
+  static init(callback, options) {
     if (isSDKInitialized) return;
     if (callback) initCallback = callback;
+    if ((options == null ? void 0 : options.totalSuccessCount) && options.totalSuccessCount > 0) {
+      setTotalInteractions(options.totalSuccessCount);
+    }
     initTrackingProtocols();
     document.readyState === "loading" ? window.addEventListener("DOMContentLoaded", initSDK) : initSDK();
     isSDKInitialized = true;
@@ -863,6 +996,22 @@ var _sdk = class _sdk {
       _sdk.resize();
     }
   }
+  /**
+   * Marks the main scene as fully loaded and ready for user interaction.
+   * Should be called at the end of your main game scene's create() method.
+   *
+   * @example
+   * // In Phaser MainScene.create()
+   * create() {
+   *   // ... all initialization code ...
+   *   sdk.interactive();
+   * }
+   *
+   * @fires interactive When the main scene is ready for user interaction
+   */
+  static interactive() {
+    emitEvent("interactive");
+  }
   /**
    * Marks the playable ad as finished.
    * This triggers network-specific completion handlers.
@@ -1037,6 +1186,60 @@ var _sdk = class _sdk {
   static resize() {
     handleResize(_sdk.maxWidth, _sdk.maxHeight);
   }
+  /**
+   * Records successful game actions (e.g., successful match, level clear).
+   * This should be called by game logic when a meaningful success occurs.
+   * This count is used for progress tracking (e.g., AppLovin milestone events).
+   *
+   * @param count Optional success count to add (default: 1)
+   * 
+   * @example
+   * // Record single success when match completes
+   * onMatchSuccess() {
+   *   sdk.recordSuccessCount();
+   * }
+   * 
+   * // Record multiple successes at once
+   * onComboMatch(comboCount) {
+   *   sdk.recordSuccessCount(comboCount);
+   * }
+   *
+   * @fires success With updated success count (triggers progress tracking)
+   */
+  static recordSuccessCount(count = 1) {
+    _sdk.successCount += count;
+    emitEvent("success", _sdk.successCount);
+  }
+  /**
+   * Records a game success/completion event.
+   * Sends platform-specific success tracking events:
+   * - AppLovin: CHALLENGE_SOLVED
+   * - Bigabid: complete
+   * - InMobi: Gameplay_Complete
+   *
+   * @example
+   * // When player completes the level
+   * onLevelComplete() {
+   *   sdk.recordSuccess();
+   * }
+   */
+  static recordSuccess() {
+    trackChallengeSuccess();
+  }
+  /**
+   * Records a game failure event.
+   * Sends platform-specific failure tracking events:
+   * - AppLovin: CHALLENGE_FAILED
+   *
+   * @example
+   * // When player fails the level
+   * onLevelFailed() {
+   *   sdk.recordFailed();
+   * }
+   */
+  static recordFailed() {
+    trackChallengeFailed();
+  }
   /**
    * Forces the playable ad into a paused state.
    *
@@ -1130,9 +1333,15 @@ var _sdk = class _sdk {
   static getCurChannel() {
     return AD_NETWORK;
   }
+  /**
+   * 判断是否是 Google
+   */
+  static isGoogle() {
+    return _sdk.getCurChannel() === "google";
+  }
 };
 /** Current version of the SDK */
-_sdk.version = "1.0.24";
+_sdk.version = "1.0.26";
 /** Current maximum width of the playable ad container in pixels */
 _sdk.maxWidth = Math.floor(window.innerWidth);
 /** Current maximum height of the playable ad container in pixels */
@@ -1149,8 +1358,12 @@ _sdk.isPaused = false;
 _sdk.isFinished = false;
 /** Current volume level (0-1) */
 _sdk.volume = actualVolume;
-/** Number of user interactions with the playable ad */
+/** Number of user interactions with the playable ad (auto-incremented on each touch/click) */
 _sdk.interactions = 0;
+/** Number of successful game actions (e.g., successful matches, level clears).
+ * Controlled by calling sdk.recordSuccessCount(), NOT auto-incremented.
+ */
+_sdk.successCount = 0;
 var sdk = _sdk;
 window["console"].log(
   `%c @tencent/playable-sdk %c v${sdk.version} `,