MagifyManager

Main API

ClientId

string ClientId { get; }

Gets the client Id generated by Magify SDK.

Application state

IsPortrait

bool IsPortrait { get; }

Indicates whether the application is currently in portrait mode (width < height).

Limits

Limits Limits { get; }

Provides access to defined application limits.

OnApplicationEnterForeground

event Action OnApplicationEnterForeground;

Triggered when the application enters the foreground (relates on native callbacks).

• iOS: always works on Unity main thread;
• Android: works in the Android main thread (if you want to use the Unity API, you need to switch to the Unity main thread. Be careful, this will take some time and can be dangerous for critical code).

OnApplicationEnterBackground

event Action OnApplicationEnterBackground;

Triggered when the application enters the background (relates on native callbacks).

• iOS: always works on Unity main thread;
• Android: works in the Android main thread (if you want to use the Unity API, you need to switch to the Unity main thread. Be careful, this will take some time and can be dangerous for critical code).

Sessions

OnSessionChanged

event Action<int> OnSessionChanged;

Triggered when the session changes due to:

• Application restart.
• The app being in the background longer than the configured SessionsInterval.
• User progress restoration.

SessionsInterval

IReactiveProperty<TimeSpan> SessionsInterval { get; }

Defines the interval between separate sessions.

SessionNumber

int SessionNumber { get; }

Returns the current session number.

Purchases

HasProcessedPurchase

bool HasProcessedPurchase(string productId)

Determines if the product with specific productId has been tracked.

OnInAppStatusChanged

event Action OnInAppStatusChanged;

Triggered when the in-app status changes.

OnSubscriptionStatusChanged

event Action OnSubscriptionStatusChanged;

Triggered when the subscription status changes.

OnPurchasedProductsChanged

event Action OnPurchasedProductsChanged;

Triggered when the list of purchased products changes.

ExternalPurchaseVerificationHandler

IReactiveProperty<IPurchaseVerificationHandler> ExternalPurchaseVerificationHandler { get; }

Allows to set and get external purchase verification handler instance.

VerificationRetryInterval

FloatReactiveProperty VerificationRetryInterval { get; }

The time in seconds between purchase verification attempts. Minimum allowed value is 1 second.

SubscriptionStatus

SubscriptionStatus SubscriptionStatus { get; set; }

Allows to set and get the subscription status.

InAppStatus

InAppStatus InAppStatus { get; set; }

Allows to set and get the in-app status.

InAppProducts

List<InAppProduct> InAppProducts { get; }

Returns a list of available in-app products.

SubscriptionProducts

List<SubscriptionProduct> SubscriptionProducts { get; }

Returns a list of available subscription products.

Segmentation and filtering

Environment

Environment Environment { get; set; }

Gets or sets the current environment.

Segmentations

IReadOnlyReactiveProperty<IReadOnlyList<string>> Segmentations { get; }

Returns a list of segmentations applicable to the user.

AssignedAbTests

IReadOnlyReactiveProperty<IReadOnlyList<AssignedAbTest>> AssignedAbTests { get; }

Returns a list of assigned A/B tests for the user.

SetAttStatus

void SetAttStatus(bool authorized)

The method tells to SDK that the user has been agreed or disagreed to app tracking transparency policy (read more).

TrackGdprAccessState

void TrackGdprAccessState(bool accessState)

Sets the user's consent to GDPR.

SetMediaSource

void SetMediaSource(
    string networkName = null,
    string campaignName = null,
    string adGroup = null
)

Optionally you can set attribution info if any. At any time when information is received, pass it to Magify SDK. This data provides information about what source the user came from.

• network - source network name
• campaign - acquisition campaign name
• adGroup - acquisition ads group name

SetUserEmail

void SetUserEmail(string email)

Sets the current user's email.

AuthorizationStatus

AuthorizationStatus AuthorizationStatus { get; set; }

Gets or sets the authorization status, which shows whether a user is authorized in your app under any account. Used in segmentation and filtering.

OnAuthorizationStatusChanged

event Action OnAuthorizationStatusChanged;

Triggered when the authorization status changes.

ReferrerId

string ReferrerId { get; set; }

Gets or sets the referrer ID.

OnReferrerChanged

event Action OnReferrerChanged;

Triggered when the referrer changes.

AdjustId

string AdjustId { get; set; }

Gets or sets the Adjust ID.

FirebaseInstanceId

string FirebaseInstanceId { get; set; }

Gets or sets the Firebase Instance ID.

FirstInstalledVersion

string FirstInstalledVersion { get; }

Gets the first installed version of the app that had Magify SDK integrated.

Visualization

Presenter

MagifyPresenter Presenter { get; }

Gives access to the current presenter instance.

Root

Transform Root { get; }

Returns the root transform that uses by Magify SDK for visual representation of campaigns.

HasDefaultCreative

bool HasDefaultCreative(ICampaignWithCreative campaign)

Will return true if creative has default version in the StreamingAssets, that might be shown.

IsRemoteCreativeDownloaded

bool IsRemoteCreativeDownloaded(ICampaignWithCreative campaign)

Will return true if remote creative has been downloaded.

IsCreativeCached

[Obsolete("Use IsRemoteCreativeDownloaded instead")]
bool IsCreativeCached(ICampaignWithCreative campaign)

SDK Lifecycle

Initialized

bool Initialized { get; }

Indicates whether the SDK has been successfully initialized.

Initialize

void Initialize(
    MagifyConfig config,
    MagifyDebugConfig debugConfig = null
)

Initializes the Magify SDK with the provided configuration.

ShutDown

void ShutDown()

Shuts down the Magify SDK and resets all event handlers.

Config Management

Sync

void Sync()

Synchronizes the SDK configuration with the backend.

OnConfigLoaded

event Action OnConfigLoaded;

Triggered when the current remote config is loaded.

RemoteConfigScopes

IReactiveProperty<ConfigScope> RemoteConfigScopes { get; }

Allows you to control scopes of config that will be loaded with the next requests to the server.

LastContextSyncTime

ContextSyncTime LastContextSyncTime { get; }

Represents the last time the config was synchronized.

User progress / Application State

SyncStateEnabled

IReactiveProperty<bool> SyncStateEnabled { get; }

Indicates whether application state synchronization is enabled.

OnRestoreStateCompleted

IObservable<SyncStateResult> OnRestoreStateCompleted { get; }

Allows you to handle successful state synchronization.

AuthorizeUser

UniTask<bool> AuthorizeUser(
    string provider,
    string token,
    CancellationToken cancellationToken
)

Requests authorization with the social authorization data.

• provider - the name of the social authorization method. You can select it yourself depends on your environment.
• token - a unique token for each user that will be associated with the current user account.
• cancellationToken - pass cancellation token if you want to cancel this operation, for example by timeout.

ResetUserAuthorization

void ResetUserAuthorization()

Resets the authorization data (provider and token) that were set earlier.

SaveState

UniTask<SyncStateResult> SaveState(
    int? weight,
    CancellationToken cancellationToken
)

Requests saving the application state.

RestoreState

UniTask<SyncStateResult> RestoreState(
    int? weight,
    CancellationToken cancellationToken
)

Requests restoring the application state.

Analytics

TrackAppLaunch

[Obsolete]
void TrackAppLaunch()

Tracks when the application is launched. Now SDK tracks application launches internally on initialization.

TrackCustomEvent

void TrackCustomEvent(
    string eventName,
    IReadOnlyDictionary<string, object> customParams = null
)

Tracks a custom event.

TrackInAppFor

void TrackInAppFor(
    string productId,
    string price,
    string currency,
    string transactionId = null,
    string purchaseToken = null,
    string originalTransactionId = null,
    string receipt = null
)

Allows you to track in-app product purchases initiated from a Magify campaign. This will track analytics, track used campaign product, initiate validation of purchase, update data for filtering and segmentation (update list of received products, InApp status change to paid).

TrackExternalInAppFor

void TrackExternalInAppFor(
    string productId,
    string price,
    string currency,
    string transactionId = null,
    string purchaseToken = null,
    string originalTransactionId = null,
    string receipt = null
)

Allows you to track in-app product purchases thar weren't initiated from a Magify campaign (if you were to implement your own purchase offer). This will track analytics, initiate validation of purchase, update data for filtering and segmentation (update list of received products, InApp status change to paid).

TrackRestoredInAppFor

void TrackRestoredInAppFor(string productId)

Allows you to track restored in-app product purchases. This will only update data for filtering and segmentation (update list of received products, InApp status change to paid), no analytics or validation (because it must have been shipped with the original purchase track).

TrackSubscriptionActivation

void TrackSubscriptionActivation(
    bool isTrial,
    string productId,
    string price,
    string currency,
    string period,
    string transactionId = null,
    string purchaseToken = null,
    string originalTransactionId = null,
    string receipt = null
)

Allows you to track subscription product purchases initiated from a Magify campaign. This will track analytics, track used campaign product, initiate validation of purchase, update data for filtering and segmentation (update list of received products).

TrackExternalSubscriptionActivation

void TrackExternalSubscriptionActivation(
    bool isTrial,
    string productId,
    string price,
    string currency,
    string transactionId = null,
    string purchaseToken = null,
    string originalTransactionId = null,
    string receipt = null
)

Allows you to track subscription product purchases thar weren't initiated from a Magify campaign (if you were to implement your own purchase offer). This will track analytics, initiate validation of purchase, update data for filtering and segmentation (update list of received products).

TrackRestoredSubscription

void TrackRestoredSubscription(string productId)

Allows you to track restored subscription product purchases. This will only update data for filtering and segmentation (update list of received products), no analytics or validation (because it must have been shipped with the original purchase track)

TrackAdsImpression

void TrackAdsImpression(
    CampaignType campaignType,
    IAdsImpression impression
)

Allows you to track analytics on ad impressions.

TrackAdsClickFor

void TrackAdsClickFor(CampaignType campaignType)

Allows you to track analytics on ad click and relevant ad campaign click (use it for ads without products, usually banner and interstitial ads).

TrackAdsProductClickFor

void TrackAdsProductClickFor(
    CampaignType campaignType,
    string productId
)

Allows you to track analytics on ad click and relevant ad campaign click with exact product (use it for ads with products, usually rewarded ads).

TrackImpression

void TrackImpression(CampaignType campaignType)

Allows you to track analytics on campaign impressions. Also affects filtering (impression limits).

TrackImpressionFailFor

void TrackImpressionFailFor(
    CampaignType campaignType,
    string reason
)

Allows you to track analytics on campaign impression fails.

TrackParentCampaignImpression

void TrackParentCampaignImpression(CampaignType campaignType)

Allows you to track analytics on campaign impressions, but only for parent (root) campaign. In meant than nested campaigns (that the same as products) impressions won't be tracked in analytics. Also affects filtering (impression limits).

For example, you have campaign with screen creative and it has a lot of products. You want to add scroll bar and not all the products are visible since creative popup is opened. Firstly you must track campaign impression without products via this method. Then the user scrolls through the list of products and each product is shown one by one. When popap is closed you should call the TrackProductsImpression with the list of seen products.

TrackProductsImpression

void TrackProductsImpression(
    CampaignType campaignType,
    List<string> productIds
)

Allows you to track analytics on product impressions of the last tracked (via TrackParentCampaignImpression) parent campaign of type campaignType.

TrackClickFor

void TrackClickFor(CampaignType campaignType)

Allows you to track analytics on campaign click. Also affects filtering (impression limits). You should use this method for clicks by campaign withoud products. This usually only makes sense for a Rate-review campaign, because clicks on other campaigns only make sense if products were obtained.

TrackProductClickFor

void TrackProductClickFor(
    CampaignType campaignType,
    string productId
)

Allows you to track analytics on campaign with products click. Also affects filtering (impression limits). You should use this method for clicks by campaign with products. For example, if you have an in-app offer campaign and user purchased the product.

TrackIncomeTransaction

void TrackIncomeTransaction(
    string source,
    List<BonusInfo> bonuses,
    ProductInfo product = null
)

Allows you to track analytics for resources that a user receives. For example, when accruing coins for passing levels, accruing boosters for watching ads. I.e. for any receipts “wallet” of the user.

TrackExpenseTransaction

void TrackExpenseTransaction(List<BonusInfo> bonuses)

Allows you to track analythics for resources that the user spends. For example, when spending coins, when using boosters. That is, for any spending from the user's “wallet”.

TrackCorrectionTransaction

void TrackCorrectionTransaction(List<BonusInfo> bonuses)

Allows you to track analytics to correct the resources the user has. For example, if a booster has a “lifetime” and the user has not used it, but the booster has disappeared (i.e. it is not an expense, but nevertheless the number has changed).

TrackRewardGranted

void TrackRewardGranted(string productId)

Allows you to track reward product obtaining initiated from a Magify campaign. This will track used campaign product, update data for filtering and segmentation (update list of received products).

TrackFreeBonusGranted

void TrackFreeBonusGranted(string productId)

Allows you to track free bonus product obtaining initiated from a Magify campaign. This will track used campaign product, update data for filtering and segmentation (update list of received products).

TrackOrdinaryProductUsed

void TrackOrdinaryProductUsed(string productId)

Allows you to track ordinary product (info, external, internal, cross-promo) obtaining initiated from a Magify campaign. This will track used campaign product, update data for filtering and segmentation (update list of received products).

Campaigns

CampaignFor

ICampaign CampaignFor(
    [NotNull] string eventName,
    CampaignRequestFlags flags,
    [CanBeNull] Dictionary<string, object> customParams = null
);
ICampaign CampaignFor(
    string eventName,
    IReadOnlyDictionary<string, object> customParams = null,
    bool silent = false
);

Requests campaign model for specific event and parameters. Also tracks this campaign, that allows you to track impressions, clicks and impression fails for this campaign.

• Use silent mode if you only want to get the campaign model as if this campaign was never requested.

IsCampaignAvailable

bool IsCampaignAvailable(
    string campaignName,
    string eventName,
    Dictionary<string, object> customParams = null
)

Checks if you can get exact campaign for specific event and parameters.

LastImpressionFor

CampaignImpression LastImpressionFor(
    CampaignType campaignType,
    string campaignName,
    string eventName
)

Returns information about the last successful tracked campaign impression.

SubscribeCampaignUpdates

void SubscribeCampaignUpdates(
    string campaignName,
    Action<ICampaign> updateAction
)

Registers a handler to modify the last successfully requested campaign.

UnsubscribeCampaignUpdates

void UnsubscribeCampaignUpdates(string campaignName)

Allows you to remove the change handler of the last successfully requested campaign.

Tweaks

Reset

void Reset(
    bool clearNativeStorage = true,
    bool clearCloudStorage = true
)

Resets all the the SDK state. Also clears specified storage options (both are using to restore ClientId between reinstalls on iOS).

ClearNativeStorage

void ClearNativeStorage()

Clears the native data storage:

• iOS: keychain;
• Android: nothing.

ResetAndForceUpdate

void ResetAndForceUpdate()

Resets the current loaded config and initiates loading a new one.

TweakAnalyticsConfig

void TweakAnalyticsConfig(
    int eventsGroupSize,
    int syncTimeInterval
)

Changes current configuration of analytics sending:

• eventsGroupSize - how many events will be collected before sending;
• syncTimeInterval - the interval between retries to send events.

TweakUserLocale

void TweakUserLocale(string languageTag)

Simulates changing the user's locale:

• iOS: works only in the current application session (resets after a cold restart);
• Android: works in the current application session. Starting with Android Nougat also sets the locale for the current app at the OS level, which must be saved between sessions.