Install SDK

1. Introduction

This guide provides a comprehensive walkthrough for integrating the MyChips SDK into your Android application, enabling the display of an engaging offerwall.

2. Prerequisites

• Android Studio

• Minimum version requirement 27.

3. SDK Integration

3.1 Adding the SDK

Kotlin DSL

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        maven {
            url = uri("https://europe-west1-maven.pkg.dev/mychips-b31fe/mychips-android-sdk")
        }
    }
}

Groovy

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven("https://europe-west1-maven.pkg.dev/mychips-b31fe/mychips-android-sdk")
    }
}

For Kotlin DSL Projects: In your project-level setting.gradle.kts

For Groovy-Based Projects: In your project-level build.gradle

3.2 Adding the SDK Dependency to App-Level Build File

In your app-level build.gradle(Module :app) file, add the following dependency

Kotlin DSL

dependencies { 
  implementation("io.mychips:offerwall:+") 
  // Other dependencies...
}

Groovy

dependencies {
 implementation 'io.mychips:offerwall:+' 
 // Other dependencies... 
}

3.3 Configuring the Android Manifest

In your AndroidManifest.xml, add the following:

Permission for Internet Access:

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

Activity Declaration:

<activity android:name="io.mychips.offerwall.controller.MCOfferwallActivity"
            android:theme="@style/Theme.AppCompat.NoActionBar"/>

4. Initializing the SDK

In your main activity’s onCreate method, import and initialize the SDK:

Kotlin

import io.mychips.offerwall.MCOfferwallSDK
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // Replace 'YOUR_API_KEY'
        MCOfferwallSDK.Init(this, "YOUR_API_KEY") 
        
    }
}

Java

import io.mychips.offerwall.sdk.MCOfferwallSDK;
// ...public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Replace 'YOUR_API_KEY' 
        MCOfferwallSDK.Init(this,"YOUR_API_KEY");
        
    }
}

Obtain your API key and User ID from Universal Developer Portal

4.1 (Mandatory) Set Google AdvertisingId

Improve the reward tracking by passing the advertising id. Official documentation

MCOfferwallSDK.SetAdvertisingId("HERE YOUR Google Advertising ID");

4.2(Optional) Set userId if you have your own unique id

  MCOfferwallSDK.SetUserId("HERE YOUR USER ID");

Replace "HERE YOUR USER ID" with your actual user ID variable or value.

If you do not provide a specific user ID, one will be automatically generated.

4.3 (Optional) Set Custom Parameters (aff_sub1–aff_sub5 )

We provide 5 aff_sub parameters (aff_sub1, aff_sub2, aff_sub3, aff_sub4, aff_sub5), which you can use to pass custom values.

MCOfferwallSDK.setAffSub1("HERE YOUR CUSTOM VALUE");
MCOfferwallSDK.setAffSub2("HERE YOUR CUSTOM VALUE");
MCOfferwallSDK.setAffSub3("HERE YOUR CUSTOM VALUE");
MCOfferwallSDK.setAffSub4("HERE YOUR CUSTOM VALUE");
MCOfferwallSDK.setAffSub5("HERE YOUR CUSTOM VALUE");

Replace "HERE YOUR CUSTOM VALUE" with your actual custom value.

5. Display the Offerwall

5.1 How to Display the Offerwall

Replace ‘AD_UNIT_ID’ with your actual Ad unit ID.

In your main activity’s onCreate method, import and initialize the SDK:

Kotlin

val mc = MCOfferwallController(this)
mc.Show("AD_UNIT_ID")

Java

MCOfferwallController mc = new MCOfferwallController(this);
mc.Show("AD_UNIT_ID");

Your Ad unit ID can be found at link

5.2 (Optional) How to Set the Title on the Offerwall Toolbar

MCOfferwallSDK.SetToolbarTitle("your_custom_title");

Replace ‘your_custom_title’ with your actual title.

If no title is set, the toolbar remains blank.