English 中文TürkçeРусскийEspañol日本語Tiếng Việt

Миграция Adapty Unity SDK на v3.3

Adapty SDK 3.3.0 — это мажорный релиз, который принёс ряд улучшений, однако для перехода на него может потребоваться выполнить несколько шагов миграции.

  1. Обновитесь до Adapty SDK v3.3.x.
  2. Переименованы несколько классов, свойств и методов в модулях Adapty и AdaptyUI Adapty SDK.
  3. Теперь метод SetLogLevel принимает callback в качестве аргумента.
  4. Теперь метод PresentCodeRedemptionSheet принимает callback в качестве аргумента.
  5. Изменён способ создания представления пейвола.
  6. Метод GetProductsIntroductoryOfferEligibility удалён.
  7. Сохраняйте резервные пейволы в отдельные файлы (по одному на платформу) в Assets/StreamingAssets/ и передавайте имена файлов в метод SetFallbackPaywalls.
  8. Обновлено выполнение покупки.
  9. Обновлена обработка событий Paywall Builder.
  10. Обновлена обработка ошибок пейвола Paywall Builder.
  11. Обновлены конфигурации интеграций для Adjust, Amplitude, AppMetrica, Appsflyer, Branch, Firebase и Google Analytics, Mixpanel, OneSignal, Pushwoosh.
  12. Обновлена реализация режима Observer.
  13. Обновлена инициализация плагина Unity с явным вызовом Activate.

Обновление Adapty Unity SDK до версии 3.3.x

До этой версии Adapty SDK был основным и обязательным SDK для корректной работы Adapty в вашем приложении, а AdaptyUI SDK — опциональным, который требовался только при использовании Adapty Paywall Builder.

Начиная с версии 3.3.0, AdaptyUI SDK объявлен устаревшим, а AdaptyUI объединён с Adapty SDK в виде модуля. В связи с этими изменениями вам нужно удалить AdaptyUI SDK и переустановить Adapty SDK.

  1. Удалите зависимости пакетов AdaptySDK и AdaptyUISDK из вашего проекта.
  2. Удалите папки AdaptySDK и AdaptyUISDK.
  3. Повторно импортируйте пакет AdaptySDK, как описано на странице Установка и настройка Adapty SDK для Unity.

Переименования

  1. Переименования в модуле Adapty:

    Старая версияНовая версия
    Adapty.sdkVersionAdapty.SDKVersion
    Adapty.LogLevelAdaptyLogLevel
    Adapty.PaywallAdaptyPaywall
    Adapty.PaywallFetchPolicyAdaptyPaywallFetchPolicy
    PaywallProductAdaptyPaywallProduct
    Adapty.ProfileAdaptyProfile
    Adapty.ProfileParametersAdaptyProfileParameters
    ProfileGenderAdaptyProfileGender
    ErrorAdaptyError

  2. Переименования в модуле AdaptyUI:

    Старая версияНовая версия
    CreatePaywallViewCreateView
    PresentPaywallViewPresentView
    DismissPaywallViewDismissView
    AdaptyUI.ViewAdaptyUIView
    AdaptyUI.ActionAdaptyUIUserAction

Изменение метода SetLogLevel

Теперь метод SetLogLevel принимает callback в качестве аргумента.

- Adapty.SetLogLevel(Adapty.LogLevel.Verbose);
+ Adapty.SetLogLevel(Adapty.LogLevel.Verbose, null); // or you can pass the callback to handle the possible error

Изменение метода PresentCodeRedemptionSheet

Теперь метод PresentCodeRedemptionSheet принимает callback в качестве аргумента.

- Adapty.PresentCodeRedemptionSheet();
+ Adapty.PresentCodeRedemptionSheet(null); // or you can pass the callback to handle the possible error

Изменение способа создания вида пейвола

Полный пример кода см. в разделе Получение конфигурации вида пейвола, созданного с помощью Paywall Builder.

+ var parameters = new AdaptyUICreateViewParameters()
+   .SetPreloadProducts(true);

- AdaptyUI.CreatePaywallView(
+ AdaptyUI.CreateView(
   paywall, 
-  preloadProducts: true,
+  parameters,
  (view, error) => {
  // use the view
});

Удаление метода GetProductsIntroductoryOfferEligibility

До Adapty iOS SDK 3.3.0 объект продукта всегда содержал офферы, независимо от того, имел ли пользователь право на их получение. Вам приходилось вручную проверять это право перед использованием оффера.

Теперь объект продукта содержит оффер только в том случае, если пользователь имеет право на его получение. Это означает, что проверка права больше не нужна — если оффер присутствует, пользователь имеет на него право.

Обновлённый метод передачи резервных пейволов

До этой версии резервные пейволы передавались в виде сериализованного JSON. Начиная с версии 3.3.0, механизм изменился:

  1. Сохраните резервные пейволы в файлы в /Assets/StreamingAssets/ — один файл для Android и один для iOS.
  2. Передайте имена файлов в метод SetFallbackPaywalls.

Ваш код изменится следующим образом:

using AdaptySDK;

void SetFallBackPaywalls() {

+ #if UNITY_IOS
+   var assetId = "adapty_fallback_ios.json";
+ #elif UNITY_ANDROID
+   var assetId = "adapty_fallback_android.json";
+ #else
+   var assetId = "";
+ #endif

-   Adapty.SetFallbackPaywalls("FALLBACK_PAYWALLS_JSON_STRING", (error) => {
+   Adapty.SetFallbackPaywalls(assetId, (error) => {
    // handle the error
  });
}

Полный пример кода смотрите на странице Использование резервных пейволов в Unity.

Обновление процесса покупки

Ранее отменённые и ожидающие покупки считались ошибками и возвращали коды PaymentCancelled и PendingPurchase соответственно.

Теперь для обработки отменённых, успешных и ожидающих покупок используется новый класс AdaptyPurchaseResultType. Обновите код покупки следующим образом:

using AdaptySDK;

void MakePurchase(AdaptyPaywallProduct product) {
- Adapty.MakePurchase(product, (profile, error) => {
-   // handle successfull purchase
+ Adapty.MakePurchase(product, (result, error) => {
+   switch (result.Type) {
+     case AdaptyPurchaseResultType.Pending:
+       // handle pending purchase
+       break;
+     case AdaptyPurchaseResultType.UserCancelled:
+       // handle purchase cancellation
+       break;
+     case AdaptyPurchaseResultType.Success:
+       var profile = result.Profile;
+       // handle successful purchase
+       break;
+     default:
+       break;
    }
  });
}

Ознакомьтесь с финальным примером кода на странице Совершение покупок в мобильном приложении.

Обновите обработку событий Paywall Builder

Отменённые и ожидающие покупки больше не считаются ошибками — все эти случаи обрабатываются методом PaywallViewDidFinishPurchase.

  1. Удалите обработку события отменённой покупки.

  2. Обновите обработку события успешной покупки следующим образом:

   - public void OnFinishPurchase(
   -   AdaptyUI.View view, 
   -   Adapty.PaywallProduct product, 
   -   Adapty.Profile profile
   - ) { }
   
   + public void PaywallViewDidFinishPurchase(
   +   AdaptyUIView view, 
   +   AdaptyPaywallProduct product, 
   +   AdaptyPurchaseResult purchasedResult
   + ) { }

  1. Обновите обработку действий:

    - public void OnPerformAction(
-   AdaptyUI.View view, 
-   AdaptyUI.Action action
- ) {
+ public void PaywallViewDidPerformAction(
+   AdaptyUIView view, 
+   AdaptyUIUserAction action
+ ) {
    switch (action.Type) {
-     case AdaptyUI.ActionType.Close:
+     case AdaptyUIUserActionType.Close:
        view.Dismiss(null);
        break;
-     case AdaptyUI.ActionType.OpenUrl:
+     case AdaptyUIUserActionType.OpenUrl:
        var urlString = action.Value;
        if (urlString != null {
        	Application.OpenURL(urlString); 
        }
      default:
        // handle other events
        break;
    }
}

  2. Обновите обработку начала покупки:

    - public void OnSelectProduct(
-   AdaptyUI.View view, 
-   Adapty.PaywallProduct product
- ) { }

+ public void PaywallViewDidSelectProduct(
+   AdaptyUIView view, 
+   string productId
+ ) { }

  3. Обновите обработку ошибки покупки:

   - public void OnFailPurchase(
   -   AdaptyUI.View view, 
   -   Adapty.PaywallProduct product, 
   -   Adapty.Error error
   - ) { }
   
   + public void PaywallViewDidFailPurchase(
   +   AdaptyUIView view, 
   +   AdaptyPaywallProduct product, 
   +   AdaptyError error
   + ) { }
  1. Обновите обработку события успешного восстановления покупок: Ознакомьтесь с финальным примером кода на странице Обработка событий пейвола.

Обновление обработки ошибок пейвола в Paywall Builder

Обработка ошибок также изменилась — обновите свой код согласно инструкциям ниже.

  1. Обновите обработку ошибок загрузки продуктов:

    - public void OnFailLoadingProducts(
-   AdaptyUI.View view, 
-   Adapty.Error error
- ) { }

+ public void PaywallViewDidFailLoadingProducts(
+   AdaptyUIView view, 
+   AdaptyError error
+ ) { }

  2. Обновите обработку ошибок рендеринга:

    - public void OnFailRendering(
-   AdaptyUI.View view, 
-   Adapty.Error error
- ) { }

+ public void PaywallViewDidFailRendering(
+   AdaptyUIView view, 
+   AdaptyError error
+ ) { }

Обновление конфигурации SDK сторонних интеграций

Начиная с Adapty Unity SDK 3.3.0, публичный API метода updateAttribution обновлён. Ранее он принимал словарь [AnyHashable: Any], позволяя передавать объекты атрибуции напрямую из различных сервисов. Теперь он требует [String: any Sendable], поэтому перед передачей объекты атрибуции необходимо конвертировать.

Чтобы интеграции корректно работали с Adapty Unity SDK 3.3.0 и выше, обновите конфигурации SDK для следующих интеграций, как описано в разделах ниже.

Adjust

Обновите код мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе Настройка SDK для интеграции с Adjust.

- using static AdaptySDK.Adapty;
 using AdaptySDK;

 Adjust.GetAdid((adid) => {
-   Adjust.GetAttribution((attribution) => {
-     Dictionary<String, object> data = new Dictionary<String, object>();
-
-     data["network"] = attribution.Network;
-     data["campaign"] = attribution.Campaign;
-     data["adgroup"] = attribution.Adgroup;
-     data["creative"] = attribution.Creative;
-
-     String attributionString = JsonUtility.ToJson(data);
-     Adapty.UpdateAttribution(attributionString, AttributionSource.Adjust, adid, (error) => {
-       // handle the error
-     });
+   if (adid != null) {
+     Adapty.SetIntegrationIdentifier(
+       "adjust_device_id", 
+       adid, 
+       (error) => {
+         // handle the error
+     });
    }
 });

 Adjust.GetAttribution((attribution) => {
   Dictionary<String, object> data = new Dictionary<String, object>();

   data["network"] = attribution.Network;
   data["campaign"] = attribution.Campaign;
   data["adgroup"] = attribution.Adgroup;
   data["creative"] = attribution.Creative;

   String attributionString = JsonUtility.ToJson(data);
    
-   Adapty.UpdateAttribution(attributionString, AttributionSource.Adjust, adid, (error) => {
+   Adapty.UpdateAttribution(attributionString, "adjust", (error) => {
       // handle the error
   });
 });

Amplitude

Обновите код своего мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе Настройка SDK для интеграции с Amplitude.

using AdaptySDK;
- var builder = new Adapty.ProfileParameters.Builder();
- builder.SetAmplitudeUserId("YOUR_AMPLITUDE_USER_ID");
- builder.SetAmplitudeDeviceId(amplitude.getDeviceId());

- Adapty.UpdateProfile(builder.Build(), (error) => {
-     // handle error
- });

+ Adapty.SetIntegrationIdentifier(
+   "amplitude_user_id", 
+   "YOUR_AMPLITUDE_USER_ID", 
+   (error) => {
+   // handle the error
+ });

+ Adapty.SetIntegrationIdentifier(
+   "amplitude_device_id", 
+   amplitude.getDeviceId(), 
+   (error) => {
+   // handle the error
+ });

AppMetrica

Обновите код мобильного приложения, как показано ниже. Полный пример кода можно найти в разделе Настройка SDK для интеграции с AppMetrica.

using AdaptySDK;

- var deviceId = AppMetrica.GetDeviceId();

- if (deviceId != null {
-   var builder = new Adapty.ProfileParameters.Builder();

-   builder.SetAppmetricaProfileId("YOUR_ADAPTY_CUSTOMER_USER_ID");
-   builder.SetAppmetricaDeviceId(deviceId);

-   Adapty.UpdateProfile(builder.Build(), (error) => {
-       // handle error
-   });
- }

+ var deviceId = AppMetrica.GetDeviceId();

+ if (deviceId != null {
+   Adapty.SetIntegrationIdentifier(
+     "appmetrica_device_id", 
+     deviceId, 
+     (error) => {
+     // handle the error
+   });
+   
+   Adapty.SetIntegrationIdentifier(
+     "appmetrica_profile_id", 
+     "YOUR_ADAPTY_CUSTOMER_USER_ID", 
+     (error) => {
+     // handle the error
+   });
+ }

AppsFlyer

Обновите код мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе Настройка SDK для интеграции с AppsFlyer.

 using AppsFlyerSDK;
 using AdaptySDK;

 // before SDK initialization
 AppsFlyer.getConversionData(this.name);

 // in your IAppsFlyerConversionData
 void onConversionDataSuccess(string conversionData) {
     // It's important to include the network user ID
-    string appsFlyerId = AppsFlyer.getAppsFlyerId();
-    Adapty.UpdateAttribution(conversionData, AttributionSource.Appsflyer, appsFlyerId, (error) => {
+    string appsFlyerId = AppsFlyer.getAppsFlyerId();
+    
+    Adapty.SetIntegrationIdentifier(
+      "appsflyer_id", 
+      appsFlyerId, 
+      (error) => {
         // handle the error
     });
+    
+    Adapty.UpdateAttribution(
+      conversionData, 
+      "appsflyer",
+      (error) => {
+        // handle the error
+      });
 }

Branch

Обновите код мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе настройки SDK для интеграции Branch.

using AdaptySDK;

- class YourBranchImplementation {
-     func initializeBranch() {
-         Branch.getInstance().initSession(launchOptions: launchOptions) { (data, error) in
-             if let data {
-                 Adapty.updateAttribution(data, source: .branch)
-             }
-         }
-     }
- }

+ Branch.initSession(delegate(Dictionary<string, object> parameters, string error) {
+     string attributionString = JsonUtility.ToJson(parameters);
+     
+     Adapty.UpdateAttribution(
+       attributionString, 
+       "branch", 
+       (error) => {
+         // handle the error
+       });
+ });

Firebase и Google Analytics

Обновите код мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе Настройка SDK для интеграции с Firebase и Google Analytics.

 // We suppose FirebaseAnalytics Unity Plugin is already installed

 using AdaptySDK;

 Firebase.Analytics
   .FirebaseAnalytics
   .GetAnalyticsInstanceIdAsync()
   .ContinueWithOnMainThread((task) => {
     if (!task.IsCompletedSuccessfully) {
       // handle error
       return;
     }

     var firebaseId = task.Result
     var builder = new Adapty.ProfileParameters.Builder();
     
-    builder.SetFirebaseAppInstanceId(firebaseId);
-
-    Adapty.UpdateProfile(builder.Build(), (error) => {
-        // handle error
   
+     Adapty.SetIntegrationIdentifier(
+       "firebase_app_instance_id", 
+       firebaseId, 
+       (error) => {
+         // handle the error
     });
   });

Mixpanel

Обновите код мобильного приложения, как показано ниже. Полный пример кода можно найти в разделе настройка SDK для интеграции с Mixpanel.

using AdaptySDK;

- var builder = new Adapty.ProfileParameters.Builder();
- builder.SetMixpanelUserId(Mixpanel.DistinctId);

- Adapty.UpdateProfile(builder.Build(), (error) => {
-     // handle error
- });

+ var distinctId = Mixpanel.DistinctId;

+ if (distinctId != null) {
+   Adapty.SetIntegrationIdentifier(
+     "mixpanel_user_id", 
+     distinctId, 
+     (error) => {
+       // handle the error
+   });
+ }

OneSignal

Обновите код мобильного приложения, как показано ниже. Полный пример кода смотрите в разделе Настройка SDK для интеграции с OneSignal.

using AdaptySDK;

- using OneSignalSDK;

- var pushUserId = OneSignal.Default.PushSubscriptionState.userId;

- var builder = new Adapty.ProfileParameters.Builder();
- builder.SetOneSignalPlayerId(pushUserId);

- Adapty.UpdateProfile(builder.Build(), (error) => {
-     // handle error
- });

+ var distinctId = Mixpanel.DistinctId;

+ if (distinctId != null) {
+   Adapty.SetIntegrationIdentifier(
+     "mixpanel_user_id", 
+     distinctId, 
+     (error) => {
+       // handle the error
+   });
+ }

Pushwoosh

Обновите код вашего мобильного приложения, как показано ниже. Полный пример кода см. в разделе Настройка SDK для интеграции с Pushwoosh.

using AdaptySDK;

- var builder = new Adapty.ProfileParameters.Builder();
- builder.SetPushwooshHWID(Pushwoosh.Instance.HWID);

- Adapty.UpdateProfile(builder.Build(), (error) => {
-     // handle error
- });

+ Adapty.SetIntegrationIdentifier(
+   "pushwoosh_hwid", 
+   Pushwoosh.Instance.HWID, 
+   (error) => {
+   // handle the error
+ });

Обновите реализацию режима Observer

Обновите способ привязки пейволов к транзакциям. Раньше для назначения variationId использовался метод setVariationId. Теперь variationId можно передавать напрямую при регистрации транзакции через новый метод reportTransaction. Смотрите итоговый пример кода в разделе Привязка пейволов к транзакциям покупки в режиме Observer.

 // every time when calling transaction.finish()
- Adapty.SetVariationForTransaction("<variationId>", "<transactionId>", (error) => { 
-     if(error != null) {
-         // handle the error
-         return;
-     }
-
-     // successful binding
- });

+ Adapty.ReportTransaction(
+   "YOUR_TRANSACTION_ID", 
+   "PAYWALL_VARIATION_ID", // optional
+   (error) => {
+   // handle the error
+ });

Обновление инициализации плагина Unity

Начиная с Adapty Unity SDK 3.3.0, при инициализации плагина необходимо явно вызывать метод Activate:

Adapty.Activate(builder.Build(), (error) => {
   if (error != null) {
       // handle the error
       return;
   }
});