com.amanotes.gdk 0.2.23 → 0.2.26

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.2.26 - 2023-10-30]
+- Add Ads event tracking
+- Check real internet connection
+- Add onResult callback
+- AFAdRevenue
+- Fix DebugLog config
+- Move SkAdNetwork Fetch to GameObject context menu
+- Remove IS event publisher from Ad module
+
+## [0.2.25 - 2023-10-25]
+Update Ads module: 
+- OnRewardedAvailable
+- OnRewardedUnavailable
+- OnAdImpression
+- Report internet condition in ShowAdFail
+- Polish display of ironSource config's inspector
+- Move SKAdnetwork's destination to Editor
+
 ## [0.2.23 - 2023-10-18]
 - Fix UserProfile out of main thread
 - Handle multiple Firebase's dependency check

package/Editor/AmaGDKEditor.cs

@@ -112,14 +112,14 @@ namespace Amanotes.Editor
         {
             CreateCachedEditor(configAsset, null, ref editor);
             float lbWidth = EditorGUIUtility.labelWidth;
-            EditorGUIUtility.labelWidth = 200f;
+            EditorGUIUtility.labelWidth = 220f;
             editor.OnInspectorGUI();
             EditorGUIUtility.labelWidth = lbWidth;
         }
 
         private void DrawGUI_ConfigAsset()
         {
-            EditorGUILayout.ObjectField(configAsset, configAsset.GetType(), false);
+            EditorGUILayout.ObjectField(configAsset, configAsset.GetType(), false, GUILayout.Width(EditorGUIUtility.currentViewWidth - 414), GUILayout.ExpandWidth(true));
         }
 
         private void UpdateListAdapter()

package/Editor/MatchSDKVersion.cs

@@ -142,7 +142,7 @@ namespace Amanotes.Core
 
         private static string GetSDKName(string packageName)
         {
-            return sdkToClassMap.Keys.FirstOrDefault(sdk => packageName.Contains(sdk));
+            return sdkToClassMap.Keys.FirstOrDefault(sdk => packageName.Contains(sdk)) ?? "";
         }
     }
 }

package/Editor/Utils/AmaGDKEditor.GUI.cs

@@ -63,9 +63,12 @@ namespace Amanotes.Editor
 
         public static bool Toggle(string label, ref bool value)
         {
+            float lbWidth = EditorGUIUtility.labelWidth;
+            EditorGUIUtility.labelWidth = 220f;
             bool newValue = EditorGUILayout.Toggle(label, value);
+            EditorGUIUtility.labelWidth = lbWidth;
+            
             if (newValue == value) return false;
-
             value = newValue;
             return true;
         }

package/Runtime/AmaGDK.Ads.cs

@@ -12,8 +12,7 @@ namespace Amanotes.Core
     {
         public static IAdCallback OnAdOpened(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onOpened -= callback;
             Ads.context.onOpened += callback;
             return ad;
@@ -21,8 +20,7 @@ namespace Amanotes.Core
 
         public static IAdCallback OnRewardReceived(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onRewardReceived -= callback;
             Ads.context.onRewardReceived += callback;
             return ad;
@@ -30,8 +28,7 @@ namespace Amanotes.Core
 
         public static IAdCallback OnAdClicked(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onClicked -= callback;
             Ads.context.onClicked += callback;
             return ad;
@@ -39,8 +36,7 @@ namespace Amanotes.Core
 
         public static IAdCallback OnAdShowFailed(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onShowFailed -= callback;
             Ads.context.onShowFailed += callback;
             return ad;
@@ -48,8 +44,7 @@ namespace Amanotes.Core
 
         public static IAdCallback OnAdShowSuccess(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onShowSuccess -= callback;
             Ads.context.onShowSuccess += callback;
             return ad;
@@ -57,13 +52,29 @@ namespace Amanotes.Core
 
         public static IAdCallback OnAdClosed(this IAdCallback ad, Action callback)
         {
-            if (ad == null)
-                return null;
+            if (!MakeSureAdNotNull(ad)) return null;
             Ads.context.onClosed -= callback;
             Ads.context.onClosed += callback;
             return ad;
         }
+        
+        public static IAdCallback OnAdResult(this IAdCallback ad, Action<AdResult> callback)
+        {
+            if (!MakeSureAdNotNull(ad)) return null;
+            Ads.context.onResult -= callback;
+            Ads.context.onResult += callback;
+            return ad;
+        }
 
+        private static bool MakeSureAdNotNull(IAdCallback ad)
+        {
+            bool isValid = (ad != null);
+            if (!isValid)
+            {
+                LogWarning("Something wrong:: no AdShowContext");
+            }
+            return isValid;
+        }
     }
 
     public partial class AmaGDK // Ads module
@@ -110,6 +121,7 @@ namespace Amanotes.Core
             public bool enableRewarded = true;
             public bool enableBanner = true;
             public bool autoMute = true;
+            public bool autoTimeScale = true;
             
             [Header("EDITOR")]
             [Range(0f, 1f)] public float rewardAdShowSuccessRate = 1;
@@ -123,8 +135,8 @@ namespace Amanotes.Core
             internal static AdAdapterConfig _adConfig;
             internal static IAdAdapter _adapter;
             internal static float _savedVolume = -1;
+            internal static float _savedTimeScale = -1;
             
-            public static readonly AdListener Events = new AdListener();
             internal static readonly AdsData localData = new AdsData().LoadJsonFromFile();
         }
 
@@ -255,6 +267,9 @@ namespace Amanotes.Core.Internal
         AdLogic interstitial { get; }
         AdLogic rewardVideo { get; }
 
+        void HandleBeforeAdShow();
+        void HandleAfterAdShow();
+        
         void ShowBanner(BannerPosition position);
         void HideBanner();
     }
@@ -302,10 +317,21 @@ namespace Amanotes.Core.Internal
         Banner
     }
 
+    public enum AdResult
+    {
+        None,
+        Success,
+        WifiAndCarrierDataDisable,
+        NoInternetAccess,
+        RequestTimeOut,
+        AdapterReturnError
+    }
+
     public class ShowAdContext : IAdCallback
     {
         public readonly AdType adType;
         public readonly string placementName;
+        public AdResult result = AdResult.None;
         public readonly Dictionary<string, object> userData;
         public AdCallback adCallback;
 
@@ -315,6 +341,8 @@ namespace Amanotes.Core.Internal
         internal Action onShowSuccess;
         internal Action onShowFailed;
         internal Action onClosed;
+        
+        internal Action<AdResult> onResult;
 
         // Stats
         public float showCallAt;
@@ -350,17 +378,17 @@ namespace Amanotes.Core.Internal
         {
             if (_loadState != LoadAdsState.None)
             {
-                LogWarning("StartLoadAd() --> Invalid state: " + _loadState);
+                LogWarning("[Ad] StartLoadAd() --> Invalid state: " + _loadState);
                 return;
             }
 
-            Log("StartLoadAd");
+            Log("[Ad] StartLoadAd");
             _loadRoutine = _instance.StartCoroutine(LoadAdRoutine());
         }
         
         public void StopLoadAd()
         {
-            Log("StopLoadAd");
+            Log("[Ad] StopLoadAd");
             if (_loadState == LoadAdsState.Requesting)
             {
                 _loadState = LoadAdsState.None;
@@ -375,19 +403,31 @@ namespace Amanotes.Core.Internal
         {
             if (isAdReady)
             {
+                Log("[Ad] LoadAdRoutine skipped because isAdReady = true!");
                 _loadState = LoadAdsState.Ready;
                 yield break;
             }
-
+            
+            Log("[Ad] LoadAdRoutine start(): isAdReady = " + isAdReady);
             while (true)
             {
                 yield return wait1Sec;
 
-                if (!Ads.allowAdRequest) continue;
-                if (Ads._adConfig.checkInternet && !hasInternet) continue;
+                if (!Ads.allowAdRequest)
+                {
+                    Log("[Ad] LoadAdRoutine: allowAdRequest = false");
+                    continue;
+                }
+                
+                if (Ads._adConfig.checkInternet && !HasLocalNetworkConnection)
+                {
+                    Log("[Ad] LoadAdRoutine: hasInternet = " + HasLocalNetworkConnection);
+                    continue;
+                }
 
                 _loadState = LoadAdsState.Requesting;
                 _isRequesting = true;
+                Log("[Ad] LoadAdRoutine: RequestAd()");
                 RequestAd();
 
                 int timeout = Ads._adConfig.adLoadTimeoutInSecs;
@@ -402,22 +442,24 @@ namespace Amanotes.Core.Internal
 
                 if (counter > timeout && timeout > 0) // timeout
                 {
+                    Log("[Ad] LoadAdRoutine: RequestAd not responding (timeout) " + timeout + " secs");
                     continue;
                 }
 
                 // request should be completed here!
                 if (!isAdReady)
                 {
-                    LogWarning("Request complete but failed!");
+                    LogWarning($"[Ad] Request complete but failed! (load duration = {counter} secs)");
                     continue;
                 }
 
                 _loadState = LoadAdsState.Ready;
+                Log($"[Ad] LoadAdRoutine: Ad is ready! (load duration = {counter} secs)");
                 yield break;
             }
         }
 
-        bool hasInternet => Application.internetReachability != NetworkReachability.NotReachable;
+        bool HasLocalNetworkConnection => Application.internetReachability != NetworkReachability.NotReachable;
 
         // Override by actual Ad instance
         protected abstract AdType adType { get; }
@@ -453,7 +495,7 @@ namespace Amanotes.Core.Internal
                 _loadState = LoadAdsState.None;
                 StartLoadAd();
             }
-            RestoreVolume();
+            HandleAfterAdShow();
             if (_showAdRoutine == null) return;
             _instance.StopCoroutine(_showAdRoutine);
             _showAdRoutine = null;
@@ -461,6 +503,9 @@ namespace Amanotes.Core.Internal
 
         IEnumerator ShowAdRoutine()
         {
+            // Wait 1 frame so that all AdCallback to register
+            yield return null;
+            
             // Wait for Ad
             if (!isAdReady)
             {
@@ -470,11 +515,25 @@ namespace Amanotes.Core.Internal
                     _loadState = LoadAdsState.None;
                 }
 
-                if (Ads._adConfig.checkInternet && !hasInternet)
+                if (Ads._adConfig.checkInternet)
                 {
-                    _showState = ShowAdsState.ShowFail;
-                    ShowAdRoutineCompleted(false);
-                    yield break;
+                    if (!HasLocalNetworkConnection)
+                    {
+                        _showState = ShowAdsState.ShowFail;
+                        Ads.context.result = AdResult.WifiAndCarrierDataDisable;
+                        ShowAdRoutineCompleted(false);
+                        yield break;
+                    }
+
+                    var hasInternet = false;
+                    yield return WebUtils.CheckInternet(result => hasInternet = result);
+                    if (!hasInternet)
+                    {
+                        _showState = ShowAdsState.ShowFail;
+                        Ads.context.result = AdResult.NoInternetAccess;
+                        ShowAdRoutineCompleted(false);
+                        yield break;
+                    }
                 }
 
                 if (_loadState != LoadAdsState.Requesting) StartLoadAd();
@@ -492,7 +551,7 @@ namespace Amanotes.Core.Internal
 
                 if (!isAdReady)
                 {
-                    Ads.Events.OnShowTimeout?.Invoke();
+                    Ads.context.result = AdResult.RequestTimeOut;
                     ShowAdRoutineCompleted(false);
                     yield break;
                 }
@@ -501,11 +560,7 @@ namespace Amanotes.Core.Internal
             _showState = ShowAdsState.Showing;
             // Ad should be ready here!
             ShowAd();
-            if (Ads._adConfig.autoMute && AudioListener.volume > 0 && Ads._savedVolume == -1)
-            {
-                Ads._savedVolume = AudioListener.volume;
-                AudioListener.volume = 0;
-            }
+            HandleBeforeAdShow();
             
             ShowAdContext context = Ads.context;
             while (!context.potentiallyCompleted)
@@ -557,8 +612,11 @@ namespace Amanotes.Core.Internal
             }
             
             _showState = isSuccess ? ShowAdsState.ShowSuccess : ShowAdsState.ShowFail;
+            // Extra callback
+            if (isSuccess) Ads.context.result = AdResult.Success;
+            Ads.context.onResult?.Invoke(Ads.context.result);
             Ads.context.showFinishAt = Time.realtimeSinceStartup;
-
+            
             var localData = Ads.localData;
             var stat = _isInterstitial ? localData.interstitial : localData.reward;
             if (isSuccess)
@@ -574,19 +632,61 @@ namespace Amanotes.Core.Internal
             }
 
             localData.Save();
-            RestoreVolume();
+            HandleAfterAdShow();
             
             Log($"[Ad] {adType} ShowAdRoutineCompleted: {isSuccess}\n{JsonUtility.ToJson(Ads.context)}");
             Ads.context = null;
             _showState = ShowAdsState.None;
         }
-
-        private void RestoreVolume()
+        
+        private void HandleBeforeAdShow()
         {
-            if (!Ads._adConfig.autoMute || Ads._savedVolume <= 0)
-                return;
-            AudioListener.volume = Ads._savedVolume;
-            Ads._savedVolume = -1;
+            bool willSaveVolume = Ads._adConfig.autoMute
+                && AudioListener.volume > 0
+                && Ads._savedVolume < 0;
+            
+            bool willSaveTimeScale = Ads._adConfig.autoTimeScale
+                && Time.timeScale > 0
+                && Ads._savedTimeScale < 0;
+            
+            if (willSaveVolume)
+            {
+                Ads._savedVolume = AudioListener.volume;
+                AudioListener.volume = 0;
+            }
+            
+            if (willSaveTimeScale)
+            {
+                Ads._savedTimeScale = Time.timeScale;
+                Ads._savedTimeScale = Time.timeScale;
+            }
+            
+            Ads._adapter.HandleBeforeAdShow();
+        }
+        
+        private void HandleAfterAdShow()
+        {
+            bool willRestoreVolume = Ads._adConfig.autoMute
+                && AudioListener.volume == 0
+                && Ads._savedVolume > 0;
+            
+            bool willRestoreTimeScale = Ads._adConfig.autoTimeScale
+                && Time.timeScale == 0
+                && Ads._savedTimeScale > 0;
+            
+            if (willRestoreVolume)
+            {
+                AudioListener.volume = Ads._savedVolume;
+                Ads._savedVolume = -1;
+            }
+            
+            if (willRestoreTimeScale)
+            {
+                Time.timeScale = Ads._savedTimeScale;
+                Ads._savedTimeScale = -1;
+            }
+            
+            Ads._adapter.HandleAfterAdShow();
         }
 
         // Default implementation
@@ -601,13 +701,8 @@ namespace Amanotes.Core.Internal
             }
             else
             {
-                LogWarning("OnAdClosed() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdClosed() Something wrong - No AdContext");
             }
-
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialClosed?.Invoke();
-            else
-                Ads.Events.OnRewardedClosed?.Invoke();
         }
 
         protected void OnAdClicked()
@@ -621,14 +716,8 @@ namespace Amanotes.Core.Internal
             }
             else
             {
-                LogWarning("OnAdClicked() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdClicked() Something wrong - No AdContext");
             }
-
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialClicked?.Invoke();
-            else
-                Ads.Events.OnRewardedClicked?.Invoke();
-
         }
 
         protected void OnAdShowFailed()
@@ -638,18 +727,13 @@ namespace Amanotes.Core.Internal
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Fail;
+                Ads.context.result = AdResult.AdapterReturnError;
                 Ads.context.onShowFailed?.Invoke();
             }
             else
             {
-                LogWarning("OnAdShowFailed() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdShowFailed() Something wrong - No AdContext");
             }
-
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialShowFailed?.Invoke();
-            else
-                Ads.Events.OnRewardedShowFailed?.Invoke();
-
         }
 
         protected void OnAdShowSucceeded()
@@ -663,12 +747,8 @@ namespace Amanotes.Core.Internal
             }
             else
             {
-                LogWarning("OnAdShowSucceeded() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdShowSucceeded() Something wrong - No AdContext");
             }
-
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialShowSucceeded?.Invoke();
-
         }
 
         protected void OnAdOpen()
@@ -682,13 +762,8 @@ namespace Amanotes.Core.Internal
             }
             else
             {
-                LogWarning("OnAdOpen() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdOpen() Something wrong - No AdContext");
             }
-
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialOpened?.Invoke();
-            else
-                Ads.Events.OnRewardedOpened?.Invoke();
         }
 
         protected void OnAdReward()
@@ -702,11 +777,8 @@ namespace Amanotes.Core.Internal
             }
             else
             {
-                LogWarning("OnAdReward() Something wrong - No AdContext");
+                LogWarning("[Ad] OnAdReward() Something wrong - No AdContext");
             }
-
-            if (!_isInterstitial)
-                Ads.Events.OnRewardedReceived?.Invoke();
         }
 
         protected void OnAdLoadSuccess()
@@ -715,39 +787,15 @@ namespace Amanotes.Core.Internal
             
             if (!_isRequesting)
             {
-                LogWarning("Something wrong? OnAdReady called when no ad is loading!");
+                LogWarning("[Ad] Something wrong? OnAdReady called when no ad is loading! AdType=" + adType);
             }
 
             _isRequesting = false;
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialLoadSucceeded?.Invoke();
         }
 
         protected void OnAdLoadFailed(string error)
         {
             Log($"[Ad] {adType} OnAdLoadFailed: {error}");
-            
-            if (_isInterstitial)
-                Ads.Events.OnInterstitialLoadFailed?.Invoke(error);
         }
     }
-
-    public class AdListener
-    {
-        public Action OnRewardedOpened;
-        public Action OnRewardedReceived;
-        public Action OnRewardedClicked;
-        public Action OnRewardedShowFailed;
-        public Action OnRewardedClosed;
-
-        public Action OnInterstitialOpened;
-        public Action OnInterstitialShowSucceeded;
-        public Action OnInterstitialShowFailed;
-        public Action OnInterstitialClicked;
-        public Action OnInterstitialClosed;
-        public Action OnInterstitialLoadSucceeded;
-        public Action<string> OnInterstitialLoadFailed;
-
-        public Action OnShowTimeout;
-    }
 }

package/Runtime/AmaGDK.Config.cs

@@ -82,20 +82,19 @@ namespace Amanotes.Core.Internal
         }
 #endif
     }
-
-    [Flags]
+    
     public enum LogLevel
     {
-        None = 0,
-        Error = 1,
-        Warning = 2,
-        Verbose = 4
+        None,
+        Error,
+        Warning,
+        Verbose
     }
 
     [Serializable]
     public partial class SDKConfig
     {
-        public LogLevel logLevel = LogLevel.Warning | LogLevel.Error;
+        public LogLevel logLevel = LogLevel.Warning;
     }
 
     [Serializable]

package/Runtime/AmaGDK.Internal.cs

@@ -68,7 +68,7 @@ namespace Amanotes.Core.Internal
 
         public static void LogWarningOnce(string message, string key = null)
         {
-            if ((Config.common.logLevel & LogLevel.Warning) == 0) return;
+            if (Config.common.logLevel < LogLevel.Warning) return;
             if (string.IsNullOrEmpty(key)) key = message;
             if (logWarningDict.Contains(key)) return;
             logWarningDict.Add(key);
@@ -76,15 +76,15 @@ namespace Amanotes.Core.Internal
         }
         public static void LogWarning(string message)
         {
-            if ((Config.common.logLevel & LogLevel.Warning) != 0) Debug.LogWarning($"AmaGDK {message}");
+            if (Config.common.logLevel >= LogLevel.Warning) Debug.LogWarning($"AmaGDK {message}");
         }
         public static void LogError(string message)
         {
-            if ((Config.common.logLevel & LogLevel.Error) != 0) Debug.LogError($"AmaGDK {message}");
+            if (Config.common.logLevel >= LogLevel.Error) Debug.LogError($"AmaGDK {message}");
         }
         public static void Log(string message)
         {
-            if ((Config.common.logLevel & LogLevel.Verbose) != 0) Debug.Log($"AmaGDK {message}");
+            if (Config.common.logLevel == LogLevel.Verbose) Debug.Log($"AmaGDK {message}");
         }
     }
 

package/Runtime/AmaGDK.WebUtils.cs

@@ -28,6 +28,7 @@ namespace Amanotes.Core.Internal
             {
                 SetRequestHeader(kvp.Key, kvp.Value);
             }
+
             return this;
         }
 
@@ -95,12 +96,14 @@ namespace Amanotes.Core.Internal
 
     internal class WebUtils
     {
-        public static Coroutine PostJson(string url, string jsonData, Action<bool, string> onComplete = null, Dictionary<string, string> headers = null)
+        public static Coroutine PostJson(string url, string jsonData, Action<bool, string> onComplete = null,
+            Dictionary<string, string> headers = null)
         {
             return AmaGDK._instance.StartCoroutine(PostJsonCoroutine(url, jsonData, onComplete, headers));
         }
 
-        private static IEnumerator PostJsonCoroutine(string url, string jsonData, Action<bool, string> onComplete = null, Dictionary<string, string> headers = null)
+        private static IEnumerator PostJsonCoroutine(string url, string jsonData,
+            Action<bool, string> onComplete = null, Dictionary<string, string> headers = null)
         {
             var webRequest = new UnityWebRequest(url, "POST");
             if (headers != null)
@@ -125,5 +128,29 @@ namespace Amanotes.Core.Internal
                 onComplete?.Invoke(true, webRequest.downloadHandler.text);
             }
         }
+
+        public static void CheckInternetConnection(Action<bool> hasInternet)
+        {
+            AmaGDK._instance.StartCoroutine(CheckInternet(hasInternet));
+        }
+
+        public static IEnumerator CheckInternet(Action<bool> hasInternet)
+        {
+            UnityWebRequest www = new UnityWebRequest(AmaGDK.Config.common.internetCheckUrl);
+            yield return www.SendWebRequest();
+
+            if (www.error != null && www.responseCode != 429) //429 = Too many requests
+            {
+                hasInternet?.Invoke(false);
+                yield break;
+            }
+
+            hasInternet?.Invoke(true);
+        }
+    }
+
+    public partial class SDKConfig
+    {
+        public string internetCheckUrl = "http://www.google.com";
     }
 }

package/Runtime/AmaGDK.cs

@@ -14,7 +14,7 @@ namespace Amanotes.Core
 {
     public partial class AmaGDK : MonoBehaviour
     {
-        public const string VERSION = "0.2.23";
+        public const string VERSION = "0.2.26";
 
         internal static AmaGDK _instance;
         internal static Status _status = Status.None;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "com.amanotes.gdk",
-    "version": "0.2.23",
+    "version": "0.2.26",
     "displayName": "AmaGDK",
     "description": "Amanotes Game Development Kit",
     "unity": "2019.4",