lib/models/ad_campaign.dartDart
import 'package:flutter/material.dart';
import 'localized_content.dart';
enum AdPlacement {
sponsorInterstitial,
homeBanner,
mapBanner,
toursBanner,
tourDetailBanner,
plannerBanner,
appBanner,
sideMenu,
nearby,
}
enum CampaignCreativeType { lottie, image, legacy }
enum CampaignLottieVariant { standard, portrait, landscape, tablet }
enum CampaignTargetType { url, partner, poi, tour, deepLink, none }
class CampaignTarget {
const CampaignTarget({
this.type = CampaignTargetType.none,
this.id,
this.url,
this.path,
});
final CampaignTargetType type;
final String? id;
final String? url;
final String? path;
bool get hasTarget => switch (type) {
CampaignTargetType.url => url?.trim().isNotEmpty == true,
CampaignTargetType.partner ||
CampaignTargetType.poi ||
CampaignTargetType.tour =>
id?.trim().isNotEmpty == true,
CampaignTargetType.deepLink => path?.trim().isNotEmpty == true,
CampaignTargetType.none => false,
};
}
class AdCampaign {
const AdCampaign({
required this.id,
required this.partnerName,
required this.headline,
required this.body,
required this.buttonLabel,
required this.validFrom,
required this.validUntil,
required this.placements,
this.landingPageUrl,
this.imageUrl,
this.fallbackImageUrl,
this.lottieUrl,
this.lottieVariants = const {},
this.creativeType = CampaignCreativeType.image,
this.lottieFit = BoxFit.contain,
this.backgroundColor = Colors.white,
this.target = const CampaignTarget(),
this.galleryUrls = const [],
this.priority = 50,
this.frequencyHours = 24,
this.enabled = true,
this.targetCategories = const {},
this.sponsorModules = const {},
this.appBannerScreens = const {},
this.nearbyPosition = 2,
this.locationsEnabled = false,
this.locationPartnerId,
this.utilityTitle = '',
this.utilityText = '',
this.resolvedPlacement,
});
final String id;
final String partnerName;
final LocalizedContent headline;
final LocalizedContent body;
final LocalizedContent buttonLabel;
final DateTime validFrom;
final DateTime validUntil;
final Set<AdPlacement> placements;
final String? landingPageUrl;
final String? imageUrl;
final String? fallbackImageUrl;
final String? lottieUrl;
final Map<CampaignLottieVariant, String> lottieVariants;
final CampaignCreativeType creativeType;
final BoxFit lottieFit;
final Color backgroundColor;
final CampaignTarget target;
final List<String> galleryUrls;
final int priority;
final int frequencyHours;
final bool enabled;
final Set<String> targetCategories;
final Set<String> sponsorModules;
final Set<String> appBannerScreens;
final int nearbyPosition;
final bool locationsEnabled;
final String? locationPartnerId;
final String utilityTitle;
final String utilityText;
/// Placement for which this campaign payload was resolved by /ads.
final AdPlacement? resolvedPlacement;
bool isActiveAt(DateTime now) =>
enabled && !now.isBefore(validFrom) && !now.isAfter(validUntil);
bool supports(AdPlacement placement) => placements.contains(placement);
bool get hasGallery => galleryUrls.isNotEmpty;
bool get hasLottie =>
creativeType == CampaignCreativeType.lottie &&
(lottieUrl?.trim().isNotEmpty == true || lottieVariants.isNotEmpty);
String? lottieUrlForSize(Size size) {
if (creativeType != CampaignCreativeType.lottie) return null;
final shortestSide = size.shortestSide;
CampaignLottieVariant preferred;
if (shortestSide >= 600) {
preferred = CampaignLottieVariant.tablet;
} else if (size.width > size.height) {
preferred = CampaignLottieVariant.landscape;
} else {
preferred = CampaignLottieVariant.portrait;
}
final selected = lottieVariants[preferred]?.trim();
if (selected != null && selected.isNotEmpty) return selected;
final standard = lottieVariants[CampaignLottieVariant.standard]?.trim();
if (standard != null && standard.isNotEmpty) return standard;
final legacy = lottieUrl?.trim();
return legacy == null || legacy.isEmpty ? null : legacy;
}
bool supportsScreen(String screen) =>
appBannerScreens.isEmpty || appBannerScreens.contains(screen);
bool matchesCategory(String? category) =>
targetCategories.isEmpty ||
(category != null && targetCategories.contains(category));
}