SDK Methods

All methods are thread safe and all SDK operations are performed on an internal actor, so the SDK API calls will never block the main thread.

Android Library

PlaytimeStudio Class

The Playtime Studio SDK's entry point class offers methods to retrieve campaigns and installed apps. This enables you to display them in your custom UI and guide users to the App Store for installation.

getPermissions

Get the permissions that the user has granted to Playtime.

Playtime.getPermissions(context: Context, listener:PlaytimePermissionsListener)

showPermissionsPrompt

Show a system prompt which requests required permissions. This will currently either show the Usage Permissions acceptance system dialog, or simply send a successful response if that has been accepted already.

Playtime.showPermissionsPrompt(activity: Activity, listener:PlaytimePermissionsListener)

setPlaytimeOptions

Whenever the SDK hash is provided, the SDK will be reinitialized and we will use the new hash for all subsequent requests.

fun setPlaytimeOptions(options: PlaytimeOptions, listener: PlaytimeOptionsListener) 

This API can also be used when you have multiple apps with multiple SDK hashes. If you don't provide SDKHash through this API reference, a default (non-sandbox) SDKHash will be assigned.

getCampaigns

Get the list of campaigns. Use the Campaign model returned in the response to make your unique Playtime catalog. There are two options for calling this method: with and without a token (provided by the Offer API).

The playtimeOptions object is required to have the userId of the specific user in order for adjoe to map the rewards to the user.

PlaytimeStudio.getCampaigns(context: Context, options: PlaytimeOptions?, listener: PlaytimeCampaignsListener)

PlaytimeStudio.getCampaigns(context: Context, token: List<String>, options: PlaytimeOptions?, listener: PlaytimeCampaignsListener)

openInStore

The SDK handles all the actions related to navigating to the Play store and the eventual install following a user’s action, taking care of tracking & app install measurement.

Playtime.openInStore(context: Context, campaign: PlaytimeCampaign, listener: PlaytimeOpenStoreListener)

getInstalledCampaigns

Get the list of the campaigns that the user has already installed. Use the Campaign model returned in the response to make your unique "In Progress" catalog and offer details view.

Playtime.getInstalledCampaigns(context: Context, options: PlaytimeOptions, listener: PlaytimeCampaignsListener)

openInstalledCampaign

The SDK handles all the actions related to navigating to the installed app.

Playtime.openInstalledCampaign(campaign: PlaytimeCampaign)

---

PlaytimeOptions Class

The options passed to Playtime methods.

PlaytimeOptions

The userId is 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.

class PlaytimeOptions {
    val sdkHash: String?
    val userId: String  // ID sent by publisher to uniquely reward users.
    val userProfile: PlaytimeUserProfile?
    val params: PlaytimeParams?
}

PlaytimeUserProfile

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.

Use PlaytimeUserProfileBuilder: it accepts date and converts it to an ISO string.

class PlaytimeUserProfile(gender: PlaytimeGender?, birthday: Date?)

PlaytimeParams

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.

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

class PlaytimeParams {
    val uaNetwork: String?
    val uaChannel: String?
    val uaSubPublisherEncrypted: String?
    val uaSubPublisherCleartext: String?
    val placement: String?
}

Parameter	Explanation
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. Option Explanation nongaming Only shows non-gaming campaigns gaming Only shows gaming campaigns both Shows both gaming and non-gaming

PlaytimeExtensions

Optional identifiers that are provided back in the S2S payout URL.

class PlaytimeExtensions {
    val subId1: String?
    val subId2: String?
    val subId3: String?
    val subId4: String?
    val subId5: String?
}

getStatus

Returns the initialization status (successful / error) and the user's fraud status as a boolean.

fun getStatus(): PlaytimeStatus

---

Permissions Class

This class shows what permissions have currently been accepted by the user and can be used to determine whether or not the Permissions screen should be shown.

PlaytimePermissions

class PlaytimePermissions { 
    val isTOSAccepted: Boolean
    val isUsagePermissionAccepted: Boolean
}

PlaytimePermissionsListener

interface PlaytimePermissionsListener {
    fun onReceived(response: PlaytimePermissionsResponse)
    fun onError(error: PlaytimeResponseError)
}

PlaytimePermissionsResponse

class PlaytimePermissionsResponse {
  val permissions: PlaytimePermissions
}

---

showCatalog

Open the Playtime Catalog.

Playtime.showCatalog(activity: Activity, options: PlaytimeOptions)

Playtime Errors

Errors that can be thrown by the SDK:

PlaytimeResponseError:

class PlaytimeResponseError(val message: String)

PlaytimeError

enum class PlaytimeError {
    // The provided SDK hash is not a valid MD5 hash.
    INVALID_HASH,
    // An operation was attempted before the SDK was initialized.
    SDK_NOT_INITIALIZED,
    // A campaign with the given UUID was not found.
    CAMPAIGN_NOT_FOUND,
    // Other error occurred.
    INTERNAL_ERROR
}