Use the SDK

Import the Library

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';

Set Up PlaytimeOptions and ShowCatalog

In your main activity, you can set up playtimeOptions and call showCatalog .

// The setPlaytimeOptions 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 call setPlaytimeOptions in initState as well as didChangeAppLifecycleState.

PlaytimeOptions options = new PlaytimeOptions()
  ..userId = 'user_id'
  ..sdkHash = 'YOUR_SDK_HASH'
  ..applicationProcessName = 'io.adjoe.FlutterTestApp'
  ..params = (new PlaytimeParams()
    ..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')
    ..promotionTag = 'promotion-id'
  ..userProfile = (new PlaytimeUserProfile()
    ..birthday = birthday
    ..gender = gender)
  ..extensions = (new PlaytimeExtensions()
    ..subId1 = 'subId1'
    ..subId2 = 'subId2'
    ..subId3 = 'subId3'
    ..subId4 = 'subId3'  
    ..subId5 = 'subId4');

  void showCatalogWithOptions() {
    Playtime.showCatalogWithOptions(options).then((_) {
      print("showCatalogWithOptions Finished Successfully");
    }, onError: (err) {
      print('showCatalogWithOptions failed: $err');
    });
  }
}

Using setPlaytimeOptions

The SDK also provides an option to independently set up the playtimeOptions before calling showCatalog. Calling setPlaytimeOptions will reinitialize the SDK.

setPlaytimeOptions(PlaytimeOptions options) → Future<void>

Using getStatus to showCatalog

The SDK that ensures that showCatalog and other methods that trigger SDK re-initialization wait until the previous init request finishes before executing. Regardless, you still have the option to conditionally call showCatalog based on the SDK's initialization status.

void showAdjoeCatalog() {
  // Get current SDK status
  final status = Playtime.getStatus();

  print('ADJOE - Current SDK Status: $status');

  if (status.isInitialized) {
    try {
      // Show catalog with options
      Playtime.showCatalogWithOptions(
        userId: 'your_user_id',
        sdkHash: 'your_sdk_hash',
        params: {
          'uaNetwork': 'tiktok',
          'uaChannel': 'video',
          'uaSubPublisherCleartext': 'uaSubPublisherCleartext',
          'uaSubPublisherEncrypted': 'uaSubPublisherEncrypted',
          'placement': 'Main Screen',
          'promotionTag': 'promotion-id',
        },
        extensions: {
          'subId1': 'Target Group 1',
          'subId2': 'Target Group 2',
        },
      );
    } catch (e) {
      print('ADJOE - Error launching catalog: $e');
    }
  } else {
    print(
        'ADJOE - SDK is not initialized yet. Please try again in a moment.');
  }
}

Parameters

You should include additional User Acquisition and placement parameters. These parameters allow you to track and analyze Playtime's performance within your app.

You can provide these parameters in any combination, both at any point in the app's lifecycle—such as when a user launches the Playtime Catalog 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.

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.

Parameter

Explanation

userId

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

uaNetwork

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

uaChannel

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

uaSubPublisherCleartext

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.

uaSubPublisherEncrypted

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

placement

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

You can also choose to use adjoe's Apps feature, showing the Playtime catalog with distinct gaming or app experiences.

promotionTag

An optional field that can be sent to adjoe to determine if the user should receive a targeted "user-level" promo.

subId1