Rewarded ads

Report rewarded ad consumption

Requires Authorization.

Reports status of a rewarded ad watch. Send STARTED when the ad begins and COMPLETED when it finishes. A COMPLETED report grants the reward identified by type (e.g. READ_RECEIPTS).

PUT /v1/rewarded-ads/consumption

Body:

• source — string, Ad mediation network that served the ad, e.g. APPLOVIN.
• status — Rewarded Ad Consumption Status, Lifecycle status being reported.
• type — Rewarded Ad Type, Reward being consumed.
• adId — string, Identifier of the ad instance, as reported by the ad SDK.

Restrict a rewarded ad reward

Requires Authorization.

Updates the restriction for the given rewarded ad reward type, sent by the client when a reward should no longer be offered.

PUT /v1/rewarded-ads/rewards/restriction

Body:

• type — Rewarded Ad Type, Reward to restrict.

List rewarded ad rewards

Requires Authorization.

Returns the rewarded ad rewards available to the current user and their state. Watching an ad for an ELIGIBLE reward temporarily unlocks the corresponding feature (for example READ_RECEIPTS).

GET /v1/rewarded-ads/rewards

Response:

• rewards — array of Rewarded Ad Reward

Rewarded Ad Type

Feature that can be temporarily unlocked by watching a rewarded ad.

• LAST_VIEWED_ME_PROFILE — Reveal the most recent profile that viewed you
• ADS_FREE_SESSION — Temporarily remove ads
• READ_RECEIPTS — Temporarily enable message read receipts
• CASCADE_PROFILES_UNLOCK — Unlock additional cascade (grid) profiles
• TAPS_RECEIVED_UNLOCK — Reveal taps you have received

Rewarded Ad Reward Status

Current state of a rewarded ad reward for the requesting user.

• ELIGIBLE — The user may watch an ad to activate this reward
• ACTIVE — The reward is currently unlocked; see remainingTime
• EXHAUSTED — The reward has been used and is not currently available

Rewarded Ad Interval

Unit of time that duration is measured in.

• "DAYS"
• "HOURS"
• "MINUTES"

Rewarded Ad Consumption Status

Lifecycle status reported while consuming a rewarded ad.

• STARTED — The ad began playing
• COMPLETED — The ad finished and the reward should be granted

Rewarded Ad Reward

State of a single rewarded ad reward. All fields are nullable.

• type — Rewarded Ad Type, Feature this reward unlocks., optional
• status — Rewarded Ad Reward Status, Current state of the reward., optional
• duration — long integer, Length of the unlock window, measured in interval units (e.g. 1 with interval HOURS)., optional
• interval — Rewarded Ad Interval, Unit for duration., optional
• remainingTime — long integer, Time remaining before an ACTIVE reward expires. null unless the reward is active., optional
• countdownTime — long integer, Time remaining before an EXHAUSTED reward becomes ELIGIBLE again. null unless applicable., optional