Ad Quality SDK integration guides

The Ad Quality SDK enables you to run Ad Quality in your app. It automatically collects all the ad events and attributes needed from the ad network SDKs you currently use. This makes the integration simple and requires minimal coding.

Important! Make sure you’ve added at least one app to your ironSource account before you integrate the Ad Quality SDK.

Step 1: Import the Ad Quality SDK to your app

  1. Use the following download link to add the Unity3D Package to your project:
  2. Make sure your Unity3D project is open and import the Unity3D package.
  3. Double-click on the extracted file. The different files will be populated automatically as shown below:
    Go to: Assets → External Dependency Manager → Android Resolver → Resolve

Important! For an android integration, make sure you use the “Resolve” process.
This will download all relevant artifacts, according to your choices.

Go to: Assets → External Dependency Manager → Android Resolver → Resolve

Step 2: Initialize the SDK

  1. Initialize the Ad Quality SDK using your ironSource app key, which can be found in the platform under Settings.
  2. Add the following code to your app’s main thread, or on the same thread as your other ad network SDKs to initialize the Ad Quality SDK:

Add the following code to the Awake method of your first scene:

void Awake ()
{
   // Initialize
   IronSourceAdQuality.Initialize(appKey);
}

Step 3: Advanced SDK Initialization

Customize your integration settings to get even more functionality with these special configurations:

  1. User ID – Use your own user IDs, instead of the default IDs from Ad Quality
  2. Test mode – Test your Ad Quality SDK integration (default is false)
  3. Log level – Choose a log level to debug code issues (default is INFO)

Use the code below to create your config object with a builder.

Note: All of the following attributes are optional

Add the following code in the Awake method of your first scene:

ISAdQualityConfig adQualityConfig = new ISAdQualityConfig();

User ID

adQualityConfig.UserId = userId;
// The default user id is Ad Quality internal id.
// The only allowed characters for user id are: letters, numbers, @, -, :, =,_ and /.
// The user id cannot be null and must be between 2 and 100 characters, otherwise it will be blocked.

Test Mode

adQualityConfig.TestMode = true;
// The default is false - set to true only to test your Ad Quality integration

Log level

adQualityConfig.LogLevel = ISAdQualityLogLevel.INFO;
// There are 5 different log levels:
// ERROR, WARNING, INFO, DEBUG, VERBOSE
// The default is INFO
IronSourceAdQuality.Initialize(appKey, adQualityConfig);

Configure your user IDs

Using your existing user IDs will streamline the way you manage users across platforms.
If you initialize the Ad Quality SDK without your user IDs, Ad Quality will set default user IDs.

The Ad Quality SDK provides two options for configuring your user IDs:

1.Use your own user IDs, and add them before or during initialization:

AdQualityConfig.UserId = userId;

2.Change the default user IDs after initializing the Ad Quality SDK:

IronSourceAdQuality.ChangeUserId(userId);

Step 4: Configure SDK callback events

Unity3d callbacks should be implemented in a separate class, in the same place where the Ad Quality SDK was initialized.

public class AdQualitySdkInit: ISAdQualityInitCallback {

   public void adQualitySdkInitSuccess() {
       Debug.Log("unity: adQualitySdkInitSuccess");
   }
   public void adQualitySdkInitFailed(ISAdQualityInitError adQualitySdkInitError, string errorMessage) {
       Debug.Log("unity: adQualitySdkInitFailed " + adQualitySdkInitError + " message: " + errorMessage);
   }
}

AdQualitySdkInit adQualitySdkInit = new AdQualitySdkInit();
ISAdQualityConfig adQualityConfig = new ISAdQualityConfig {
   AdQualityInitCallback = adQualitySdkInit
};

IronSourceAdQuality.Initialize(appKey, adQualityConfig);

Note:   The time it takes s to initialize the Ad Quality SDK depends on the number of ad network SDKs integrated into your app. Network connectivity issues may also cause delays. On average, initializations take between 3 – 4 seconds.

Step 5 (optional): Managing GDPR consent

The Ad Quality SDK supports publisher communication of a user’s consent choice in accordance with GDPR regulations.
Use the following function to update a user’s consent status using the Ad Quality API:
If the user-provided consent, set the flag to true:

IronSourceAdQuality.SetUserConsent(true):