SDK Models
SDK Validations
The SDK performs the following validations on its fields:
If a field is an optional string type, empty strings are mapped to null.
If a field is an optional string denoting a date, invalid timestamps or zero-date timestamps (e.g.,
0001-01-01T00:00:00.000Z) are mapped to null.Fields of the
PlaytimeMediaandPlaytimePromotiontypes are null if all of their child fields are null, empty, or contain invalid timestamp values.
Models
For Type,
?Means OptionalityFor Platform, the value is null for unsupported platforms
campaignUUID
string?
Android, iOS
4.0.0-beta.1
Campaign UUID
appName
string
Android, iOS
4.0.0-beta.1
App name.
appDescription
string
Android, iOS
4.0.0-beta.1
Short description of the app.
appID
string
Android, iOS
4.0.0-beta.1
Unique identifier for the app.Android: com.example.myapp.iOS: App Store ID.
appBundleID
string?
iOS
4.0.0-beta.1
iOS bundle ID (com.example.myapp).
appStoreID
string?
iOS
4.0.0-beta.1
iOS application’s store ID number.
installedAt
string?
Android, iOS
4.0.0-beta.1
App installation timestamp (ISO 8601).
uninstalledAt
string?
Android, iOS
4.0.0-beta.1
App uninstallation timestamp (ISO 8601).
rewardingExpiresAfter
int?
Android, iOS
4.0.0-beta.1
Time (days) after which rewards expire post-install.
rewardingExpiresAt
string?
Android, iOS
4.0.0-beta.1
Expiration timestamp (ISO 8601) for reward eligibility.
campaignExpiresAt
string?
Android, iOS
4.0.0-beta.1
Maximum time after fetching campaign that install is valid.
appCategory
string?
Android, iOS
4.0.0-beta.1
App category.
campaignType
string?
Android, iOS
4.0.0-beta.1
Campaign type.
featuredPosition
int?
Android, iOS
4.0.0-beta.1
Ordered position for featured campaigns.
score
float?
Android, iOS
4.0.0-beta.1
The score of the campaign.
iconImage
string?
Android, iOS
4.0.0-beta.1
URL to campaign icon.
image
PlaytimeMedia?
Android, iOS
4.0.0-beta.1
Campaign media assets (portrait & landscape).
video
PlaytimeMedia?
Android, iOS
4.0.0-beta.1
Campaign video media assets.
promotion
PlaytimePromotion?
Android, iOS
4.0.0-beta.1
Active promotion details, if any.
eventConfig
PlaytimeEventConfig?
Android, iOS
4.0.0-beta.1
Event and rewards configuration.
isCompleted
bool
Android, iOS
4.0.0-beta.1
Flag: all rewards collected.
PlaytimeMedia
portrait
string?
Android, iOS
4.0.0-beta.1
URL to portrait-oriented media.
landscape
string?
Android, iOS
4.0.0-beta.1
URL to landscape-oriented media.
PlaytimePromotion
name
string?
Android, iOS
4.0.0-beta.1
Promotion name.
promotionDescription
string?
Android, iOS
4.0.0-beta.1
Description of the promotion.
boostFactor
float?
Android, iOS
4.0.0-beta.1
Boost multiplier for the promotion.
startTime
string?
Android, iOS
4.0.0-beta.1
Promotion start timestamp (ISO 8601).
endTime
string?
Android, iOS
4.0.0-beta.1
Promotion end timestamp (ISO 8601).
targetingType
string?
Android, iOS
4.0.0-beta.3
Targeting type for high-quality users.
PlaytimeEventConfig
sequentialActions
array: PlaytimeRewardAction
Android, iOS
4.0.0-beta.1
Ordered rewarded events.
bonusActions
array: PlaytimeRewardAction
Android, iOS
4.0.0-beta.1
Bonus rewarded events.
timeBasedActions
array: PlaytimeRewardAction
Android
4.0.0-beta.1
Time-play-based rewards.
totalCoinsCollected
int
Android, iOS
4.0.0-beta.1
Total coins collected.
totalCoinsPossible
int?
Android, iOS
4.0.0-beta.1
Max possible coins.
cashbackReward
PlaytimeCashbackConfig?
Android, iOS
4.0.0-beta.3
Cashback reward config.
multipliersActions
array: PlaytimeRewardActionMultiplier
Android
4.0.0-beta.3
Events that multiply rewards.
PlaytimeRewardActionMultiplier
eventName
string?
Android
4.0.0-beta.3
Event name.
eventDescription
string?
Android
4.0.0-beta.3
Event description.
multiplierFactorPercentage
int?
Android
4.0.0-beta.3
Multiplier factor (0–100).
multiplierLevels
int?
Android
4.0.0-beta.3
Max number of levels multiplied.
status
string?
Android
4.0.0-beta.3
Event status: Pending / Active / Finished.
usedLevels
int?
Android
4.0.0-beta.3
Levels multiplied by the event.
PlaytimeCashbackConfig
exchangeRate
float?
Android, iOS
4.0.0-beta.3
Coins per 1 USD IAP.
cashbackDescription
string?
Android, iOS
4.0.0-beta.3
Cashback reward description.
maxLimitPerCampaignUSD
float?
Android, iOS
4.0.0-beta.3
Max USD for cashback.
maxLimitPerCampaignCoins
float?
Android, iOS
4.0.0-beta.3
Max coin cashback (exchangeRate × maxLimitPerCampaignUSD).
completedRewards
PlaytimeCashbackReward?
Android, iOS
4.0.0-beta.3
Completed cashback rewards.
pendingRewards
PlaytimeCashbackReward?
Android, iOS
4.0.0-beta.3
Pending cashback rewards.
PlaytimeCashbackReward
totalCoins
int?
Android, iOS
4.0.0-beta.3
Total coins in reward group.
events
array: PlaytimeCashbackRewardEvent?
Android, iOS
4.0.0-beta.3
Events in reward group.
PlaytimeCashbackRewardEvent
coins
int?
Android, iOS
4.0.0-beta.3
Coins granted.
processAt
string?
Android, iOS
4.0.0-beta.3
Process timestamp (ISO 8601).
receivedAt
string?
Android, iOS
4.0.0-beta.3
Received timestamp (ISO 8601).
PlaytimeRewardAction
name
string?
Android, iOS
4.0.0-beta.1
Reward action name.
taskDescription
string?
Android, iOS
4.0.0-beta.1
Task description.
taskType
string
Android, iOS
4.0.0-beta.1
Task type: sequential, bonus, playtime.
playDuration
int?
Android
4.0.0-beta.1
Play duration (seconds).
level
int?
Android
4.0.0-beta.1
Level number for time-based event.
amount
int
Android, iOS
4.0.0-beta.1
Reward amount.
rewardedAt
string?
Android, iOS
4.0.0-beta.1
Reward granted timestamp (ISO 8601).
rewardsCount
int?
Android, iOS
4.0.0-beta.3
Number of times reward can repeat.
completedRewards
int?
Android, iOS
4.0.0-beta.3
Times rewarded.
timedCoinsDuration
int?
Android, iOS
4.0.0-beta.3
Booster reward window (minutes).
timedCoins
int?
Android, iOS
4.0.0-beta.3
Coins rewarded during booster.
originalCoins
int
Android, iOS
4.0.0-beta.3
Coins without bonuses.
isTimed
bool?
Android, iOS
4.0.0-beta.3
Booster event flag.
isRewardedForPromotion
bool?
Android, iOS
4.0.0-beta.3
Rewarded with promotion.
boosterExpiresAt
string?
Android, iOS
4.0.0-beta.3
Booster expiration timestamp.
Last updated