SDK integration

Requirements

• Android Gradle Plugin: 8.9.1 or higher (Gradle 8.11.1 or higher)
• Compile SDK: 36 or higher
• Kotlin: 2.2 or higher
• Minimum SDK: 24 or higher

Caution

These minimums come from the ad networks bundled with the SDK. Older versions of the Android Gradle Plugin fail the build with an AAR metadata error, and Kotlin compilers below 2.2 cannot read the metadata of the Google Mobile Ads SDK.

Setup project

Depending on the language used by the project for the Gradle scripts, you must follow the steps from the corresponding tab:

Groovy

First, you need to add the following Maven repositories inside the repositories block of the settings.gradle file:

Note

In the projects which still use an old structure, the repositories block can be found on the build.gradle file located at the app-level.

repositories {
    maven { url 'https://maven.wortise.com/artifactory/public' }

    maven { url 'https://artifact.bytedance.com/repository/pangle' }
    maven { url 'https://artifactory.bidmachine.io/bidmachine' }
}

Once added, you can proceed to integrate the SDK. To do so, you have to add the following line inside the dependencies block of the build.gradle file located at the app-level:

implementation 'com.wortise:android-sdk:1.8.0'

If not already have it, you need to activate the Java 8 compatibility in the project. This can be achieved by adding these extra lines inside the android block, also in the same build.gradle file:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

Kotlin

First, you need to add the following Maven repositories inside the repositories block of the settings.gradle.kts file:

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://maven.wortise.com/artifactory/public") }

        maven { url = uri("https://artifact.bytedance.com/repository/pangle") }
        maven { url = uri("https://artifactory.bidmachine.io/bidmachine") }
    }
}

Once added, you can proceed to integrate the SDK. To do so, you have to add the following line inside the dependencies block of the build.gradle.kts file located at the app-level:

implementation("com.wortise:android-sdk:1.8.0")

If not already have it, you need to activate the Java 8 compatibility in the project. This can be achieved by adding these extra lines inside the android block, also in the same build.gradle.kts file:

compileOptions {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
}

Setup Manifest

You need to add the following <meta-data> element in the AndroidManifest.xml file, inside the <application> block, with Google’s application ID as value:

<manifest>
    ...
    <application>
        ...
        <meta-data
            android:name="com.google.android.gms.ads.APPLICATION_ID"
            android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
    </application>
</manifest>

Note

This value can be found in our dashboard, inside the app details, under the name Google App ID.

Request consent

Tip

It is strongly recommended to request the user consent to be able to show personalised ads. This will let us display content of more interest and generate higher revenues.

You can consult the following section to implement this request and obtain the user consent: User consent

Initialize SDK

Our recommendation is to initialize the SDK in the Application class of the app, but it can also be done in any main Activity.

To do so, it is necessary to integrate the following code in the onCreate method:

Kotlin

WortiseSdk.initialize(this, "your app key")

Java

WortiseSdk.initialize(this, "your app key");

Initialization listener

There are two possible ways to know when the SDK finishes its initialization:

Passing a listener as the last parameter of the method WortiseSdk.initialize

Kotlin

WortiseSdk.initialize(this, "your app key") {
    // This listener will be invoked when the initialization finishes
}

Java

WortiseSdk.initialize(this, "your app key", () -> {
    // This listener will be invoked when the initialization finishes
    return Unit.INSTANCE;
});

Using the method WortiseSdk.wait

Kotlin

WortiseSdk.wait {
    // This listener will be invoked when the initialization finishes
}

Java

WortiseSdk.wait(() -> {
    // This listener will be invoked when the initialization finishes
    return Unit.INSTANCE;
});

Test mode

To verify the integration, the SDK provides a test mode that allows the app to always receive ads.

In addition to the option that is available in our dashboard, you can programmatically enable this test mode, from the SDK itself, by using the following code:

Kotlin

AdSettings.testEnabled = true

Java

AdSettings.setTestEnabled(true);