com.amanotes.gdk 0.2.47 → 0.2.49

package/Runtime/AmaGDK.Ads.cs

@@ -9,6 +9,8 @@ using static Amanotes.Core.AmaGDK;
 
 namespace Amanotes.Core
 {
+    
+    
     public static class AdExtension
     {
         public static IAdCallback OnAdOpened(this IAdCallback ad, Action callback)
@@ -18,7 +20,7 @@ namespace Amanotes.Core
             Ads.context.onOpened += callback;
             return ad;
         }
-
+        
         public static IAdCallback OnRewardReceived(this IAdCallback ad, Action callback)
         {
             if (!MakeSureAdNotNull(ad)) return null;
@@ -26,7 +28,7 @@ namespace Amanotes.Core
             Ads.context.onRewardReceived += callback;
             return ad;
         }
-
+        
         public static IAdCallback OnAdClicked(this IAdCallback ad, Action callback)
         {
             if (!MakeSureAdNotNull(ad)) return null;
@@ -34,7 +36,7 @@ namespace Amanotes.Core
             Ads.context.onClicked += callback;
             return ad;
         }
-
+        
         public static IAdCallback OnAdShowFailed(this IAdCallback ad, Action callback)
         {
             if (!MakeSureAdNotNull(ad)) return null;
@@ -42,7 +44,7 @@ namespace Amanotes.Core
             Ads.context.onShowFailed += callback;
             return ad;
         }
-
+        
         public static IAdCallback OnAdShowSuccess(this IAdCallback ad, Action callback)
         {
             if (!MakeSureAdNotNull(ad)) return null;
@@ -50,7 +52,7 @@ namespace Amanotes.Core
             Ads.context.onShowSuccess += callback;
             return ad;
         }
-
+        
         public static IAdCallback OnAdClosed(this IAdCallback ad, Action callback)
         {
             if (!MakeSureAdNotNull(ad)) return null;
@@ -99,6 +101,27 @@ namespace Amanotes.Core
     }
     public partial class AmaGDK // Ads module
     {
+        public static partial class Event
+        {
+            public const string INTER_REQUEST = nameof(INTER_REQUEST);
+            public const string INTER_SHOW_CALLED = nameof(INTER_SHOW_CALLED);
+            public const string INTER_SHOW_READY = nameof(INTER_SHOW_READY);
+            public const string INTER_SHOW_NOT_READY = nameof(INTER_SHOW_NOT_READY); // reason: string
+            public const string INTER_SHOW_BEGIN = nameof(INTER_SHOW_BEGIN); // always call result: true / false
+            public const string INTER_SHOW_END = nameof(INTER_SHOW_END); // always call result: true / false
+        
+            public const string REWARD_REQUEST = nameof(REWARD_REQUEST);
+            public const string REWARD_VIDEO_SHOW_CALLED = nameof(REWARD_VIDEO_SHOW_CALLED);
+            public const string REWARD_VIDEO_SHOW_READY = nameof(REWARD_VIDEO_SHOW_READY);
+            public const string REWARD_VIDEO_SHOW_NOT_READY = nameof(REWARD_VIDEO_SHOW_NOT_READY); // reason: string
+            // public const string REWARD_VIDEO_REWARD_GRANTED = nameof(REWARD_VIDEO_REWARD_GRANTED);
+            public const string REWARD_VIDEO_SHOW_BEGIN = nameof(REWARD_VIDEO_SHOW_BEGIN); // always call result: true / false
+            public const string REWARD_VIDEO_SHOW_END = nameof(REWARD_VIDEO_SHOW_END); // always call result: true / false
+
+            public const string BANNER_SHOW = nameof(BANNER_SHOW);
+        }
+        
+        
         [Serializable]
         internal class AdStat
         {
@@ -177,6 +200,41 @@ namespace Amanotes.Core
             internal protected static AdAdapter _adapter;
             internal protected static float _savedVolume = -1;
             internal protected static float _savedTimeScale = -1;
+            
+            public static void OnInter_Request(Action callback)
+            {
+                dispatcher.AddListener(Event.INTER_REQUEST, callback, false);
+            }
+
+            public static void OnInter_ShowCalled(Action callback)
+            {
+                dispatcher.AddListener(Event.INTER_SHOW_CALLED, callback, false);
+            }
+        
+            public static void OnReward_ShowCalled(Action callback)
+            {
+                dispatcher.AddListener(Event.REWARD_VIDEO_SHOW_CALLED, callback, false);
+            }
+            
+            public static void OnInter_ShowReady(Action callback)
+            {
+                dispatcher.AddListener(Event.INTER_SHOW_READY, callback, false);
+            }
+        
+            public static void OnReward_ShowReady(Action callback)
+            {
+                dispatcher.AddListener(Event.REWARD_VIDEO_SHOW_READY, callback, false);
+            }
+        
+            public static void OnInter_ShowNotReady(Action<AdShowReadyStatus> callback)
+            {
+                dispatcher.AddListener(Event.INTER_SHOW_NOT_READY, callback, false);
+            }
+        
+            public static void OnReward_ShowNotReady(Action<AdShowReadyStatus> callback)
+            {
+                dispatcher.AddListener(Event.REWARD_VIDEO_SHOW_NOT_READY, callback, false);
+            }
         }
 
         public partial class Ads // Public
@@ -247,10 +305,11 @@ namespace Amanotes.Core
 
                 if (_adapter == null)
                 {
-                    //Debug.LogWarning("Adapter not found???");
                     return;
                 }
                 
+                
+                dispatcher.Dispatch(Event.BANNER_SHOW);
                 _adapter.ShowBanner(_showingBannerPosition);
             }
 
@@ -344,8 +403,6 @@ namespace Amanotes.Core.Internal
         public abstract void HideBanner();
 
         // Internally used
-        internal protected abstract void HandleBeforeAdShow();
-        internal protected abstract void HandleAfterAdShow();
         internal protected abstract void SetUserId(string userId);
     }
     
@@ -524,6 +581,9 @@ namespace Amanotes.Core.Internal
                 _isRequesting = true;
                 Log("[Ad] LoadAdRoutine: RequestAd()");
                 RequestAd();
+                dispatcher.Dispatch(
+                    _isInterstitial ? AmaGDK.Event.INTER_REQUEST : AmaGDK.Event.REWARD_REQUEST
+                );
 
                 int timeout = Config.ad.adLoadTimeoutInSecs;
                 var counter = 0;
@@ -581,7 +641,9 @@ namespace Amanotes.Core.Internal
             AdStat stat = Ads.localData.GetStat(adType);
             stat.callCount++;
             stat.lastCallTime = Time.realtimeSinceStartup;
-            OnAdShowCalled();
+            dispatcher.Dispatch(
+                _isInterstitial ? AmaGDK.Event.INTER_SHOW_CALLED : AmaGDK.Event.REWARD_VIDEO_SHOW_CALLED
+            );
 
             if (_showAdRoutine != null) _instance.StopCoroutine(_showAdRoutine);
             _showAdRoutine = _instance.StartCoroutine(ShowAdRoutine());
@@ -597,7 +659,7 @@ namespace Amanotes.Core.Internal
                 StartLoadAd();
             }
 
-            HandleAfterAdShow();
+            TriggerOnAfterAdShow();
             if (_showAdRoutine == null) return;
             _instance.StopCoroutine(_showAdRoutine);
             _showAdRoutine = null;
@@ -682,10 +744,9 @@ namespace Amanotes.Core.Internal
 
             _showState = ShowAdsState.Showing;
             OnAdShowReadyStatus(true, AdShowReadyStatus.Ready);
-            HandleBeforeAdShow();
+            TriggerBeforeAdShow();
             ShowAd();
-
-            AdShowContext context = Ads.context;
+            
             while (!context.potentiallyCompleted)
             {
                 yield return null; // callback as quickly as possible
@@ -750,14 +811,14 @@ namespace Amanotes.Core.Internal
             }
 
             localData.Save();
-            HandleAfterAdShow();
+            TriggerOnAfterAdShow();
 
             Log($"[Ad] {adType} ShowAdRoutineCompleted: {isSuccess}\n{JsonUtility.ToJson(Ads.context)}");
             Ads.context = null;
             _showState = ShowAdsState.None;
         }
 
-        private void HandleBeforeAdShow()
+        private void TriggerBeforeAdShow()
         {
             bool willSaveVolume = Config.ad.autoMute
                 && AudioListener.volume > 0
@@ -779,11 +840,11 @@ namespace Amanotes.Core.Internal
                 Time.timeScale = 0;
             }
 
+            dispatcher.Dispatch(_isInterstitial ? AmaGDK.Event.INTER_SHOW_BEGIN : AmaGDK.Event.REWARD_VIDEO_SHOW_BEGIN);
             Ads.context.onBeforeAdOpen?.Invoke();
-            Ads._adapter.HandleBeforeAdShow();
         }
 
-        private void HandleAfterAdShow()
+        private void TriggerOnAfterAdShow()
         {
             bool willRestoreVolume = Config.ad.autoMute
                 && AudioListener.volume == 0
@@ -804,8 +865,9 @@ namespace Amanotes.Core.Internal
                 Time.timeScale = Ads._savedTimeScale;
                 Ads._savedTimeScale = -1;
             }
-
-            Ads._adapter.HandleAfterAdShow();
+            
+            bool isSuccess = _showState == ShowAdsState.ShowSuccess;
+            dispatcher.Dispatch(_isInterstitial ? AmaGDK.Event.INTER_SHOW_END : AmaGDK.Event.REWARD_VIDEO_SHOW_END, isSuccess);
         }
 
         // Default implementation
@@ -877,20 +939,18 @@ namespace Amanotes.Core.Internal
             Ads.context.onAdShowReadyStatus?.Invoke(status);
             if (status == AdShowReadyStatus.Ready)
             {
-                OnAdShowReady();
+                dispatcher.Dispatch(
+                    _isInterstitial ? AmaGDK.Event.INTER_SHOW_READY : AmaGDK.Event.REWARD_VIDEO_SHOW_READY
+                );
             } else if (status == AdShowReadyStatus.NoInternet || status == AdShowReadyStatus.TimeOut || status == AdShowReadyStatus.Wifi3GDisabled)
             {
-                OnAdShowNotReady(status);
+                dispatcher.Dispatch(
+                    _isInterstitial ? AmaGDK.Event.INTER_SHOW_NOT_READY : AmaGDK.Event.REWARD_VIDEO_SHOW_NOT_READY,
+                    status
+                );
             }
         }
-
-        protected virtual void OnAdShowCalled()
-        { }
-        protected virtual void OnAdShowReady()
-        { }
-        protected virtual void OnAdShowNotReady(AdShowReadyStatus status)
-        { }
-
+        
         protected void OnAdOpen()
         {
             Log($"[Ad] {adType} OnAdOpen");

package/Runtime/AmaGDK.Analytics.cs

@@ -26,6 +26,7 @@ namespace Amanotes.Core
                 public string funnelSignature;
                 public bool accumulated;
                 public bool withinSession;
+                public bool doNotIncreaseCounter;
 
                 public bool overrideConfig;
                 public HashSet<string> ignoreAdapterIds = new HashSet<string>();
@@ -241,11 +242,15 @@ namespace Amanotes.Core
             internal static readonly List<AnalyticsAdapter> listAdapters = new List<AnalyticsAdapter>();
             internal static readonly AnalyticsData localData = new AnalyticsData().LoadJsonFromFile();
             internal static readonly SessionStat sessionStat = new SessionStat();
-            internal static AnalyticsAdapter primaryAdapter;
-            internal static readonly HashSet<string> blackListPrefixes = new HashSet<string>() {
-                "firebase_", "google_", "ga_"
+
+            internal static readonly Dictionary<string, string> reservedPrefixes = new Dictionary<string, string>()
+            {
+                { "firebase_", "frb_" },
+                { "google_", "ggl_" },
+                { "ga_", "gga_" }
             };
-            internal static readonly HashSet<string> blackListEvents = new HashSet<string>()
+
+            internal static readonly HashSet<string> reservedEvents = new HashSet<string>()
             {
                 "ad_activeview",
                 "ad_click",
@@ -284,8 +289,6 @@ namespace Amanotes.Core
             {
                 listAdapters.Clear();
                 listAdapters.AddRange(Adapter2.GetAllAdapter<AnalyticsAdapter>());
-                if (listAdapters.Count != 0)
-                    primaryAdapter = listAdapters.Find(a => a.adapterId == AdapterID.FIREBASE_ANALYTICS) ?? listAdapters[0];
             }
 
             internal static void StartModule()
@@ -320,19 +323,34 @@ namespace Amanotes.Core
                         UpdateAccumulatedCount(eventData, countInSession, totalCount);
                     }
 
-                    eventData.AddParam("ama_device_id", User.AmaDeviceId);
+                    if (!eventData.parameters.ContainsKey("ama_device_id"))
+                        eventData.AddParam("ama_device_id", User.AmaDeviceId);
                     
                     string eventNameToSend = GetEventNameToSend(eventData.eventName, countInSession, totalCount);
                     if (config.normalizeEventName) NormalizeEventName(ref eventNameToSend);
 
-                    if (showAnalyticsLog) Debug.Log($"AmaGDK | [Analytics] Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
+                    if (showAnalyticsLog)
+                    {
+                        Debug.Log($"AmaGDK [Analytics] Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
+                    }
                     
                     config.quality.CheckEventQuality(eventData.eventName, eventData.parameters);
 
                     var inUseAdapterIDs = new List<string>();
                     foreach (AnalyticsAdapter m in listAdapters)
                     {
-                        if (IsAdapterForbidden(m, eventData)) continue;
+                        if (eventData.overrideConfig)
+                        {
+                            // IMPORTANT NOTE:
+                            //
+                            // Once set overrideConfig, we should skip the adapter config completely!!!
+                            //
+                            if (eventData.IsAdapterForbidden(m.adapterId)) continue;
+                        }
+                        else // Do not remove else
+                        {
+                            if (m.IsForbidden(eventData.eventName)) continue;
+                        }
                         m.LogEvent(eventNameToSend, eventData.parameters);
                         inUseAdapterIDs.Add(m.adapterId);
                     }
@@ -356,35 +374,18 @@ namespace Amanotes.Core
                 }
 
                 int.TryParse(eventData.parameters[ACCUMULATED_COUNT].ToString(), out int oriAccCount);
-                if (oriAccCount == countByGDK)
-                {
-                    eventData.AddParam(ACCUMULATED_COUNT, countByGDK);
-                }
-                else
+                if (oriAccCount != countByGDK)
                 {
                     LogWarning($"[Analytics] event <{eventData.eventName}> has difference in accumulated count. Original count: {oriAccCount}. AmaGDK count: {countByGDK}");
+                    if (Config.analytics.migrateAccumulatedCount && !eventData.withinSession)
+                    {
+                        Log($"[Analytics] Update event count of event <{eventData.eventName}> from {countByGDK} to {oriAccCount}");
+                        eventData.EventDetail.totalCount = oriAccCount;
+                        localData._dirty = true;
+                    }
                 }
             }
 
-            internal static bool IsAdapterForbidden(AnalyticsAdapter adapter, EventParams eventData)
-            {
-                if (adapter == null) return false;
-                if (eventData.overrideConfig)
-                {
-                    // IMPORTANT NOTE:
-                    //
-                    // Once set overrideConfig, we should skip the adapter config completely!!!
-                    //
-                    if (eventData.IsAdapterForbidden(adapter.adapterId)) return true;
-                }
-                else // Do not remove else
-                {
-                    if (adapter.IsForbidden(eventData.eventName)) return true;
-                }
-
-                return false;
-            }
-
             internal static string GetEventNameToSend(string eventName, int countInSession, int totalCount)
             {
                 if (!sendAtCount.TryGetValue(eventName, out var config)) return eventName;
@@ -401,14 +402,14 @@ namespace Amanotes.Core
                     StringBuilder sb = tmpWarningSB;
                     sb.Clear();
                     NormalizeKeyString(ref eventName, sb, dryRun);
-                    if (blackListEvents.Contains(eventName))
+                    if (reservedEvents.Contains(eventName))
                         sb.AppendLine($" - EventName <{eventName}> is reserved and should not be used");
                     if (sb.Length > 0 && dryRun) LogWarningOnce($"Warning for event name <{eventName}>:\n{sb}", $"NormalizeEventName<{eventName}>");    
                 }
                 Profiler.EndSample();
             }
 
-            internal static void NormalizeKeyString(ref string key, StringBuilder warningLog, bool dryRun = false)
+            internal static void NormalizeKeyString(ref string key, StringBuilder warningLog, bool dryRun)
             {
                 Profiler.BeginSample("AmaGDK.Analytics.NormalizeEventName()");
                 {
@@ -418,47 +419,53 @@ namespace Amanotes.Core
                         Profiler.EndSample();
                         return;
                     }
+
+                    var sb = new StringBuilder();
                     
                     string normalizedString = key.Trim()
                         .Replace(' ', '_')
                         .Replace('-', '_');
-
                     if (key != normalizedString)
                     {
-                        if (!dryRun)
-                        {
-                            key = normalizedString;
-                        } else
-                        {
-                            warningLog.AppendLine($" - Malformed name (should not contains <space> or <dash>): <{key}>");
-                        }
+                        sb.Append($" - Malformed name (should not contains <space> or <dash>): <{key}>");    
                     }
 
                     var r = new Regex("^[a-zA-Z0-9_]*$");
                     if (!r.IsMatch(normalizedString))
                     {
-                        warningLog.AppendLine($" - Name may only contain alphanumeric characters and underscores");
+                        normalizedString = Regex.Replace(normalizedString, "[^a-zA-Z0-9_]", "");
+                        sb.Append(" - Name may only contain alphanumeric characters and underscores");
                     }
 
-                    if (!char.IsLetter(key[0]))
+                    if (!char.IsLetter(normalizedString[0]))
                     {
-                        warningLog.AppendLine($" - Name must start with a letter: <{key}> ");
+                        normalizedString = "E" + normalizedString;
+                        sb.Append($" - Name must start with a letter: <{key}> ");
                     }
 
-                    foreach (var prefix in blackListPrefixes)
+                    foreach (var prefix in reservedPrefixes)
                     {
-                        if (!normalizedString.StartsWith(prefix)) continue;
-                        warningLog.AppendLine($" - <{key}> starts with reserved prefix <{prefix}>");
+                        if (!normalizedString.StartsWith(prefix.Key)) continue;
+                        normalizedString = prefix.Value + normalizedString.Remove(0, prefix.Key.Length);
+                        sb.AppendLine($" - <{key}> starts with reserved prefix <{prefix}>");
                     }
 
-                    if (key.Length > 40)
+                    if (normalizedString.Length > 40)
+                    {
+                        sb.AppendLine($" - Name is too long ({key.Length} > 40): <{key}> ");
+                        normalizedString = normalizedString.Substring(0, 40);
+                    }
+                    
+                    if (dryRun)
                     {
-                        warningLog.AppendLine($" - Name is too long ({key.Length} > 40): <{key}> ");
+                        warningLog.Append(sb);
+                    } else {
+                        key = normalizedString;
                     }
                 }
                 Profiler.EndSample();
             }
-
+            
             internal static bool ShouldSendEvent(EventParams eventData)
             {
                 //Funnel event
@@ -609,8 +616,7 @@ namespace Amanotes.Core
                 internal (int countInSession, int totalCount) IncreaseCounter(EventParams eventParams)
                 {
                     EventDetail result = GetEventDetail(eventParams.eventName, true);
-                    if (IsAdapterForbidden(primaryAdapter, eventParams))
-                        return (result.countInSession, result.totalCount);
+                    if (eventParams.doNotIncreaseCounter) return (result.countInSession, result.totalCount);
                     result.countInSession++;
                     result.totalCount++;
                     _dirty = true;
@@ -708,6 +714,15 @@ namespace Amanotes.Core
             return ap;
         }
 
+        public static IEventParamsBuilder SkipAccumulatedCount(this IEventParamsBuilder ap)
+        {
+            if (ap == null) return null;
+            
+            var data = ap as EventParams;
+            data!.doNotIncreaseCounter = true;
+            return ap;
+        }
+
         public static IEventParamsBuilder Except(this IEventParamsBuilder ap, params string[] analyticIds)
         {
             if (ap == null) return null;
@@ -759,7 +774,7 @@ namespace Amanotes.Core
         public static IEventParamsBuilder AddParam(this IEventParamsBuilder ap, string key, object value)
         {
             if (ap == null) return null;
-            if (!IsValidKeyValue(ap, key, value)) return ap;
+            if (!IsValidKeyValue(ap, ref key, ref value)) return ap;
 
             var eventParams = ap as EventParams;
             Dictionary<string, object> parameters = eventParams?.parameters;
@@ -789,10 +804,12 @@ namespace Amanotes.Core
                 return ap;
             }
 
-            foreach (KeyValuePair<string, object> kvp in dictParams)
+            foreach (var kvp in dictParams)
             {
-                if (IsValidKeyValue(ap, kvp.Key, kvp.Value))
-                    ap.AddParam(kvp.Key, kvp.Value);
+                var key = kvp.Key;
+                var value = kvp.Value;
+                if (IsValidKeyValue(ap, ref key, ref value))
+                    ap.AddParam(key, value);
             }
             return ap;
         }
@@ -808,33 +825,48 @@ namespace Amanotes.Core
 
             foreach (var kvp in parameters)
             {
-                if (IsValidKeyValue(ap, kvp.key, kvp.value))
-                    ap.AddParam(kvp.key, kvp.value);
+                var key = kvp.key;
+                var value = kvp.value;
+                if (IsValidKeyValue(ap, ref key, ref value))
+                    ap.AddParam(key, value);
             }
             return ap;
         }
 
         //https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param
-        private static bool IsValidKeyValue(IEventParamsBuilder ap, string key, object value)
+        private static bool IsValidKeyValue(IEventParamsBuilder ap, ref string key, ref object value)
         {
             string eventName = (ap as EventParams)?.eventName;
             
             StringBuilder sb = tmpWarningSB;
             sb.Clear();
-            NormalizeKeyString(ref key, sb);
-            if (sb.Length > 0) LogWarningOnce($"Warning for event <{eventName}>, param <{key}>:\n{sb}", $"NormalizeParamKey<{eventName}>");
+            NormalizeKeyString(ref key, sb, AmaGDK.Config.analytics.normalizeEventName);
+            
+            if (sb.Length > 0) LogWarningOnce($"Warning for event <{eventName}>, param <{key}>:\n{sb}", $"NormalizeParamKey <{eventName}>");
             
             if (string.IsNullOrWhiteSpace(key))
             {
                 LogWarning($"Param key is empty. Event name: {eventName}!");
                 return false;
             }
+            
             if (value == null)
             {
-                LogWarning($"Param value of key <{key}> is null. Event name: {eventName}!");
+                LogWarning($"Param value is null. Event name: {eventName}, key: {key}!");
                 return false;
             }
 
+            if (value.GetType() == typeof(string))
+            {
+                var v = value.ToString();
+                var strLimit = 100;
+                if (v.Length > strLimit)
+                {
+                    value = v.Substring(0, strLimit);
+                    LogWarning($"Param value exceeds the length limit ({strLimit}). Event name: {eventName}, key: {key}!");    
+                }
+            }
+
             return true;
         }
     }
@@ -848,6 +880,7 @@ namespace Amanotes.Core.Internal
         public bool showAnalyticsLog = true;
         public bool normalizeEventName = true;
         public bool checkMigrationIntegrity = true;
+        public bool migrateAccumulatedCount = true;
         public bool enableEventStat;
         public AnalyticQualityConfig quality;
     }