library/io.adjoe.sdk.studio/PlaytimeCampaign

PlaytimeCampaign

data class PlaytimeCampaign

The model that represents a campaign and/or installed application.

Types

data class EventConfig(val sequentialActions: List<PlaytimeCampaign.PlaytimeRewardAction>, val bonusActions: List<PlaytimeCampaign.PlaytimeRewardAction>, val timeBasedActions: List<PlaytimeCampaign.PlaytimeRewardAction>, val totalCoinsCollected: Int?, val totalCoinsPossible: Int?, val cashbackReward: PlaytimeCampaign.PlaytimeCashbackConfig?, val multipliersActions: List<PlaytimeCampaign.PlaytimeRewardActionMultiplier>)

Configuration for multi-event rewards.

PlaytimeCashbackConfig

data class PlaytimeCashbackConfig(val exchangeRate: Float?, val cashbackDescription: String?, val maxLimitPerCampaignUSD: Float?, val maxLimitPerCampaignCoins: Float?, val completedRewards: PlaytimeCampaign.PlaytimeCashbackReward?, val pendingRewards: PlaytimeCampaign.PlaytimeCashbackReward?)

Configuration for the Playtime Cashback feature.

PlaytimeCashbackReward

data class PlaytimeCashbackReward(val totalCoins: Int?, val events: List<PlaytimeCampaign.PlaytimeCashbackRewardEvent>)

Cashback reward info.

PlaytimeCashbackRewardEvent

data class PlaytimeCashbackRewardEvent(val coins: Int?, val processAt: String?, val receivedAt: String?)

Cashback event.

data class PlaytimeMedia(val portrait: String?, val landscape: String?)

A class representing a media item.

PlaytimePromotion

data class PlaytimePromotion(val name: String?, val promotionDescription: String?, val boostFactor: Float?, val startTime: String?, val endTime: String?, val targetingType: String?)

Promotion representation.

PlaytimeRewardAction

data class PlaytimeRewardAction(val name: String?, val taskDescription: String?, val level: Int?, val taskType: String, val playDuration: Int?, val amount: Int, val rewardedAt: String?, val rewardsCount: Int?, val completedRewards: Int?, val timedCoinsDuration: Int?, val timedCoins: Int?, val originalCoins: Int?, val isTimed: Boolean?, val isRewardedForPromotion: Boolean?, val boosterExpiresAt: String?)

Rewarded action representation.

PlaytimeRewardActionMultiplier

data class PlaytimeRewardActionMultiplier(val eventName: String?, val eventDescription: String?, val multiplierFactorPercentage: Int?, val multiplierLevels: Int?, val status: String?, val usedLevels: Int?)

Configuration for a multiplier

Properties

val appCategory: String?

App category.

val appDescription: String

Short description of the app.

val appID: String

Unique identifier for the app.

val appName: String

App name.

campaignExpiresAt

val campaignExpiresAt: String?

Timestamp (ISO 8601) denoting the maximum amount of time after fetching the campaign that it can be installed.

val campaignType: String?

Campaign type.

var campaignUUID: String?

Campaign UUID.

val eventConfig: PlaytimeCampaign.EventConfig?

Event and rewards configuration.

featuredPosition

val featuredPosition: Int?

Ordered position for specific featured campaigns.

val iconImage: String?

URL to the campaign icon image.

val image: PlaytimeCampaign.PlaytimeMedia?

Campaign media assets (portrait & landscape).

val installedAt: String?

App installation timestamp (ISO 8601).

val isCompleted: Boolean

Flag indicating whether all rewards have been collected.

val promotion: PlaytimeCampaign.PlaytimePromotion?

Active promotion details, if any.

rewardingExpiresAfter

val rewardingExpiresAfter: Int?

Time (in days) after which rewards expire after installation.

rewardingExpiresAt

val rewardingExpiresAt: String?

Expiration timestamp (ISO 8601) denoting how long players can get rewards after installing the app.

val score: Float?

eCPM of the campaign.

val uninstalledAt: String?

App uninstallation timestamp (ISO 8601).

val video: PlaytimeCampaign.PlaytimeMedia?

Campaign video media assets.