This document explains how to install and activate the VIS.X® SDK in your native Android app. If you are using React Native for your app, make sure to check out our React Native module. Please also ensure to check out our Getting Started guide first, to familiarize yourself with the features and formats and start the integration process afterward.

After the installation is done, you may continue with Banner and/or Interstitial integration to display ads and complete the integration process.

1. Steps for adding the SDK to your project
2. Permissions
3. Initializing the SDK with backend configuration
4. Understanding Remote Configuration

Steps for adding the SDK to your project

The VIS.X® SDK for Android can be installed via gradle using the official maven repository, by adding mavenCentral() inside the root build.gradle of your app/project.

buildscript { 
    repositories {
        ...
        mavenCentral()
    }
}

Next, open your application’s module build.gradle and add our VIS.X® SDK as a dependency.

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar"])
    implementation 'com.yoc.visx.sdk:visx-sdk:4.1.3@aar'
    implementation 'androidx.recyclerview:recyclerview:1.1.0'
    implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
}

In case you want to install the SDK manually, the latest builds are also accessible in our public git repository and the latest aar-file can be found here.

Permissions

Add the following lines as child nodes in your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Initializing the SDK with backend configuration

VisxSDK is a singleton class and is used for the initial SDK configuration, receiving configurational information from the VIS.X® backend. While not mandatory, it’s highly recommended to set it up before performing any ad call. We recommend initialization be done in the application context rather than the activity context.

The required configuration id will be provided during the technical onboarding of our service teams.

class App : Application() {

    override fun onCreate() {
		// ...
        VisxSDK.initialize(applicationContext, yourConfigurationId)
    }
}

Understanding Remote Configuration

Remote Configuration was introduced by YOC to provide publishers with additional convenience in setting up, commissioning and maintaining the SDK in the published app without requiring another release for every change.

The YOC Service Team can also use Remote Configuration to create and provide additional diagnostic data to publishers when needed, as well as temporarily or permanently disable features for specific user groups.