1 of 12

Playtime SDK for Android

Get Started

Follow this guide to configure your app to work with the Playtime SDK using any of our supported wrappers.

Step 1. Get Your SDK Hash

Contact your adjoe Account Manager to get an SDK hash for your app. Or if you already have access, it can be retrieved from the Publisher Dashboard.

The SDK hash is a unique 32-character code that uniquely identifies your app within adjoe's systems. Each app receives a distinct hash. Remember to keep your hash confidential to prevent unauthorized use.

Step 2. Add Test Devices

Important: Execute this step before the Playtime SDK is accessed on the device for the first time! You can always add more test devices, but only if the SDK hasn't been accessed on them yet.

To fully test the Playtime SDK integration and access all campaign types, configure your physical devices and emulators as test devices. Without this step, the types of available campaigns you get will be limited when using VPNs or emulators.

Find Your GAID (Google Advertising ID):

Open the Settings app or Google settings (depends on your device).
Go to "Google" > "Ads" in the Services section.
Your GAID is displayed at the bottom.

Register as a Test User:

With your GAID, go to the adjoe Publisher Dashboard. If you don't have dashboard access, contact your Account Manager.
In the dashboard, find "Test Users" under configuration settings and enter your GAID.

Please note: If you reset your device's GAID, remember to update the test device information in the dashboard with the new GAID before accessing the Playtime SDK again.

Step 3. Add the Playtime SDK Dependency

Add adjoe's repository to your root build.gradle (project level):

allprojects {
    repositories {
        ...
        maven {
            url  "https://releases.adjoe.io/maven"
        }
    }
}

Add the adjoe dependency to your app's build.gradle (module level):

dependencies {
    ...
    implementation 'io.adjoe:adjoe-sdk-android:2.2.2'
}

If you use Kotlin DSL for adding dependencies, add the repo in the settings.gradle.kts

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://releases.adjoe.io/maven") }
    }
}

Add adjoe's repository to the settings.gradle file:

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://releases.adjoe.io/maven") 
        }
    }
}

2. Add the adjoe dependency to your app's build.gradle (module level):

dependencies {
    ...
    implementation 'io.adjoe:adjoe-sdk-android:2.2.2'
}

https://github.com/adjoeio/adjoe-react-native-sdk

Open your project's package.json file.
Add the adjoe as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies: {
  "react-native-adjoe-sdk": "https://github.com/adjoeio/adjoe-react-native-sdk#v2.2.2"
}

Open your build.gradle file in the android folder and add the following section:

allprojects {
    repositories {
        maven {
            url  "https://releases.adjoe.io/maven"
        }
    }
}

Run the command:

npm install

https://github.com/adjoeio/adjoe-flutter-sdk

To integrate the adjoe Flutter SDK into your Flutter project, follow these steps:

Open your project's pubspec.yaml file.
Add the Playtime SDK as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies:
  adjoe:
    git:
      url: https://github.com/adjoeio/adjoe-flutter-sdk#v2.2.2
      ref: main

Save the pubspec.yaml
In your IDE run either of the the following two commands:
1. pub get
2. flutter pub get

adjoe Playtime SDK 2.2.2 uses the Play Services Resolver, you can download a version of the adjoe SDK which is compatible wit the Play Services Resolver here: https://pre-releases.adjoe.io/files/playtime/unity/2.2.2/adjoe_sdk_android_unity_2.2.2_psr.unitypackage. It contains only the source code and the AdjoeDependencies.xml file specifying the Playtime SDK.

Add the Playtime SDK to your app by clicking:

Assets > Import package > Custom package....

Select adjoe's .unitypackage, click Open and the select Import. This will load the adjoe SDK into Assets/Adjoe.

https://github.com/adjoeio/adjoe-cordova-sdk

Open your project's package.json file.
Add the Playtime SDK as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies: {
  "cordova-plugin-adjoe": "https://github.com/adjoeio/adjoe-cordova-sdk#v2.2.2"
}

Save the package.json and run the following command:

npm install

You have an option to integrate the dependencies via Groovy or Kotlin. To understand the differences of integrating dependencies via these platforms, refer to the official Android docs.

Step 4: Enable Logs (Native only)

Enabling logging per device within the SDK is crucial for troubleshooting. Turn on logging and include the logs with any bug reports to help us accurately replicate and address issues.

Here’s how to enable logging:

Connect the device to your computer and enable ADB.
In a terminal window, run the following command to activate logging:

adb shell setprop log.tag.Adjoe INFO

You can now filter LogCat using the Adjoe tag to monitor relevant log output. If you wish to disable logging, simply execute the command:

adb shell setprop log.tag.Adjoe ERROR

This sets the logging level to ERROR, effectively reducing the verbosity of the logs.

Integrate the Playtime SDK

There are 2 parts to implementing and using the Playtime SDK:

Part 1: Intialize the Playtime SDK

Part 2: Launch Playtime

Initialize the Playtime SDK

To make all of the features of the Playtime SDK available, you need to initialize it first. This initialization happens asynchronously in the background, with its completion indicated by a callback method. Make sure to initialize the SDK immediately after the app launches and each time it returns to the foreground.

Best practices for the SDK initialization:

Initialize early: Initialize the SDK as soon as possible after your app starts. This ensures all Playtime SDK features are ready for use right away.
Initialize after your app authentication: Once a user signs up or logs in, initialize the SDK again with the latest user details. This updates the userID within the SDK.
Initialize regularly: For the best user experience, call the init method every time your app comes into the foreground. Doing so will not affect your app's performance.
Initialization triggers: Call the init method at the app start and resume (when the app comes back into the foreground).

Initialization

// The initialization will run in the main application process asynchronously in the background and notify you when it is finished by invoking the AdjoeInitializationListener's onInitialisationFinished or onInitialisationError method.

class MainActivity : AppCompatActivity {
	
    override fun onCreate(savedInstanceState: Bundle?) {
        Adjoe.init(this, "sdkHash", options, object: AdjoeInitialisationListener {
            
            override fun onInitialisationFinished() {
                // the adjoe SDK was initialized successfully
            }
            
            override fun onInitialisationError(exception: Exception?) {
                // an error occurred while initializing the adjoe SDK.
                // note that exception might be null
            }
        })
    }
}

// The initialization will run in the main application process asynchronously in the background and notify you when it is finished by invoking the AdjoeInitializationListener's onInitialisationFinished or onInitialisationError method.

public class MainActivity extends Activity {

    @Override
    protected void onCreate() {
        super.onCreate();
        Adjoe.init(this, "sdkHash", options, new AdjoeInitialisationListener() {

            @Override
            public void onInitialisationFinished() {
                // the adjoe SDK was initialized successfully
            }

            @Override
            public void onInitialisationError(Exception exception) {
                // an error occurred while initializing the adjoe SDK.
                // note that exception might be null
            }
        });
    }
}

// Should be called during the app start, for example in the App.js's componentDidMount() method

Adjoe.init('sdkHash', options).then(() => {
      console.log('Initialized adjoe SDK'); 
    }).catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

// The init method will return a Future<void> which succeeds when the SDK has been initialized successfully and fails with an error when the initialization fails. Make sure to initialize in initState as well as didChangeAppLifecycleState.

import 'package:adjoe/adjoe.dart';
import 'package:adjoe/gender.dart';
import 'package:adjoe/options.dart';
import 'package:adjoe/params.dart';
import 'package:adjoe/user_profile.dart';

void initializeAdjoe() {
  Adjoe.init(sdkHash, options).then((_) {
    print('Init finished successful');
  }, onError: (err) {
    print('Init failed: $err');
  });
}

using io.adjoe.sdk;

public class Main {

void Start()
{
    Adjoe.Init("sdkHash", options, AdjoeInitialisationSuccess, AdjoeInitialisationError);
}

public void AdjoeInitialisationSuccess()
{
    // the adjoe SDK was initialized successfully
}

public void AdjoeInitialisationError(Exception exception)
{
    // an error occurred while initializing the adjoe SDK.
    // note that exception might be null
}
}

window.AdjoePlugin.initialize(
  'sdkHash','options',
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

Important: Initialization must happen on the main thread since it's a UI-related action. Calling any of the init methods off the main thread could lead to app disruptions.

adjoe Options

Pass the following additional options to the Playtime SDK during initialization:

Parameter

Type

Explanation

User ID

String

A custom identifier you can assign to each user. If you haven't set one, the Playtime SDK generates it automatically. It is accessible through Adjoe.getUserId(Context). This ID is necessary for S2S payouts, thus required. Ensure this value is url-safe and that the value is never empty.

Object

Extensions

Object

val options = Adjoe.Options()
    .setUserId(userId)
    .setParams(adjoeParams);
    .setUserProfile(adjoeUserProfile)
    .setExtensions(adjoeExtensions);

Adjoe.Options options = new Adjoe.Options()
    .setUserId(userId)
    .setParams(adjoeParams);
    .setUserProfile(adjoeUserProfile)
    .setExtensions(adjoeExtensions);

Adjoe.init('sdkHash', 
    { 
      'user_id': "06957070-6579-46cd-9665-d8fe7cd286d5",
      'adjoeParams': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
     'adjoeExtension': {
        'subId1': "RN_subId1",
        'subId2': "RN_subId2",
        'subId3': "RN_subId3",
        'subId4': "RN_subId4",
        'subId5': "RN_subId5"
    }, 
    'adjoeUserProfile': adjoeUserProfile()
    
    }).then(() => {
      console.log('Initialized adjoe SDK');
    })
    .catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

AdjoeOptions options = new AdjoeOptions()
  ..userId = 'user_id'
  ..params = (new AdjoeParams()
    ..uaNetwork = 'The user acquisition network'
    ..uaChannel = 'The user acquisition channel.'
    ..uaSubPublisherCleartext = 'The user acquisition publisher cleartext'
    ..uaSubPublisherEncrypted = 'The user acquisition publisher encrypted'
    ..placement = 'The offerwall placement')
  ..userProfile = adjoeUserProfile
  ..extensions = (new AdjoeExtensions()
    ..subId1 = 'flutter_subId1'
    ..subId2 = 'flutter_subId2'
    ..subId3 = 'flutter_subId3'
    ..subId4 = 'flutter_subId4'  
    ..subId5 = 'flutter_subId5');

AdjoeOptions options = new AdjoeOptions()
    .SetUserId(userId)
    .SetAdjoeParams(adjoeParams)
    .SetAdjoeUserProfile(adjoeUserProfile)
    .SetAdjoeExtensions(adjoeExtensions);

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'MALE',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

adjoe Parameters

When initializing the SDK, you should include additional User Acquisition and Playtime placement parameters. These parameters allow you to track and analyze Playtime's performance within your app.

To make the most of the Playtime SDK, to maximize your revenue and provide the best user experience, use all of these parameters for data-driven optimizations. For instance, you can monitor the performance of different Playtime button placements or determine the effectiveness of different UA sources.

You can provide these parameters in any combination, both at initialization and at any point in the app's lifecycle—such as when a user launches the Playtime Offerwall, interacts with a campaign or requests a payout.

These values must be url-safe as they could potentially be returned as query parameters in the S2S Payout request.

Parameter

Type

Explanation

UA Network

String

User Acquisition Network. The network through which the user was acquired, e.g., Adwords, Facebook, or Organic.

UA Channel

String

User Acquisition Channel. The channel within the network from which the user was acquired, e.g. incentivized or video campaigns.

User Acquisition Sub Publisher Cleartext

String

The cleartext package name of the sub-publisher's app ID within the network from which the user was acquired, e.g., com.domain.appName.

User Acquisition Sub Publisher Encrypted

String

The encrypted package name or app ID of the sub-publisher's app from the network where the user was acquired.

Placement

String

The placement of the Playtime Offerwall inside your app, e.g., "Main Screen", "Shop", "Interstitial", "More Diamonds Screen", etc.

val adjoeParams = AdjoeParams.Builder()
    .setUaNetwork("network")
    .setUaChannel("channel")
    .setUaSubPublisherCleartext("SubPublisherCleartext")
    .setUaSubPublisherEncrypted("SubPublisherEncrypted")
    .setPlacement("placement")
    .build()
Adjoe.setUAParams(context, adjoeParams)

AdjoeParams adjoeParams = new AdjoeParams.Builder()
                .setUaNetwork("network")
                .setUaChannel("channel")
                .setUaSubPublisherCleartext("SubPublisherCleartext")
                .setUaSubPublisherEncrypted("SubPublisherEncrypted")
                .setPlacement("placement")
                .build();
Adjoe.setUAParams(context, adjoeParams);

adjoe.setUAParams({
            'uaNetwork': "RN-uaNetwork",
            'uaChannel': "RN-uaChannel",
            'uaSubPublisherCleartext': "RN-uaSubPublisherCleartext",
            'uaSubPublisherEncrypted': "RN-uaSubPublisherEncrypted",
            'placement': 'RN-placement'
})
.then(() => {
            this.logDialog(`Setting UA prameters were sucessful.`);
})
.catch((err) => {
            this.logDialog(`Setting UA prameters failed.`);
            console.error(err);
});

Adjoe.setUAParams(new AdjoeParams()
        ..uaNetwork = 'uaNetwork'
        ..uaChannel = 'uaChannel'
        ..uaSubPublisherCleartext = 'uaSubPublisherCleartext'
        ..uaSubPublisherEncrypted = 'uaSubPublisherEncrypted'
        ..placement = 'placement');

AdjoeParams adjoeParams = new AdjoeParams();
adjoeParams.SetUaNetwork("network")
           .SetUaChannel("Channel")
           .SetUaSubPublisherCleartext("SubPublisherCleartext")
           .SetUaSubPublisherEncrypted("SubPublisherEncrypted")
           .SetPlacement("placement");
Adjoe.SetUAParams(adjoeParams);

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'male',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

User Profile Information

Our game recommendations are personalized through algorithms that consider users' preferences and gender information. If a user consents to share their gender and/or birthday, you can share this information with adjoe to enhance the customization of game suggestions.

The code below is for demonstration purposes and can be modified to best suit your app's set-up. The important thing is that you get the user's birthday and gender information from your backend and pass in the data to adjoe when initializing.

The birthday data should be in ISO format. If your data doesn't already look like that, please make sure to format it so that it is. Example: 2023-07-17T22:25:00.000Z

fun adjoeUserProfile(): AdjoeUserProfile {
    val gender: AdjoeGender = when (getUserGender()) {
        "male" -> AdjoeGender.MALE
        "female" -> AdjoeGender.FEMALE
        else -> AdjoeGender.UNKNOWN
    }

// if you don't know the exact birthday, the year is enough
    val birthday: Date = if (isExactBirthdayKnown()) {
        getUserBirthday()
    } else {
        val calendar = Calendar.getInstance()
        calendar.set(Calendar.YEAR, getYearOfBirth())
        calendar.set(Calendar.MONTH, 0)
        calendar.set(Calendar.DAY_OF_MONTH, 0)
        calendar.time
    }

    return AdjoeUserProfile(gender, birthday)
}

public class UserProfileUtils {

    public static AdjoeUserProfile adjoeUserProfile() {
        AdjoeGender gender = getAdjoeGender(getUserGender());
        Date birthday = getBirthday();
        return new AdjoeUserProfile(gender, birthday);
    }

    private static AdjoeGender getAdjoeGender(String userGender) {
        switch (userGender) {
            case "male":
                return AdjoeGender.MALE;
            case "female":
                return AdjoeGender.FEMALE;
            default:
                return AdjoeGender.UNKNOWN;
        }
    }

    private static String getUserGender() {
        // Implement this method to get the user's gender
        return "male"; // Example placeholder
    }

    private static Date getBirthday() {
        if (isExactBirthdayKnown()) {
            return getUserBirthday();
        } else {
            Calendar calendar = Calendar.getInstance();
            calendar.set(Calendar.YEAR, getYearOfBirth());
            calendar.set(Calendar.MONTH, Calendar.JANUARY);
            calendar.set(Calendar.DAY_OF_MONTH, 1);
            return calendar.getTime();
        }
    }

    private static Date getUserBirthday() {
        // Implement this method to get the user's birthday
        return new Date(); // Example placeholder
    }

    private static boolean isExactBirthdayKnown() {
        // Implement this method to determine if the exact birthday is known
        return true; // Example placeholder
    }

    private static int getYearOfBirth() {
        // Implement this method to get the user's year of birth
        return 1990; // Example placeholder
    }
}

function adjoeUserProfile() {
    const userGender = getUserGender();
    let gender;
    if (userGender === "male") {
        gender = "MALE";
    } else if (userGender === "female") {
        gender = "FEMALE";
    } else {
        gender = "UNKNOWN";
    }

// if you don't know the month or day, you can set them to 01
    let birthday;
    if (isExactBirthdayKnown()) {
        birthday = new Date(getUserBirthday());
    } else {
        const calendar = new Date();
        calendar.setFullYear(getYearOfBirth());
        calendar.setMonth(0);
        calendar.setDate(1);
        birthday = calendar;
    }

    birthday = birthday.toISOString() 
    return { gender, birthday };
}

import 'package:adjoe/user_profile.dart';
import 'package:adjoe/gender.dart';

AdjoeGender gender;
switch (getUserGender()) {
  case "male":
    gender = AdjoeGender.MALE;
    break;

  case "female":
    gender = AdjoeGender.FEMALE;
    break;

  default:
    gender = AdjoeGender.UNKNOWN;
    break;
}

// set the birthday. If you don't know the user's exact birthday, the year is already enough.
DateTime birthday = getUserBirthday();

AdjoeUserProfile adjoeUserProfile = AdjoeUserProfile()
  ..gender = gender
  ..birthday = birthday;

AdjoeGender gender;
string userGender = GetUserGender();
if (userGender == "male")
    gender = AdjoeGender.MALE;
else if (userGender == "female")
    gender = AdjoeGender.FEMALE;
else
    gender = AdjoeGender.UNKNOWN;

DateTime birthday = new DateTime();
birthday = DateTime.SpecifyKind(birthday, DateTimeKind.Utc);

if (isExactBirthdayKnown())
    {
        birthday = DateTime.Parse(getUserBirthday());
    }
else
    {
        birthday = new DateTime(getYearOfBirth(), 1, 1);
    }

string birthdayIso = birthday.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
AdjoeUserProfile adjoeUserProfile = new AdjoeUserProfile(gender, birthdayIso);

//Cordova has a different API that can be used to set the user profile information.

window.AdjoePlugin.setProfile(
  source,
  gender,
  birthday,
  function() {
    // successfully sent the profile information to adjoe
  },
  function(err) {
    // an error occurred while sending the profile information to adjoe
  },
);

adjoe Extensions

These are optional identifiers used in your backend. They will be provided back in the S2S payout URL.

val adjoeExtensions = AdjoeExtensions.Builder()
    .setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5")
    .build()

AdjoeExtensions adjoeExtensions = new AdjoeExtensions.Builder()
    .setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5")
    .build();

// A complete example
Adjoe.init('sdkHash', 
    { 
      'user_id': "06957070-6579-46cd-9665-d8fe7cd286d5",
      'applicationProcessName' : "io.adjoe.anyApp",
      'adjoeParams': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoeExtension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'adjoeUserProfile': {
                'gender': 'male',
                'birthday': "2023-07-17T22:25:00.000Z"
        }
    
    }).then(() => {
      console.log('Initialized adjoe SDK');
    })
    .catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

AdjoeOptions options = new AdjoeOptions()
  ..userId = 'user_id'
  ..applicationProcessName = 'io.adjoe.FlutterTestApp'
  ..params = (new AdjoeParams()
    ..uaNetwork = 'The user acquisition network'
    ..uaChannel = 'The user acquisition channel.'
    ..uaSubPublisherCleartext = 'The user acquisition publisher cleartext'
    ..uaSubPublisherEncrypted = 'The user acquisition publisher encrypted'
    ..placement = 'The offerwall placement')
  ..userProfile = (new AdjoeUserProfile()
    ..birthday = birthday
    ..gender = gender)
  ..extensions = (new AdjoeExtensions()
    ..subId1 = 'flutter_subId1'
    ..subId2 = 'flutter_subId2'
    ..subId3 = 'flutter_subId3'
    ..subId4 = 'flutter_subId4'  
    ..subId5 = 'flutter_subId5');

AdjoeExtensions adjoeExtensions = new AdjoeExtensions();
adjoeExtensions.setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5");

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'male',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

Checking Initialization

We recommend to verify the SDK is correctly initialized. Each wrapper provides an Adjoe.isInitialized method for this purpose. When executed, this method returns true if the SDK is initialized, and false otherwise. Use IsInitialized for debugging or to verify SDK initialization before calling other methods.

Important: Do not call Adjoe.init based on the result of isInitialized.The SDK already performs its own initialization checks. Doing so again may degrade the user experience.

Launch Playtime

The primary function of the Playtime SDK is showing the offerwall to the users. The Playtime lists various campaigns that the users can complete to receive a reward in the app's native in-app currency.

Games displayed to users are chosen programmatically based on their preferences and profile, while the specific campaigns available to them depend on the permissions granted or country.

Campaigns

Advertisers define ad formats and target countries through campaigns, which are then featured in the Playtime . These campaigns are set by advertisers and allow for rewards once the completion of the campaign conditions are verified through the .

Campaign

Explanation

Example of a Playtime Campaign

Example of an Advance+ Campaign

Terms of Service

Users need to accept adjoe's Terms of Service (TOS) to use Playtime and access games. Agreeing to the TOS is mandatory before installing any partner apps. After users accept the TOS, we can identify the types of apps/games they have installed, allowing our algorithm to tailor game suggestions on the offerwall based on their preferences.

Access to Advertising Info

We also ask the user to accept the App Usage Permissions. This allows us to monitor the time spent in each game or app. Without accepting these permissions, users won't be eligible to participate in Playtime campaigns and will be limited to only Advance or Advance+ campaigns.

How Games Are Matched to Users

The Playtime algorithm prioritizes displaying games to users based on their potential to generate maximum revenue and likelihood of being downloaded.

Add a Teaser Event

When the placement button for Playtime appears, whether clicked or not, please send us the teaser event. This notifies adjoe when and where the placement is shown, which is crucial for tracking user engagement and enhancing the user experience.

try {
    Adjoe.sendUserEvent(context, Adjoe.EVENT_TEASER_SHOWN, null, adjoeParams)
} 
catch (e: AdjoeNotInitializedException) {
    // you have to initialize the adjoe SDK
}

try {
    Adjoe.sendUserEvent(context, Adjoe.EVENT_TEASER_SHOWN, null, adjoeParams);
}
catch (AdjoeNotInitializedException e) {
    // you have to initialize the adjoe SDK
}

Adjoe.sendEvent(Adjoe.EVENT_TEASER_SHOWN, null, {'<adjoeParams>'});

Adjoe.sendTeaserShownEvent(params);

Adjoe.sendEvent(Adjoe.EVENT_TEASER_SHOWN, null, adjoeParams);

function() {
    // show teaser button
        window.AdjoePlugin.sendUserEvent(window.AdjoePlugin.EVENT_TEASER_SHOWN, '<subId1>', '<subId2>');
    },
function() {
        //can't show the offerwall 
    }

Launch the Playtime Offerwall

We recommend triggering the offerwall via a button or UI element (within the SDK it is housed in a separate activity). Rather than launching the activity directly, we provide an Intent for you to initiate it, enabling, for example, transition animations for a smoother user experience. Use the code below to launch the AdjoeActivity and display the adjoe Playtime Offerwall. It is recommended to send any updated AdjoeParams when launching the Playtime Offerwall.

try {
    val adjoeParams = AdjoeParams.Builder()
        .setUaNetwork("network")
        .setUaChannel("channel")
        .setUaSubPublisherCleartext("SubPublisherCleartext")
        .setUaSubPublisherEncrypted("SubPublisherEncrypted")
        .setPlacement("placement")
        .build()
    val adjoeOfferwallIntent = Adjoe.getOfferwallIntent(context, adjoeParams)
    context.startActivity(adjoeOfferwallIntent)
} 
    catch(notInitializedException: AdjoeNotInitializedException) {
    // you have not initialized the adjoe SDK
} 
    catch(exception: AdjoeException) {
    // the offerwall cannot be displayed for some other reason
}

try {
    AdjoeParams adjoeParams = new AdjoeParams.Builder()
            .setUaNetwork("network")
            .setUaChannel("channel")
            .setUaSubPublisherCleartext("SubPublisherCleartext")
            .setUaSubPublisherEncrypted("SubPublisherEncrypted")
            .setPlacement("placement")
            .build();
    Intent adjoeOfferwallIntent = Adjoe.getOfferwallIntent(context, adjoeParams);
    context.startActivity(adjoeOfferwallIntent);
} 
        catch (AdjoeNotInitializedException notInitializedException) {
    // you have not initialized the adjoe SDK
} 
        catch (AdjoeException exception) {
    // the offerwall cannot be displayed for some other reason
}

Adjoe.showOfferwall({
	'uaNetwork': "uaNetwork_value",
	'uaChannel': "uaChannel_value",
	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
	'placement': 'placement_value'
})
    .then(() => {
        console.log('Now showing adjoe offerwall');
    })
    .catch((err) => {
        console.log('Could not show adjoe offerwall');
        console.error(err);
    });

AdjoeParams params = new AdjoeParams()
    ..uaNetwork = 'network'
    ..uaChannel = 'channel'
    ..uaSubPublisherCleartext = 'cleartext'
    ..haSubPublisherEncrypted = 'encrypted'
    ..placement = 'placement';
Adjoe.showOfferwall(params);

AdjoeParams adjoeParams = new AdjoeParams();
adjoeParams.SetUaNetwork("network")
    .SetUaChannel("Channel")
    .SetUaSubPublisherCleartext("SubPublisherCleartext")
    .SetUaSubPublisherEncrypted("SubPublisherEncrypted")
    .SetPlacement("placement");
Adjoe.ShowOfferwall(adjoeParams)

window.AdjoePlugin.showOfferwall(
  function() {
    // the offerwall was displayed to the user
  },
  function(err) {
    // the offerwall cannot be displayed
  },
);

//You can pass two optional Sub-IDs when you launch Playtime, which will be logged every time a user views or clicks a campaign: 
window.AdjoePlugin.showOfferwallWithSubIDs('<subId1>', '<subId2>', success, error).

Set Up a Listener (Native)

You can set up a listener to be notified when the Playtime Offerwall is opened or closed, with the event type always being offerwall. To remove the listener, simply call Adjoe.removeOfferwallListener().

Adjoe.setOfferwallListener(object:AdjoeOfferwallListener() {
  fun onOfferwallOpened(type:String) {
    Log.d(TAG, "Offerwall of type '" + type + "' was opened")
  }
  fun onOfferwallClosed(type:String) {
    Log.d(TAG, "Offerwall of type '" + type + "' was closed")
  }
})

Adjoe.setOfferwallListener(new AdjoeOfferwallListener() {

    @Override
    public void onOfferwallOpened(String type) {
        Log.d(TAG, "Offerwall of type '" + type + "' was opened");
    }

    @Override
    public void onOfferwallClosed(String type) {
        Log.d(TAG, "Offerwall of type '" + type + "' was closed");
    }
});

Example: Playtime Offerwall & My Games

Additional Useful Methods

Examples

Below is a full example implementation of the Playtime SDK. It uses Jetpack Compose to set up a button that leads the user to the Playtime Offerwall. To run the example:

Add the dependency
Add your SDK hash
If you're using an emulator, add it as a test device.

In the future we will update this page with examples for our other wrappers. Please check back soon.

package com.example.sdk_integration_activity

import android.content.Context
import android.os.Bundle
import android.util.Log
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.size
import androidx.compose.material3.Button
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import io.adjoe.sdk.Adjoe
import io.adjoe.sdk.Adjoe.getUserId
import io.adjoe.sdk.AdjoeException
import io.adjoe.sdk.AdjoeExtensions
import io.adjoe.sdk.AdjoeGender
import io.adjoe.sdk.AdjoeInitialisationListener
import io.adjoe.sdk.AdjoeNotInitializedException
import io.adjoe.sdk.AdjoeOfferwallListener
import io.adjoe.sdk.AdjoeParams
import io.adjoe.sdk.AdjoeUserProfile
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import java.util.Calendar
import java.util.Date

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        initAdjoe()
        setupAdjoeOfferwallListener()
    }

// the initAdjoe() function has the adjoe params, but if your params have
// changed, or if you don't yet have a param, it is recommended that you take a
// different approach. For example, if you don't get the user ID until after the
// user has signed in. You should then send these values in the OnResume.
private fun initAdjoe()
{
    // pass in the user id. These values should come from your backend.
    // If you don't get the userID until after the sign-in, this value can be passed-in onResume.
    val userId = "f0b9d695-405d-4b13-8a79-5fe21dc901e6"

    // set up the parameters, these values should also come from your backend.
    val adjoeParams = AdjoeParams.Builder()
        .setUaNetwork("tiktok")
        .setUaChannel("video")
        .setUaSubPublisherCleartext("Example: Game 2")
        .setUaSubPublisherEncrypted("8bb1e7911818be32449f6726ff7ecd102ba1862b")
        .setPlacement("Main Screen")
        .build()

    // these values are additional options that you can pass-in to identify users. These data will be sent back in the S2S URL. Example data below.
    val adjoeExtensions = AdjoeExtensions.Builder()
        .setSubId1("Target Group 1")
        .setSubId2("Target Group 2")
        .build()

    //Set the options
    val options = Adjoe.Options()
        .setUserId(userId)
        .setParams(adjoeParams)
        .setUserProfile(getUserProfile())
        .setExtensions(adjoeExtensions)

    // Initialize the adjoe Playtime SDK, passing in the adjoe Options
    try {
        Adjoe.init(this, "your_sdk_hash", options, object : AdjoeInitialisationListener {
            override fun onInitialisationFinished() {
                // The adjoe Playtime SDK SDK was initialized successfully
                //("initialized successfully")
            }

            override fun onInitialisationError(exception: Exception?) {
                // An error occurred while initializing the Adjoe SDK.
                // Note that exception might be null
            }
        })
    } catch (e: AdjoeNotInitializedException) {
        // Handle initialization exception
    }
    setContent {
        ExampleApp(this)
    }
}

//Get the user profile information. These data should come from your backend. 
    fun getSampleUserGender(): String {
        return "male"
    }

    //Pass in the user's birthday information if it's available
    //and if they've consented to sharing it
    fun getSampleUserBirthday(): Date {
        val birthday = Calendar.getInstance()
        birthday.set(Calendar.YEAR, 1995)
        birthday.set(Calendar.MONTH, Calendar.JANUARY)
        birthday.set(Calendar.DAY_OF_MONTH, 30)

        return birthday.time
    }

    val birthday = getSampleUserBirthday()

    fun getUserProfile(): AdjoeUserProfile {
        val gender: AdjoeGender = when (getSampleUserGender()) {
            "male" -> AdjoeGender.MALE
            "female" -> AdjoeGender.FEMALE
            else -> AdjoeGender.UNKNOWN
        }
        return AdjoeUserProfile(gender, birthday)
    }

//Set up the listener for when the offerwall is opened or closed. 
    private fun setupAdjoeOfferwallListener() {
        Adjoe.setOfferwallListener(object : AdjoeOfferwallListener {
            override fun onOfferwallOpened(type: String) {
                Log.d("ADJOE", "Offerwall of type '" + type + "' was opened")
            }

            override fun onOfferwallClosed(type: String) {
                Log.d("ADJOE", "Offerwall of type '" + type + "' was closed")
            }
        })
    }

    //Whenever your app comes back into the foreground,
    //you should init the SDK again and send the updated adjoe Params.
    override fun onResume() {
        super.onResume()
        initAdjoe()
    }
}

//Set up the params to send with the teaser. Use this in case you have multiple offerwall
// placements in your app and want to evaluate the effectiveness of each.
val teaserAdjoeParams: AdjoeParams = AdjoeParams.Builder()
    .setPlacement("Main Screen")
    .build()

//Set up the additional methods
private suspend fun additionalChecks(context: Context) {
    withContext(Dispatchers.IO) {
        getVersion()
        getVersionName()
        val tosAccepted = hasAcceptedTOS(context)
        val permissionsAccepted = hasAcceptedUsagePermission(context)
        val userIdRetreived = getUserId(context)
    }
}
suspend fun getVersion() {
    val version: Int? = Adjoe.getVersion()
    Log.d("ADJOE", "Adjoe SDK version is $version")
}

suspend fun getVersionName() {
    val versionName: String? = Adjoe.getVersionName()
    Log.d("ADJOE", "Adjoe SDK version name is $versionName")
}

suspend fun hasAcceptedTOS(context: Context) {
    val accepted: Boolean? = Adjoe.hasAcceptedTOS(context)
    Log.d("ADJOE", "TOS accepted: $accepted")
}

suspend fun hasAcceptedUsagePermission(context: Context) {
    val accepted: Boolean? = Adjoe.hasAcceptedUsagePermission(context)
    Log.d("ADJOE", "Usage permission accepted: $accepted")
}

suspend fun getUserId(context: Context) {
    val userId: String? = Adjoe.getUserId(context)
    Log.d("ADJOE", "User ID is \"$userId\"")
}

// Set up the teaser event function
private fun sendTeaser(context:Context) {
            Adjoe.sendUserEvent(context, Adjoe.EVENT_TEASER_SHOWN, null, teaserAdjoeParams)
        }

@Composable
fun ExampleApp(activity: ComponentActivity) {
    Surface(color = MaterialTheme.colorScheme.background) {
        Column(
            modifier = Modifier.fillMaxSize(),
            verticalArrangement = Arrangement.Center,
            horizontalAlignment = Alignment.CenterHorizontally
        ) {
            ShowPlaytimeOfferwallButton(activity)
        }
    }
}

@Composable
fun ShowPlaytimeOfferwallButton(activity: ComponentActivity) {
    val coroutineScope = rememberCoroutineScope()

    Column(
        modifier = Modifier.fillMaxSize(),
        verticalArrangement = Arrangement.Center,
        horizontalAlignment = Alignment.CenterHorizontally
    ) {

        // Button to navigate to the offerwall screen
        Button(
            onClick = {
                coroutineScope.launch {
                    try {
                        val adjoeOfferwallIntent = Adjoe.getOfferwallIntent(activity)
                        activity.startActivity(adjoeOfferwallIntent)
                    } catch(notInitializedException: AdjoeNotInitializedException) {
                        // Handle not initialized exception
                    } catch(exception: AdjoeException) {
                        // Handle other exceptions
                    }
                    sendTeaser(context = activity.applicationContext) // send the teaser when the user clicks the Offerwall Button. The teaser can also be sent when the user views it.
                    additionalChecks(context = activity.applicationContext) // run the additional checks. 
                }
            },
            modifier = Modifier.size(width = 250.dp, height = 75.dp)
        ) {
            Text("Show Playtime Offerwall")
        }
    }
}

@Preview(showBackground = true)
@Composable
fun DefaultPreview() {
    ExampleApp(ComponentActivity())
}

Server-to-Server Payouts

Once a user meets the criteria for being rewarded, it's time to initiate the payout—sending the rewards to the user. Publishers issue these payouts upon receiving a payout request callback from adjoe's backend. The request is made to the S2S API URL configured for the publisher for their SDK in the Publisher Dashboard.

Set Up Server-to-Server (S2S) Payouts

To enable S2S payouts, set up an endpoint on your server to receive notifications about user rewards from adjoe. When a request is made to your endpoint, you then must manage the distribution of these rewards to the users. Be aware that once a reward is distributed, it cannot be allocated again.

Endpoint Structure

The key names can be customized, or you can use the default names. Please ensure that no special characters should be included in the values, otherwise our backend may transform the request, which could cause issues with the payout. Some of these values include: [] . =

Default

GET / https://example.com/example?sid={sid}&trans_uuid={trans_uuid}&user_uuid={user_uuid}&currency={currency}&coin_amount={coin_amount}&device_id={device_id}&sdk_app_id={sdk_app_id}&app_id={app_id}&reward_level={reward_level}&app_name={app_name}&reward_type={reward_type}&publisher_sub_id1={publisher_sub_id1}&publisher_sub_id2={publisher_sub_id2}&publisher_sub_id3={publisher_sub_id3}&publisher_sub_id4={publisher_sub_id4}&publisher_sub_id5={publisher_sub_id5}&placement={placement}&ua_network={ua_network}&ua_channel={ua_channel}&ua_subpublisher_encrypted={ua_subpublisher_encrypted}&ua_subpublisher_cleartext={ua_subpublisher_cleartext}

Customized (Example)

GET / https://example.com/example?user_id={user_uuid}&sid={sid}&point_amount={coin_amount}&points={currency}&trans_uuid={trans_uuid}&ua_network={ua_network}&ua_channel={ua_channel}&playtime_placement={placement}&custom_id={publisher_sub_id1}

To achieve successful payouts, the user user_uuid must match the value set in the SDK initialization. More details can be found in .

Parameter

Detail

Format

Type

Example Response URL:

https://s2sexamplerequestendpoint.com/payout?user_uuid=a79d7158-6f9c-4e5b-ae7a-98143c77d396&sid=0de7e36d2965269f172d2d89bc9a8026da7f0819&coin_amount=100&currency=dollars&trans_uuid=e7b1a95f-8c72-4ed8-af69-ecf8d06b1d89&sdk_app_id=example.test.app&ua_network=tiktok&ua_channel=direct&publisher_sub_id1=RandomString

Calculate the SID

sid = sha1(concatenate(trans_uuid, user_uuid, currency, coin_amount, device_id, sdk_app_id, s2s_token))

If sdk_app_id and/or device_id are not present in the endpoint URL, they will be excluded from the sid calculation. The sid will then be calculated as follows:

sid = sha1(concatenate(trans_uuid, user_uuid, currency, coin_amount, s2s_token))

Below is an example script that shows how to calculate the sid and compare it to the value in the callback URL sent by adjoe. You would implement some version of this in your backend.

import hashlib
from urllib.parse import urlparse, parse_qs

def calculate_sid(user_uuid, trans_uuid, currency, coin_amount, device_id, sdk_app_id, s2s_token):
    data = ''.join([trans_uuid, user_uuid, currency, str(coin_amount), device_id, sdk_app_id, s2s_token])
    hashed_data = hashlib.sha1(data.encode()).hexdigest()
    return hashed_data

def extract_parameters(url):
    parsed_url = urlparse(url)
    query_params = parse_qs(parsed_url.query)
    return query_params

def compare_sids(url, calculated_sid):
    query_params = extract_parameters(url)
    sid_from_url = query_params.get('sid', [None])[0]
    return sid_from_url == calculated_sid

# Example URL
url = "https://s2sexamplerequestendpoint.com/payout?user_uuid=a79d7158-6f9c-4e5b-ae7a-98143c77d396&sid=2477185c00a5b1ac94fdf94798798d5e846d8aee&coin_amount=100&currency=dollars&trans_uuid=e7b1a95f-8c72-4ed8-af69-ecf8d06b1d89&device_id=9a7e993a-80b4-4c3b-832f-97a5f501e2f1&sdk_app_id=com.example.android.gamename&ua_network=tiktok&ua_channel=direct&publisher_sub_id1=RandomString"

# Extract parameters from URL
query_params = extract_parameters(url)
user_uuid = query_params.get('user_uuid', [None])[0]
sid = query_params.get('sid', [None])[0]
trans_uuid = query_params.get('trans_uuid', [None])[0]
currency = query_params.get('currency', [None])[0]
coin_amount = int(query_params.get('coin_amount', [None])[0])
device_id = query_params.get('device_id', [None])[0]
sdk_app_id = query_params.get('sdk_app_id', [None])[0]
s2s_token = " " #the s2s_token will be supplied by your Account Manager.

# Calculate SID
calculated_sid = calculate_sid(user_uuid, trans_uuid, currency, coin_amount, device_id, sdk_app_id, s2s_token)

# Compare SIDs
result = compare_sids(url, calculated_sid)
print("SID Comparison Result:", result)

S2S Security

When we make payout request to publishers, we send an HTTP request from any of the following IP addresses:

3.121.65.44
18.185.166.67
52.29.52.48

To enhance security, use these IP addresses for IP-level blocking on endpoints receiving adjoe's S2S payout requests. Allow only these specific IPs access.

Retry Logic

If we receive a 4xx / 5xx from your endpoint, we have an established retry logic for the failed S2S requests.

For Playtime Campaigns

If a request fails, we retry after 10 minutes. A second failure prompts a retry in another 10 minutes. Subsequent failures lead to retries every 2 hours from the initial failed attempt. The time windows are additional, so it's roughly 12hrs in total.

For Advance and Advance+ Campaigns

If a request fails, we retry five more times, with each attempt spaced 30 seconds apart.

If you observe an extended period of unsuccessful requests, contact your Account Manager for further investigation into the issue.

Best Practices for Rewarding Users

If you payout with real money, we recommend that you implement KYC processes, reward cooldowns, and individual limits on the amount of rewards the user can get:

Reward Cooldowns: Temporarily restrict users from receiving additional rewards after receiving one. This helps maintain fairness and prevents exploitation of the rewards system, like receiving rewards too frequently.
Individual Limits: To prevent abuse of the rewards systems, set daily limits on the amount of rewards a user can earn. For example, you might cap rewards at $50 USD per day.

Integration and Launch Checklist

Troubleshooting & Support

Solve any SDK issues quickly with this guide, covering common errors and setup problems. For more help or to suggest features, find support contact details below.

Troubleshoot Common Issues

Operation fails with the exception "not available for this user".

Your device has been blocked. If your device was previously configured as a test device, please inform us so we can address the issue. If not, follow these steps:

Uninstall the app containing the SDK. Ensure its data is also removed from any automatic backups.
Reset your GAID: Go to Settings > Google > Ads and tap on Reset Ad-ID.
using the new GAID.

You don't see any games in the offerwall.

Your device may be blocked. Proceed as described in the issue above.

Notification of reward received, but the SDK does not display the new rewards.

Check your device's time setting; incorrect time (e.g., set to the future or past) often causes this. If the time is correct and the issue persists, contact us and we will investigate this issue.

App compilation fails with "Duplicate class" or "Duplicate entry" exceptions.

This can happen when Gradle cannot resolve a dependency conflict, such as when two dependencies use the same transitive dependency but with different versions. To resolve this conflict you must either:

Remove one of the conflicting dependencies.
Align the versions of the conflicting dependencies to match.

If the affected dependency is one of your app's dependencies, simply adjust or remove it from the dependencies list in your build.gradle. If the affected dependency is transitive, you must exclude it from the dependency which specifies it as a transitive dependency.

Duplicate class due to `androidx.work:work-runtime:$workVersion`.

Our SDK supports pre-AndroidX projects, so we are using the work-runtime library that predates AndroidX. There is an issue with the Android Gradle plugin <3.6.0 where the Jetifier does not correctly replace the dependency. If you are not already using a supported version of Gradle, you need to bump the version in your root project's build.gradle file.

buildscript {

    repositories {
        google()
        mavenCentral()
        ...
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.6.0' // Set this to 3.6.0 or higher.
        ...
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

Please also ensure that you have enabled the Jetifier by placing the line android.enableJetifier=true into your gradle.properties file.

If you continue to have issues due to a conflict between the versions of the androidx.work:work-runtime library in your project, you can fix this issue by adding the following to your app level build.gradle file.

configurations.all {

    resolutionStrategy.dependencySubstitution {
        // Substitute one module dependency for another
        substitute module('android.arch.work:work-runtime:1.0.1') with module('androidx.work:work-runtime:2.0.1')
    }

    resolutionStrategy.force 'androidx.work:work-runtime:2.0.1'
}

dependencies {
    implementation 'androidx.work:work-runtime:2.0.1'
   ....
}

The currently supported version of work-runtime is up to 2.0.1

Get Further Support

Still need help with something? Have an idea for a Feature Request? Please use this template to reach out to your Account Manager for help.

Issue Type: [Bug/Feature Request]
Framework: [Android/Flutter/React Native/Unity/Cordova]
SDK Version:
Priority: [High/Medium/Low]
Crash: [Yes/No]
- Devices Affected: (e.g., Samsung, Pixel)
- User Impact: Number or percentage
- Environment: [Production/Test]
Issue/Feature Description: Provide a detailed description. For feature requests, explain the necessity and potential business impact.
Reproduction Steps:
Expected Behavior:
Actual Behavior:

Please include any relevant logs, crash reports, API calls, or screenshots to support your query.

FAQ

Playtime SDK

Is it necessary to provide the userId at app start-up with the init method?

No. Since the init method should happen at app start-up, there are circumstances where you don’t yet have this data. For example, if the user hasn’t signed in yet. In these cases, it’s still critical to init at the app start up, but you can pass in the UA Params or User ID in an OnResume / AppState / didChangeAppLifecycleState function when you have the data.

Remember that the userId is critical for doing S2S payouts, without it your users will not be able to get their rewards. It is also important to note that whatever the last supplied userId was is what will be sent in the S2S payout URL. Therefore, the last supplied User ID was is what will be sent in the S2S payout URL.

Do I need to do anything with the Playtime SDK after the user logs out?

No. But if the user can only access the Playtime Offerwall after logging-in, then you should remove any calls to init when they log out.

What is the size of SDK?

SDK size depends on the wrapper, but it is roughly <0.5MB.

How often is the SDK updated?

The SDK is updated every couple of months. Please keep an eye out on our changelog.

What kind of data does the SDK track? I need to share this information with the Google Play Store.

All of the data that we collect can be found in the AndroidManifest.xml of the SDK.

How do users know that they are able to receive a reward?

For Android users, we show a toast message on the top of the screen whenever a user is able to receive a reward.

I'm using Flutter or React Native - how can I use your Android SDK and iOS solution together?

Yes, you can use the Platform properties provided by the Flutter and React Native libraries to set up the code in a way to conditionally execute certain code blocks based on the platform the app is running on. Since we only have an SDK on Android, you may need to use platform-based imports for RN or add platform-specific dependencies in the pubspec.yaml for Flutter.

Example for React Native:

const showAdjoeOfferwall = async () => {
  if (Platform.OS === 'ios') {
    return navigation.navigate('InAppBrowser', {
      url: `https://{your_company_name}.playtimeweb.com/play?user_id={user_id}&idfa={IDFA}`
    });
  }

  if (adjoeInitialized && Platform.OS === 'android') {
    return await Adjoe.showOfferwall().catch(err => {
      console.error(`Could not show Adjoe offerwall: ${err}`);
    });
  }
};

Using the Playtime Offerwall

I'm not seeing campaigns/games in the offerwall?

The most common reason this happens is because of VPN usage. If you use a VPN, you might not see any campaigns, even if you set yourself as a test user. We still filter out IP addresses that are anonymous.

After playing some time-based reward games (Playtime), I stopped receiving rewards after 15 mins. Why?

It can happen because you stopped progressing through the game. To fix this, please keep playing and progressing through the game.

What's the difference between Advance, Advance+, and Playtime Campaigns?

We have more information about this in our docs. Please refer to them here.

What is the use of the GAID?

We use GAID to identify users. We provide these data to MMPs so they can count attribution.

Why does the user need to accept Access to Advertising Info?

We have more information about this in our docs. Please refer to them here.

Why does the user need to accept TOS?

We have more information about this in our docs. Please refer to them here. This is what the users sees in the TOS page:

We hereby inform you that adjoe GmbH processes the following personal data within the framework of the use of Playtime:
Installed apps (including the use duration and use history)
The data will be connected to your end device via the device ID and sent, encrypted, to our servers. In order for app providers to finance our app suggestions, we must send them the device ID for billing purposes.
The processing of the above data is necessary to be able to recommend, via system messages, the installation of apps available in Playtime that match your interests, and calculate the bonuses acquired as a result of your use of the corresponding apps.
Consent
By clicking on ACCEPT, I give adjoe GmbH my consent to process my above-mentioned personal data and transmit it to other app providers so that I can use Playtime as described.
I am aware that a profile of interests will be generated using the above data, and depending on the types of apps I use, this may contain particularly sensitive personal data (e.g. health-related data or data about my sexual orientation, and any other data in special categories pursuant to Art. 9[1] GDPR). For that reason my consent also applies explicitly to the processing of this data. The full links to our Data Privacy Statement and Terms and Conditions of use are available here and here respectively.
https://adjoe.zone/legal/en/data_privacy.html
https://adjoe.zone/legal/en/terms_of_use.html

Business

How do I give one of my coworkers access to the dashboard?

You should reach out to your Account Manager. They can provide them with access.

What customization options do you provide for the Playtime Offerwall?

Most parts of the Playtime Offerwall can be customized so that it fits your branding - including images, colors, texts, fonts, and currency. Your Account Manager will reach out to you separately to set up these customizations.

Where can I track KPIs like Revenue or Active User Rates?

These KPIs can be tracked in the Publisher Dashboard. They are also available via API.

Changelog

2.2.2

Published: 17 July 2024

Bug fixes 🪲

Fix ANR related to protection library

2.2.1 Has a known ANR, please do not use this version.

2.2.1

Published: 24 May 2024

Bug fixes 🪲

Fix "webpage not available" error which occurred occasionally when returning back to Playtime from the Play Store
Fix Proguard issue that occurred while building a release version of the APK
Improve the SDK's “notification” logic.
Fix exception caused by running multiple processes

Features and Improvements ✨

Deprecate canShowOfferwall API
Deprecate setProfile API
Improve Korean translations
Add enhanced detection of suspicious users

2.2.0

Published: 21 March 2024

Bug fixes 🪲

Improve usage permission handling on Android 13+

Features and Improvements ✨

Add enhanced detection of suspicious users
Add cash currency support in reward notifications

2.1.1

Published at: 19 December 2023

Bug fixes
Enhance Fraud detection
Translation fixes for the notifications
Fix for users that were not getting rewarded for the installed apps after they updated an SDK.
Supporting all React Native versions.

2.1.0

Published at: 28 July 2023

Bug fixes
Enhance Fraud detection
Usage collection enhancement
Fixed an inconsistency in the External User ID
You can now use the Adjoe.setUAParams(adjoeParams : AdjoeParams) to add additional parameters.
Added translation for additional 7 languages ( in, it, ja, ko, pl, pt and tr) in addition to en, de, es, fr
consistent update cross all wrappers to mark this update as the new base line

2.0.7

Published at: 16 Mar 2023

Android 13 support
Depreciation of safetynet and replacing it with play integrity
New fraud update [VPN-detection]

2.0.5

Published at: 11 Nov 2022

Fix issues with notification.
Enhancements and improvements of workmanager and threading.
Bug fixes.

2.0.4

Published at: 14 Sep 2022

Fix issues with rewards.
Allow multiple init without throwing Already Initialised Exception.
Error visibility enhancement.
Bug fixes.

2.0.2

Published at: 11 Mar 2022

Migrate SDK to Androidx.
Add full support to android12.
Adding android:export in Manifest.
Update workManager library to 2.7.1.
Add flag IMMUTABLE and MUTABLE to pendingIntent.
Bug fixes.
Further enhancement.

1.5.1

Published at: 8 Oct 2021

Further enhancements on crash reports
Bugfixes

1.5.0

Published at: 14.09.2021

Additional scenarios to display Advance campaigns.
Enhance crash reports.
Fix Network issues.
Bugfixes.

1.4.15

Published at: 08.06.2021

Added App Info Fields to Campaigns.
Added Support for Advance.
Usage/Reward Enhancements.
Bugfixes.

1.4.14

Published at: 24.03.2021

Made the SDK lighter on permissions.

1.4.13.1

Published at: 10.03.2021

Resolved potential compatibility issues surrounding the WorkManager library.

1.4.13

Published at: 03.03.2021

Full support for android 11 on targetSDKVersion 30.
Improved the Toast Notification to give users immediate feedback.
Improved the usage collection reliability.
Changed Sub-ID handling with AdjoeParams object to provide further context on the users (such as User Acquisition data and the Playtime placement).

1.4.12

Published at: 28.01.2021

Improved initialization speed.
Improved onboarding user flow on Android 10+.
Bugfix for potential crashes.

1.4.11

Published at: 30.11.2020

Bugfixing for calling the init method outside the main process.
Bugfix for accepting the TOS without a network connection.

1.4.10

Published at: 04.11.2020

Bugfixes for building on Windows.

1.4.9

Published at 29.10.2020

Bugfixes for apps using minified R8/ProGuard builds.

1.4.8

Published at 07.10.2020

Bugfixes.

1.4.7

Published at 25.09.2020

Kotlin: Fixed Adjoe.Options in Kotlin.
Unity: Added inline documentation.
Unity: The methods now output logs when called inside the Unity Editor.

1.4.6

Published at: 16.09.2020‌

Previous Versions

Looking for older versions of our docs? Find them here.

Version

Link

Initialize the Playtime SDK

Best practices for the SDK initialization:

Initialize early: Initialize the SDK as soon as possible after your app starts. This ensures all Playtime SDK features are ready for use right away.
Initialize after your app authentication: Once a user signs up or logs in, initialize the SDK again with the latest user details. This updates the userID within the SDK.
Initialize regularly: For the best user experience, call the init method every time your app comes into the foreground. Doing so will not affect your app's performance.
Initialization triggers: Call the init method at the app start and resume (when the app comes back into the foreground).

Initialization

// The initialization will run in the main application process asynchronously in the background and notify you when it is finished by invoking the AdjoeInitializationListener's onInitialisationFinished or onInitialisationError method.

class MainActivity : AppCompatActivity {
	
    override fun onCreate(savedInstanceState: Bundle?) {
        Adjoe.init(this, "sdkHash", options, object: AdjoeInitialisationListener {
            
            override fun onInitialisationFinished() {
                // the adjoe SDK was initialized successfully
            }
            
            override fun onInitialisationError(exception: Exception?) {
                // an error occurred while initializing the adjoe SDK.
                // note that exception might be null
            }
        })
    }
}

// The initialization will run in the main application process asynchronously in the background and notify you when it is finished by invoking the AdjoeInitializationListener's onInitialisationFinished or onInitialisationError method.

public class MainActivity extends Activity {

    @Override
    protected void onCreate() {
        super.onCreate();
        Adjoe.init(this, "sdkHash", options, new AdjoeInitialisationListener() {

            @Override
            public void onInitialisationFinished() {
                // the adjoe SDK was initialized successfully
            }

            @Override
            public void onInitialisationError(Exception exception) {
                // an error occurred while initializing the adjoe SDK.
                // note that exception might be null
            }
        });
    }
}

// Should be called during the app start, for example in the App.js's componentDidMount() method

Adjoe.init('sdkHash', options).then(() => {
      console.log('Initialized adjoe SDK'); 
    }).catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

// The init method will return a Future<void> which succeeds when the SDK has been initialized successfully and fails with an error when the initialization fails. Make sure to initialize in initState as well as didChangeAppLifecycleState.

import 'package:adjoe/adjoe.dart';
import 'package:adjoe/gender.dart';
import 'package:adjoe/options.dart';
import 'package:adjoe/params.dart';
import 'package:adjoe/user_profile.dart';

void initializeAdjoe() {
  Adjoe.init(sdkHash, options).then((_) {
    print('Init finished successful');
  }, onError: (err) {
    print('Init failed: $err');
  });
}

using io.adjoe.sdk;

public class Main {

void Start()
{
    Adjoe.Init("sdkHash", options, AdjoeInitialisationSuccess, AdjoeInitialisationError);
}

public void AdjoeInitialisationSuccess()
{
    // the adjoe SDK was initialized successfully
}

public void AdjoeInitialisationError(Exception exception)
{
    // an error occurred while initializing the adjoe SDK.
    // note that exception might be null
}
}

window.AdjoePlugin.initialize(
  'sdkHash','options',
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

Important: Initialization must happen on the main thread since it's a UI-related action. Calling any of the init methods off the main thread could lead to app disruptions.

adjoe Options

Pass the following additional options to the Playtime SDK during initialization:

Parameter

Type

Explanation

User ID

String

Object

Values for the User Acquisition and Playtime placement information. These values must be url-safe. More on this .

Object

Birthday and gender data of the app users. This data is used by adjoe to provide the best for the user. More on this .

Extensions

Object

These are optional identifiers used in your backend. They will be provided back in the .

val options = Adjoe.Options()
    .setUserId(userId)
    .setParams(adjoeParams);
    .setUserProfile(adjoeUserProfile)
    .setExtensions(adjoeExtensions);

Adjoe.Options options = new Adjoe.Options()
    .setUserId(userId)
    .setParams(adjoeParams);
    .setUserProfile(adjoeUserProfile)
    .setExtensions(adjoeExtensions);

Adjoe.init('sdkHash', 
    { 
      'user_id': "06957070-6579-46cd-9665-d8fe7cd286d5",
      'adjoeParams': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
     'adjoeExtension': {
        'subId1': "RN_subId1",
        'subId2': "RN_subId2",
        'subId3': "RN_subId3",
        'subId4': "RN_subId4",
        'subId5': "RN_subId5"
    }, 
    'adjoeUserProfile': adjoeUserProfile()
    
    }).then(() => {
      console.log('Initialized adjoe SDK');
    })
    .catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

AdjoeOptions options = new AdjoeOptions()
  ..userId = 'user_id'
  ..params = (new AdjoeParams()
    ..uaNetwork = 'The user acquisition network'
    ..uaChannel = 'The user acquisition channel.'
    ..uaSubPublisherCleartext = 'The user acquisition publisher cleartext'
    ..uaSubPublisherEncrypted = 'The user acquisition publisher encrypted'
    ..placement = 'The offerwall placement')
  ..userProfile = adjoeUserProfile
  ..extensions = (new AdjoeExtensions()
    ..subId1 = 'flutter_subId1'
    ..subId2 = 'flutter_subId2'
    ..subId3 = 'flutter_subId3'
    ..subId4 = 'flutter_subId4'  
    ..subId5 = 'flutter_subId5');

AdjoeOptions options = new AdjoeOptions()
    .SetUserId(userId)
    .SetAdjoeParams(adjoeParams)
    .SetAdjoeUserProfile(adjoeUserProfile)
    .SetAdjoeExtensions(adjoeExtensions);

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'MALE',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

adjoe Parameters

When initializing the SDK, you should include additional User Acquisition and Playtime placement parameters. These parameters allow you to track and analyze Playtime's performance within your app.

These values must be url-safe as they could potentially be returned as query parameters in the S2S Payout request.

Parameter

Type

Explanation

UA Network

String

User Acquisition Network. The network through which the user was acquired, e.g., Adwords, Facebook, or Organic.

UA Channel

String

User Acquisition Channel. The channel within the network from which the user was acquired, e.g. incentivized or video campaigns.

User Acquisition Sub Publisher Cleartext

String

The cleartext package name of the sub-publisher's app ID within the network from which the user was acquired, e.g., com.domain.appName.

User Acquisition Sub Publisher Encrypted

String

The encrypted package name or app ID of the sub-publisher's app from the network where the user was acquired.

Placement

String

The placement of the Playtime Offerwall inside your app, e.g., "Main Screen", "Shop", "Interstitial", "More Diamonds Screen", etc.

val adjoeParams = AdjoeParams.Builder()
    .setUaNetwork("network")
    .setUaChannel("channel")
    .setUaSubPublisherCleartext("SubPublisherCleartext")
    .setUaSubPublisherEncrypted("SubPublisherEncrypted")
    .setPlacement("placement")
    .build()
Adjoe.setUAParams(context, adjoeParams)

AdjoeParams adjoeParams = new AdjoeParams.Builder()
                .setUaNetwork("network")
                .setUaChannel("channel")
                .setUaSubPublisherCleartext("SubPublisherCleartext")
                .setUaSubPublisherEncrypted("SubPublisherEncrypted")
                .setPlacement("placement")
                .build();
Adjoe.setUAParams(context, adjoeParams);

adjoe.setUAParams({
            'uaNetwork': "RN-uaNetwork",
            'uaChannel': "RN-uaChannel",
            'uaSubPublisherCleartext': "RN-uaSubPublisherCleartext",
            'uaSubPublisherEncrypted': "RN-uaSubPublisherEncrypted",
            'placement': 'RN-placement'
})
.then(() => {
            this.logDialog(`Setting UA prameters were sucessful.`);
})
.catch((err) => {
            this.logDialog(`Setting UA prameters failed.`);
            console.error(err);
});

Adjoe.setUAParams(new AdjoeParams()
        ..uaNetwork = 'uaNetwork'
        ..uaChannel = 'uaChannel'
        ..uaSubPublisherCleartext = 'uaSubPublisherCleartext'
        ..uaSubPublisherEncrypted = 'uaSubPublisherEncrypted'
        ..placement = 'placement');

AdjoeParams adjoeParams = new AdjoeParams();
adjoeParams.SetUaNetwork("network")
           .SetUaChannel("Channel")
           .SetUaSubPublisherCleartext("SubPublisherCleartext")
           .SetUaSubPublisherEncrypted("SubPublisherEncrypted")
           .SetPlacement("placement");
Adjoe.SetUAParams(adjoeParams);

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'male',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

User Profile Information

The birthday data should be in ISO format. If your data doesn't already look like that, please make sure to format it so that it is. Example: 2023-07-17T22:25:00.000Z

fun adjoeUserProfile(): AdjoeUserProfile {
    val gender: AdjoeGender = when (getUserGender()) {
        "male" -> AdjoeGender.MALE
        "female" -> AdjoeGender.FEMALE
        else -> AdjoeGender.UNKNOWN
    }

// if you don't know the exact birthday, the year is enough
    val birthday: Date = if (isExactBirthdayKnown()) {
        getUserBirthday()
    } else {
        val calendar = Calendar.getInstance()
        calendar.set(Calendar.YEAR, getYearOfBirth())
        calendar.set(Calendar.MONTH, 0)
        calendar.set(Calendar.DAY_OF_MONTH, 0)
        calendar.time
    }

    return AdjoeUserProfile(gender, birthday)
}

public class UserProfileUtils {

    public static AdjoeUserProfile adjoeUserProfile() {
        AdjoeGender gender = getAdjoeGender(getUserGender());
        Date birthday = getBirthday();
        return new AdjoeUserProfile(gender, birthday);
    }

    private static AdjoeGender getAdjoeGender(String userGender) {
        switch (userGender) {
            case "male":
                return AdjoeGender.MALE;
            case "female":
                return AdjoeGender.FEMALE;
            default:
                return AdjoeGender.UNKNOWN;
        }
    }

    private static String getUserGender() {
        // Implement this method to get the user's gender
        return "male"; // Example placeholder
    }

    private static Date getBirthday() {
        if (isExactBirthdayKnown()) {
            return getUserBirthday();
        } else {
            Calendar calendar = Calendar.getInstance();
            calendar.set(Calendar.YEAR, getYearOfBirth());
            calendar.set(Calendar.MONTH, Calendar.JANUARY);
            calendar.set(Calendar.DAY_OF_MONTH, 1);
            return calendar.getTime();
        }
    }

    private static Date getUserBirthday() {
        // Implement this method to get the user's birthday
        return new Date(); // Example placeholder
    }

    private static boolean isExactBirthdayKnown() {
        // Implement this method to determine if the exact birthday is known
        return true; // Example placeholder
    }

    private static int getYearOfBirth() {
        // Implement this method to get the user's year of birth
        return 1990; // Example placeholder
    }
}

function adjoeUserProfile() {
    const userGender = getUserGender();
    let gender;
    if (userGender === "male") {
        gender = "MALE";
    } else if (userGender === "female") {
        gender = "FEMALE";
    } else {
        gender = "UNKNOWN";
    }

// if you don't know the month or day, you can set them to 01
    let birthday;
    if (isExactBirthdayKnown()) {
        birthday = new Date(getUserBirthday());
    } else {
        const calendar = new Date();
        calendar.setFullYear(getYearOfBirth());
        calendar.setMonth(0);
        calendar.setDate(1);
        birthday = calendar;
    }

    birthday = birthday.toISOString() 
    return { gender, birthday };
}

import 'package:adjoe/user_profile.dart';
import 'package:adjoe/gender.dart';

AdjoeGender gender;
switch (getUserGender()) {
  case "male":
    gender = AdjoeGender.MALE;
    break;

  case "female":
    gender = AdjoeGender.FEMALE;
    break;

  default:
    gender = AdjoeGender.UNKNOWN;
    break;
}

// set the birthday. If you don't know the user's exact birthday, the year is already enough.
DateTime birthday = getUserBirthday();

AdjoeUserProfile adjoeUserProfile = AdjoeUserProfile()
  ..gender = gender
  ..birthday = birthday;

AdjoeGender gender;
string userGender = GetUserGender();
if (userGender == "male")
    gender = AdjoeGender.MALE;
else if (userGender == "female")
    gender = AdjoeGender.FEMALE;
else
    gender = AdjoeGender.UNKNOWN;

DateTime birthday = new DateTime();
birthday = DateTime.SpecifyKind(birthday, DateTimeKind.Utc);

if (isExactBirthdayKnown())
    {
        birthday = DateTime.Parse(getUserBirthday());
    }
else
    {
        birthday = new DateTime(getYearOfBirth(), 1, 1);
    }

string birthdayIso = birthday.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
AdjoeUserProfile adjoeUserProfile = new AdjoeUserProfile(gender, birthdayIso);

//Cordova has a different API that can be used to set the user profile information.

window.AdjoePlugin.setProfile(
  source,
  gender,
  birthday,
  function() {
    // successfully sent the profile information to adjoe
  },
  function(err) {
    // an error occurred while sending the profile information to adjoe
  },
);

adjoe Extensions

These are optional identifiers used in your backend. They will be provided back in the S2S payout URL.

val adjoeExtensions = AdjoeExtensions.Builder()
    .setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5")
    .build()

AdjoeExtensions adjoeExtensions = new AdjoeExtensions.Builder()
    .setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5")
    .build();

// A complete example
Adjoe.init('sdkHash', 
    { 
      'user_id': "06957070-6579-46cd-9665-d8fe7cd286d5",
      'applicationProcessName' : "io.adjoe.anyApp",
      'adjoeParams': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoeExtension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'adjoeUserProfile': {
                'gender': 'male',
                'birthday': "2023-07-17T22:25:00.000Z"
        }
    
    }).then(() => {
      console.log('Initialized adjoe SDK');
    })
    .catch((err) => {
      console.log('Could not initilize adjoe SDK');
      console.error(err);
    });

AdjoeOptions options = new AdjoeOptions()
  ..userId = 'user_id'
  ..applicationProcessName = 'io.adjoe.FlutterTestApp'
  ..params = (new AdjoeParams()
    ..uaNetwork = 'The user acquisition network'
    ..uaChannel = 'The user acquisition channel.'
    ..uaSubPublisherCleartext = 'The user acquisition publisher cleartext'
    ..uaSubPublisherEncrypted = 'The user acquisition publisher encrypted'
    ..placement = 'The offerwall placement')
  ..userProfile = (new AdjoeUserProfile()
    ..birthday = birthday
    ..gender = gender)
  ..extensions = (new AdjoeExtensions()
    ..subId1 = 'flutter_subId1'
    ..subId2 = 'flutter_subId2'
    ..subId3 = 'flutter_subId3'
    ..subId4 = 'flutter_subId4'  
    ..subId5 = 'flutter_subId5');

AdjoeExtensions adjoeExtensions = new AdjoeExtensions();
adjoeExtensions.setSubId1("subId 1")
    .setSubId2("subId 2")
    .setSubId3("subId 3")
    .setSubId4("subId 4")
    .setSubId5("subId 5");

// A complete example
window.AdjoePlugin.initialize(
  'sdkHash',
  { 
        'user_id': getUserId(),
        'adjoe_params': {
                'uaNetwork': "uaNetwork_value",
          	'uaChannel': "uaChannel_value",
          	'uaSubPublisherCleartext': "uaSubPublisherCleartext_value",
          	'uaSubPublisherEncrypted': "uaSubPublisherEncrypted_value",
          	'placement': 'placement_value'
        }, 
        'adjoe_extension': {
                'subId1': "RN_subId1",
                'subId2': "RN_subId2",
                'subId3': "RN_subId3",
                'subId4': "RN_subId4",
                'subId5': "RN_subId5"
        }, 
        'user_profile': {
                'gender': 'male',
                'birthdate': "2023-07-17T22:25:00.000Z"
        }
    },
  function() {
      // the adjoe plugin was initialized successfully
  },
  function(err) {
      // an error occurred while initializing the adjoe plugin.
  },
);

Checking Initialization

Important: Do not call Adjoe.init based on the result of isInitialized.The SDK already performs its own initialization checks. Doing so again may degrade the user experience.

Playtime SDK for Android

A New Way to Monetize and Engage

Supported Wrappers

Requirements

Get Started

Step 1. Get Your SDK Hash

Step 2. Add Test Devices

Step 3. Add the Playtime SDK Dependency

Step 4: Enable Logs (Native only)

Integrate the Playtime SDK

Initialize the Playtime SDK

Best practices for the SDK initialization:

Initialization

adjoe Options

adjoe Parameters

User Profile Information

adjoe Extensions

Checking Initialization

Launch Playtime

Campaigns

Example of a Playtime Campaign

Example of an Advance+ Campaign

Terms of Service

Access to Advertising Info

How Games Are Matched to Users

Add a Teaser Event

Launch the Playtime Offerwall

Set Up a Listener (Native)

Example: Playtime Offerwall & My Games

Additional Useful Methods

Examples

Server-to-Server Payouts

Set Up Server-to-Server (S2S) Payouts

Endpoint Structure

Calculate the SID

S2S Security

Retry Logic

For Playtime Campaigns

For Advance and Advance+ Campaigns

Best Practices for Rewarding Users

Integration and Launch Checklist

Integration

Launch

Troubleshooting & Support

Troubleshoot Common Issues

Operation fails with the exception "not available for this user".

You don't see any games in the offerwall.

Notification of reward received, but the SDK does not display the new rewards.

App compilation fails with "Duplicate class" or "Duplicate entry" exceptions.

Duplicate class due to androidx.work:work-runtime:$workVersion.

Get Further Support

FAQ

Playtime SDK

Using the Playtime Offerwall

Business

Changelog

2.2.2

2.2.1

2.2.0

2.1.1

2.1.0

2.0.7

2.0.5

2.0.4

2.0.2

1.5.1

1.5.0

1.4.15

1.4.14

1.4.13.1

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

Previous Versions

FAQ

Duplicate class due to `androidx.work:work-runtime:$workVersion`.

Duplicate class due to `androidx.work:work-runtime:$workVersion`.