Magify Service

Internal services

Some auxiliary functionality is encapsulated in separate classes, which can be accessed directly through the MagifyService.ServiceName. Below is a list of these services with brief descriptions:

• Advertiser: Manages advertising-related functionality;
• Subscription: Responsible for subscription info and status;
• Analytics: Responsible for sending analytics data;
• Time: Provides the current server time;
• Network: Provides information about network state;
• Prefs: Stores general values for the Magify Service.

Static

Instance

static MagifyService Instance { get; }

Provides access to current initialized Magify Service. MagifyService.Initialize(settings, args) must be called before.

Initialize

static MagifyService Initialize([NotNull] MagifySettings settings, [CanBeNull] MagifyServiceArgs args)

Initializes Magify SDK with providen settings and arguments.

Terminate

static void Terminate()

Terminates current Magify Service instance.

WaitForInitialized

static UniTask<MagifyService> WaitForInitialized(CancellationToken cancellationToken, PlayerLoopTiming timing = PlayerLoopTiming.Update)

This method allows you to wait until MagifyService is initialized and get it.

Properties

ClientId

string ClientId { get; }

The primary method of user identification in Magify SDK. Randomly generated GUID string. Used for linking analytics, saving progress and many other processes. Also, can be passed to other SDKs for linking.

Session

IReadOnlyReactiveProperty<int> Session { get; }

Stores the current session number.

SessionsInterval

IReactiveProperty<TimeSpan> SessionsInterval { get; }

Represents the current interval between sessions, that will be used to determine the new session start when player returns to the game after a long pause (when app is in background).

Environment

IReactiveProperty<Environment> Environment { get; }

Represents the current environment in which your application is running. It can have one of two values:

• Production - for the release version of your app;
• Staging - during developing and testing;

IsLoggingEnabled

IReactiveProperty<bool> IsLoggingEnabled { get; }

This property determines whether logging is turned on or off in the SKD.

ExternalPurchaseVerificationHandler

IReactiveProperty<IPurchaseVerificationHandler> ExternalPurchaseVerificationHandler

Allows you to control purchases verification process and get the result of it.

VerificationRetryInterval

FloatReactiveProperty VerificationRetryInterval

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

External handlers

SetAdsMediator

MagifyService SetAdsMediator([CanBeNull] IMinimalAdsMediator mediator)

The method allows you to tell SDK which IMinimalAdsMediator implementation to use when working with ads. Used in Advertiser.

SetPurchasingProvider

MagifyService SetPurchasingProvider([CanBeNull] IMinimalInAppStore inAppStore)

The method allows you to tell SDK which implementation of IMinimalInAppStore to use for handling InApp purchases and subscriptions.

• This method should be called right after the service initialization.
• It is and is used in Purchaser.

UseEmbeddedMaxMediator

MagifyService UseEmbeddedMaxMediator()

The method tells the SDK to use as IMinimalAdsMediator the MaxMediator implementation that is provided by the SDK out of the box. More about Applovin MAX sdk integration.

InitializeEmbeddedMaxMediator

MagifyService InitializeEmbeddedMaxMediator()

It will configure the embedded MaxMediatot implementation before tracking and showing of ads.

• UseEmbeddedMaxMediator must be called before

UseEmbeddedLevelPlayMediator

MagifyService UseEmbeddedLevelPlayMediator()

The method tells the SDK to use as IMinimalAdsMediator the LevelPlayMediator implementation that is provided by the SDK out of the box.

InitializeEmbeddedLevelPlayMediator

MagifyService InitializeEmbeddedLevelPlayMediator(bool testSuite = false)

It will configure the embedded LevelPlayMediator implementation before tracking and showing of ads.

• UseEmbeddedLevelPlayMediator must be called before

Additional API

SetAttStatus

void SetAttStatus(bool authorized)

The method tells to SDK that the user has been agreed or disagreed to iOS ATT.

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

What it would look like in the case of Adjust (read more):

var attribution = Adjust.getAttribution();
var network = attribution.network;
var campaign = attribution.campaign;
var adgroup = attribution.adgroup;
MagifyService.Instance.SetMediaSource(network, campaign, adgroup);

Reset

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

The method tells SDK to reset the current state and data that it stores on the drive. Use it only for testing. Shouldn’t use in production builds. You also can configure resetting of native SDK-related data in storage and cloud storage:

• in case of iOS: keychain & iCloud

Adnvanced integration only

Remember that you must enable advanced integration in the SDK to use the following API.

Internal Services

Some auxiliary functionality is encapsulated in separate classes, which can be accessed directly through the MagifyService.ServiceName. Below is a list of these services with brief descriptions:

• Purchaser: Handles in-app purchases;
• Obtainer: Handles obtaining in-game products by players;
• Offers: Works with limited-time offers (LTO);
• Features: Manages remote properties;
• Campaigns: Retrieves and processes campaigns;
• Presenter: Default canvas for displaying all popups;
• AppNavigator: Controls navitaion by internal links for Internal Link campaigns.

Properties

SessionStarted

IReadOnlyReactiveProperty<bool> SessionStarted { get; }

Indicates whether the RequestSessionStartAsync method has been called.

SessionsInterval (overriden)

IReadOnlyReactiveProperty<TimeSpan> SessionsInterval { get; }

Represents the current interval between sessions, that will be used to determine the new session start when player returns to the game after a long pause (when app is in background).

• The SDK automatically detects it by the SessionsInterval limit.

FirstInstalledVersion

string FirstInstalledVersion { get; }

Returns first installed version of the app (that had Magify SDK integrated).

OnConfigSynced

IObservable<Unit> OnConfigSynced { get; }

Notifies when each config is downloaded from the server.

RemoteConfigScopes

IReactiveProperty<ConfigScope> RemoteConfigScopes { get; }

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

Exceptions:

• MagifyNotInitializedException — If you try to call this method before magify has been initialized.

Remarks:

• Use None if you want to load all the content of config.
• Remember, that Segmentations and AbTests won't be included in request if None was set. You have to request them manually.
• You should realize, that ProductIds content is using by Magify SDK internally (for external purchases, subscription status and others), so you should be careful and request this scope at least once.

AuthorizationStatus

IReactiveProperty<AuthorizationStatus> AuthorizationStatus { get; }

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

StoredAppFeaturesPreloadingEnabled

bool StoredAppFeaturesPreloadingEnabled { get; set; }

Switches the preloading of stored app features. SDK might load them in background on different triggers:

• Start of new session;
• Changing of network reachability;
• Some other triggers...

ReferrerId

IReactiveProperty<string> ReferrerId { get; }

Responsible for storing the referrer identifier, which can be obtained from various sources like Facebook Deferred Deep Links.

Request Campaign

RequestSessionStartAsync

UniTask<CampaignResult> RequestSessionStartAsync(CancellationToken cancellationToken = default)

Starts a session and allows calling RequestCampaignAsync.

RequestCampaignAsync

UniTask<CampaignResult> RequestCampaignAsync(string @event, Dictionary<string, object> @params = null, CancellationToken cancellationToken = default)

Handles campaigns triggered by specific events.

• Has a lot of overrides for different cases;

External Handlers

SetAppNavigator

MagifyService SetAppNavigator([CanBeNull] IAppNavigator appNavigator)

Defines the navigator for linking from campaigns.

UseEmbeddedUnityPurchasing

MagifyService UseEmbeddedUnityPurchasing()

Uses the UnityPurchasing implementation provided by the SDK.

• Uses SetPurchasingProvider internally

Additional API

SetUserEmail

void SetUserEmail(string email)

Sets the current user's email.

Sync

void Sync()

Synchronizes config with the server.