mirror of
https://github.com/RevenueCat/purchases-ios
synced 2026-11-11 22:55:55 +05:45
Drago Crnjac
b182c89baa
* Add client-reported rewards for checkpoint ad steps * Let custom ad presenters return unverified rewards
84 lines
3.7 KiB
Swift
84 lines
3.7 KiB
Swift
//
|
|
// Copyright RevenueCat Inc. All Rights Reserved.
|
|
//
|
|
// Licensed under the MIT License (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://opensource.org/licenses/MIT
|
|
//
|
|
// DefaultCheckpointWorkflowResolver+Ad.swift
|
|
//
|
|
// Created by RevenueCat.
|
|
|
|
import Foundation
|
|
|
|
extension DefaultCheckpointWorkflowResolver {
|
|
|
|
static let adStepType = "ad"
|
|
static let adIdentifierParam = "ad_identifier"
|
|
static let mediatorParam = "mediator"
|
|
static let adFormatParam = "ad_format"
|
|
static let rewardVerificationParam = "reward_verification"
|
|
static let clientReportedRewardVerification = "client_reported"
|
|
|
|
func resolveAdStep(
|
|
_ rule: CheckpointRule,
|
|
step: WorkflowStep,
|
|
in workflowData: WorkflowDataResult,
|
|
traceID: String
|
|
) async -> (resolution: CheckpointResolution, stepEvents: [WorkflowEvent]) {
|
|
guard workflowData.workflow.steps.count == 1 else {
|
|
return (Self.unservable(rule, reason: "an ad step cannot be mixed with other steps"), [])
|
|
}
|
|
|
|
return await Self.trackingStepEvents(for: step, in: workflowData, traceID: traceID) {
|
|
Self.resolveAd(rule, step: step)
|
|
}
|
|
}
|
|
|
|
/// Serves a workflow whose only step is a terminal `ad` step as an ad the app owns.
|
|
///
|
|
/// Only `ad_identifier`, `mediator` and `ad_format` are validated. `reward_verification` turns reward
|
|
/// verification off only when it is `client_reported`: a missing or unknown value keeps it on, as for steps
|
|
/// saved before the param existed. Anything else the step happens to carry is ignored rather than treated as
|
|
/// unservable, since a step of this kind renders nothing.
|
|
static func resolveAd(_ rule: CheckpointRule, step: WorkflowStep) -> CheckpointResolution {
|
|
guard let adIdentifier = Self.stringParam(Self.adIdentifierParam, in: step), !adIdentifier.isEmpty else {
|
|
return Self.unservable(rule, reason: "the ad step has no valid ad identifier")
|
|
}
|
|
guard let mediator = Self.stringParam(Self.mediatorParam, in: step), !mediator.isEmpty else {
|
|
return Self.unservable(rule, reason: "the ad step has no valid mediator")
|
|
}
|
|
guard let adFormat = Self.stringParam(Self.adFormatParam, in: step), !adFormat.isEmpty else {
|
|
return Self.unservable(rule, reason: "the ad step has no valid ad format")
|
|
}
|
|
|
|
return .matchedAd(ResolvedAdStep(
|
|
adIdentifier: adIdentifier,
|
|
mediator: Self.normalizedMediator(mediator),
|
|
adFormat: AdFormat(rawValue: adFormat),
|
|
rewardVerificationEnabled: Self.stringParam(Self.rewardVerificationParam, in: step)
|
|
!= Self.clientReportedRewardVerification
|
|
))
|
|
}
|
|
|
|
static func stringParam(_ key: String, in step: WorkflowStep) -> String? {
|
|
guard case let .string(value)? = step.paramValues[key] else { return nil }
|
|
return value
|
|
}
|
|
|
|
/// The backend serializes mediators in lowercase (`admob`) while the SDK's canonical constants are
|
|
/// mixed case (`AdMob`), and `MediatorName` equality is case-sensitive. Map mediators checkpoints
|
|
/// support onto their canonical instance so presenters can match on them; anything else (including
|
|
/// unsupported mediators like AppLovin) passes through untouched.
|
|
private static let knownMediators: [MediatorName] = [.adMob]
|
|
|
|
private static func normalizedMediator(_ rawValue: String) -> MediatorName {
|
|
return Self.knownMediators.first { known in
|
|
known.rawValue.caseInsensitiveCompare(rawValue) == .orderedSame
|
|
} ?? MediatorName(rawValue: rawValue)
|
|
}
|
|
|
|
}
|