o Wh;d@sdZddlmZddlmZmZddlmZddl m Z ddl m Z ddl Z ddlmZe ZGd d d ejZGd d d eZGd ddeZGdddeZGdddeZGdddeZGdddeZdS)a Analytics Models ================ Django models for the Adtlas Analytics module. These models handle storage and management of analytics data, performance metrics, and reporting information for the Dynamic Ad Insertion (DAI) system. Models Overview: - SfrAnalytics: SFR provider analytics data - BouyguesAnalytics: Bouygues provider analytics data - Impression: Individual ad impression tracking - PerformanceMetric: Aggregated performance data - VastResponse: VAST response tracking - AnalyticsReport: Generated report metadata - AdbreakPredict: Ad break prediction data - RealTimeAdbreak: Real-time ad break information Key Features: - Multi-provider analytics support - Real-time data collection - Historical data preservation - Performance optimization - Data validation and integrity - Automated cleanup policies Relationships: - Links to campaigns, channels, and ad spots - User activity tracking - Time-based data organization - Geographic and demographic segmentation Author: Adtlas Development Team Version: 1.0.0 Last Updated: 2024 )models)MinValueValidatorMaxValueValidator) gettext_lazy)timezone)get_user_modelN)Decimalc@seZdZdZejdejdeddZ ej ddeddZ ej ddedd Z ej dded d ZGd d d ZddZddZdS)BaseAnalyticsModela Abstract base model for all analytics models. Provides common fields and functionality for analytics data: - UUID primary key for better performance and security - Created and updated timestamps - Data validation helpers - Common query methods Attributes: id (UUIDField): Primary key using UUID4 created_at (DateTimeField): Record creation timestamp updated_at (DateTimeField): Last update timestamp is_active (BooleanField): Soft delete flag TFz+Unique identifier for this analytics record) primary_keydefaulteditable help_textz&Timestamp when this record was created) auto_now_adddb_indexr z+Timestamp when this record was last updated)auto_nowrr z+Whether this record is active (soft delete)r rr c@seZdZdZdgZdS)zBaseAnalyticsModel.MetaTz -created_atN)__name__ __module__ __qualname__abstractorderingrrVC:\Users\vibe-look\OneDrive\Desktop\Adtlas - Copy\New_Version\apps\analytics\models.pyMeta]s rcCd|_|jddgddS)z,Mark record as inactive instead of deleting.F is_active updated_at update_fieldsNrsaveselfrrr soft_deleteazBaseAnalyticsModel.soft_deletecCr)zRestore a soft-deleted record.TrrrNrr!rrrrestorefr$zBaseAnalyticsModel.restoreN)rrr__doc__r UUIDFielduuiduuid4_id DateTimeFieldZ created_atr BooleanFieldrrr#r%rrrrr 3s4 r c@seZdZdZejdejdeddZejdej dddedd Z ej ded d Z ej ed ed geddZejd eddZejddedeedeedgeddZejddedeedgeddZejddedeedeedgeddZejddedeedgeddZejd eddZejededdZejededdZGdd d Zd!d"Ze d#d$Z!d%d&Z"d'S)( SfrAnalyticsa SFR Analytics data model. Stores analytics data from SFR provider including audience metrics, viewing patterns, and performance indicators. Attributes: channel: Related channel for this analytics data campaign: Related campaign (optional) date: Date of the analytics data hour: Hour of the day (0-23) audience_count: Number of viewers market_share: Market share percentage rating: Audience rating reach: Reach percentage frequency: Average frequency duration: Average viewing duration in seconds demographics: JSON field for demographic data geographic_data: JSON field for geographic distribution channels.ChannelZ sfr_analytics+Channel associated with this analytics data on_delete related_namer campaigns.CampaignT,Campaign associated with this analytics datar2nullblankr3r Date of the analytics datarr rHour of the day (0-23) validatorsr Number of viewersr r 0.00100.00Market share percentage (0-100) max_digitsdecimal_placesr r>r zAudience ratingReach percentage (0-100)Average frequencyz#Average viewing duration in secondszDemographic breakdown datar r8r zGeographic distribution datac@VeZdZdZedZedZgdZej ddgdej ddgdej ddgdgZ d S) zSfrAnalytics.MetaZ analytics_sfrz SFR AnalyticschanneldatehourrOrPfieldsrNcampaignN rrrdb_tabler* verbose_nameverbose_name_pluralunique_togetherrIndexindexesrrrrrrcC d|jjd|jd|jdS)NzSFR Analytics -  -  :00rNnamerOrPr!rrr__str__ zSfrAnalytics.__str__cCstj|jtj|jdS)z.Get datetime object for this analytics record.)rPN)rdatetimecombinerOtimerPr!rrrrdzSfrAnalytics.datetimecCsHt|jdt|jdt|jdtt|jdd}t|dS)z5Calculate overall performance score based on metrics.g333333?g? g?rBN)floatratingreach market_sharemin frequencyround)r"scorerrrget_performance_scores    z"SfrAnalytics.get_performance_scoreN)#rrrr&r ForeignKeyCASCADEr*rNSET_NULLrS DateFieldrOPositiveSmallIntegerFieldrrrPPositiveIntegerFieldZaudience_count DecimalFieldrrlrjrkrnduration JSONFielddictZ demographicsZgeographic_datarrbpropertyrdrqrrrrr.ls      r.c@seZdZdZejdejdeddZejdej dddedd Z ej ded d Z ej ed ed geddZejd eddZejddedeedeedgeddZejddedeedgeddZejddedeedeedgeddZejddedeedgeddZejd eddZejededdZejededdZGdd d Zd!d"Zd#S)$BouyguesAnalyticsa Bouygues Analytics data model. Stores analytics data from Bouygues provider with similar structure to SFR but potentially different metrics and data points. Attributes: channel: Related channel for this analytics data campaign: Related campaign (optional) date: Date of the analytics data hour: Hour of the day (0-23) viewers: Number of viewers share: Market share percentage rating_value: Audience rating value reach_percentage: Reach percentage avg_frequency: Average frequency watch_time: Average watch time in minutes device_data: JSON field for device breakdown age_groups: JSON field for age group data r/Zbouygues_analyticsr0r1r4Tr5r6r9r:rr;r<r=r?r@rArBrCrDrErFzAudience rating valuerIrJzAverage watch time in minuteszDevice breakdown datarKzAge group distribution datac@rL) zBouyguesAnalytics.MetaZanalytics_bouygueszBouygues AnalyticsrMrOrPrQrNrSNrTrrrrr_r[rcCr\)NzBouygues Analytics - r]r^r_r`r!rrrrbjrczBouyguesAnalytics.__str__N) rrrr&rrrrsr*rNrtrSrurOrvrrrPrwZviewersrxrshareZ rating_valueZreach_percentageZ avg_frequencyZ watch_timerzr{Z device_dataZ age_groupsrrbrrrrr}s    r}c@sZeZdZdZejdejdeddZejdejdeddZ ejdejded dZ ej d ed d Z ej d d ed dZejejd eddZejdeddZejddedeedeedgeddZejdeddZejdejd d deddZejed edd Z ejed ed!d Z!Gd"d#d#Z"d$d%Z#e$d&d'Z%e$d(d)Z&d*S)+ Impressiona Individual ad impression tracking model. Records each individual ad impression with detailed tracking information for performance analysis and billing purposes. Attributes: campaign: Related campaign adspot: Related ad spot channel: Channel where impression occurred user_agent: User agent string ip_address: Client IP address (anonymized) timestamp: Exact timestamp of impression duration: How long the ad was viewed completion_rate: Percentage of ad completed click_through: Whether user clicked through vast_response: Related VAST response geographic_info: Geographic information device_info: Device information r4Z impressionsz(Campaign associated with this impressionr1adspots.AdSpotz'Ad spot associated with this impressionr/z!Channel where impression occurredTzUser agent string (anonymized)r8r z*Client IP address (anonymized for privacy)r7r8r zExact timestamp of impressionrrz%How long the ad was viewed in secondsr@rArBrCrDz"Percentage of ad completed (0-100)rFFz#Whether user clicked through the ad VastResponsezRelated VAST responser6z#Geographic information (anonymized)rKzDevice and browser informationc@sZeZdZdZedZedZejdgdejddgdejddgdejddgdgZ d S) zImpression.MetaZanalytics_impressionsrZ Impressions timestamprQrSrNadspotN rrrrUr*rVrWrrYrZrrrrrs rcCd|jjd|jS)Nz Impression - r])rSrarr!rrrrbzImpression.__str__cCs|jtdkS)z0Check if impression was completed (>75% viewed).z75.00N)completion_raterr!rrr is_completedszImpression.is_completedcCs|jtdko |jdkS)zFCheck if impression meets viewability standards (>50% for 2+ seconds).z50.00rBN)rrryr!rrr is_viewableszImpression.is_viewableN)'rrrr&rrrrsr*rSrrN TextFieldZ user_agentGenericIPAddressField ip_addressr,rnowrrwryrxrrrrr-Z click_throughrtZ vast_responserzr{Zgeographic_infoZ device_inforrbr|rrrrrrrns   rc@seZdZdZejdejdeddZejdejdeddZ ej edd Z ej d ed d Z ejd edd ZejdeddZejdeddZejededdZejededdZejejdeddZGdddZddZeddZeddZd S)!rai VAST response tracking model. Stores information about VAST (Video Ad Serving Template) responses for tracking ad delivery and performance. Attributes: campaign: Related campaign adspot: Related ad spot vast_url: VAST XML URL response_time: Response time in milliseconds status_code: HTTP status code error_message: Error message if any xml_content: VAST XML content (truncated) tracking_urls: JSON field with tracking URLs creative_info: Information about the creative served_at: When the VAST was served r4Zvast_responsesz+Campaign associated with this VAST responser1rz*Ad spot associated with this VAST responsez VAST XML URL)r rzResponse time in millisecondsr@zHTTP status codeTzError message if anyrz(VAST XML content (truncated for storage)z Tracking URLs from VAST responserKzInformation about the creativezWhen the VAST was servedrc@sJeZdZdZedZedZejdgdejddgdejdgdgZ dS) zVastResponse.MetaZanalytics_vast_responsesz VAST ResponsezVAST Responses served_atrQrS status_codeNrrrrrr>s  rcCr)NzVAST Response - r])rSrarr!rrrrbHrzVastResponse.__str__cCsd|jko dkSS)z&Check if VAST response was successful.ri,N)rr!rrr is_successfulKrgzVastResponse.is_successfulcCs |jdkS)z/Check if response time was acceptable (<500ms).N) response_timer!rrris_fast_responsePs zVastResponse.is_fast_responseN) rrrr&rrrrsr*rSrURLFieldZvast_urlrwrrvrr error_messageZ xml_contentrzr{Z tracking_urlsZ creative_infor,rrrrrbr|rrrrrrrsl  rc@seZdZdZdedfdedfdedfded fd ed fgZejd ejd eddZ ejdejddd eddZ ej deddZ ej dededdZejdeddZejdeddZejddedeedeed ged!d"Zejddedeedged#d"Zejd$dedeedged%d"Zejd&dedeedged'd"Zejd&dedeedged(d"Zejd)deded*d+ZGd,d-d-Zd.d/Zd0d1Zd2d3Zd4S)5PerformanceMetricah Aggregated performance metrics model. Stores pre-calculated performance metrics for faster reporting and dashboard display. Attributes: campaign: Related campaign channel: Related channel (optional) date: Date of metrics metric_type: Type of metric (daily, weekly, monthly) impressions_count: Total impressions clicks_count: Total clicks completion_rate: Average completion rate ctr: Click-through rate cpm: Cost per mille revenue: Total revenue cost: Total cost roi: Return on investment ZdailyZDailyZweeklyZWeeklyZmonthlyZMonthlyZ quarterlyZ QuarterlyZyearlyZYearlyr4Zperformance_metricsz&Campaign associated with these metricsr1r/Tz0Channel associated with these metrics (optional)r6zDate of metricsr:zType of metric aggregation) max_lengthchoicesr r rzTotal impressionsr@z Total clicksrArBrCrDzAverage completion rate (0-100)rFzClick-through rate percentagerhzCost per mille (CPM) z Total revenuez Total costzReturn on investment percentage)rGrHr r c@sHeZdZdZedZedZgdZej ddgdej ddgdgZ d S) zPerformanceMetric.MetaZanalytics_performance_metricszPerformance MetriczPerformance Metrics)rSrNrO metric_typerOrrQrSNrTrrrrrsrcCs.|jr|jjnd}d|jjd|d|jS)Nz All ChannelszPerformance - r])rNrarSrO)r" channel_namerrrrbszPerformanceMetric.__str__cCs6|jdkrtt|j|jd|_dStd|_dS)z9Calculate and update CTR based on impressions and clicks.rdrCN)impressions_countrstr clicks_countctrr!rrr calculate_ctrs zPerformanceMetric.calculate_ctrcCs<|jdkrtt|j|j|jd|_dStd|_dS)z3Calculate and update ROI based on revenue and cost.rrrCN)costrrrevenueroir!rrr calculate_rois $zPerformanceMetric.calculate_roiN) rrrr&r*Z METRIC_TYPESrrrrsrSrNrurO CharFieldrrwrrrxrrrrrZcpmrrrrrbrrrrrrrVs             rc@s@eZdZdZdedfdedfdedfded fd ed fd ed fgZejdeddZejdeeddZ ej e eddZ ejddeddZ ejdeddZejeejddeddZejejdedd Zejdded!d"Zejded#dZejd$ed%dZGd&d'd'Zd(d)Zed*d+Zd,d-Z d.S)/AnalyticsReporta[ Generated analytics report metadata model. Stores information about generated reports for tracking and caching purposes. Attributes: name: Report name report_type: Type of report parameters: Report parameters (JSON) file_path: Path to generated report file file_size: Size of report file generated_by: User who generated the report generated_at: When report was generated expires_at: When report expires download_count: Number of times downloaded is_public: Whether report is publicly accessible Zcampaign_performancezCampaign PerformanceZchannel_analyticszChannel AnalyticsZimpression_summaryzImpression SummaryZvast_performancezVAST PerformanceZrevenue_reportzRevenue ReportZcustomz Custom Reportz Report name)rr 2zType of report)rrr zReport parameters and filtersr@rTzPath to generated report file)rr8r rzSize of report file in bytesZgenerated_reportszUser who generated the report)r2r7r3r zWhen report was generatedrzWhen report expiresrzNumber of times downloadedFz%Whether report is publicly accessiblec@sHeZdZdZedZedZejdgdejdgdejdgdgZ dS) zAnalyticsReport.MetaZanalytics_reportszAnalytics ReportzAnalytics Reports generated_atrQ report_type generated_byNrrrrrrBs   rcCsd|jd|jS)Nz Report - r])rarr!rrrrbLszAnalyticsReport.__str__cCs|jr t|jkSdS)zCheck if report has expired.FN) expires_atrrr!rrr is_expiredOszAnalyticsReport.is_expiredcCs |jd7_|jdgddS)zIncrement download counter.download_countrN)rr r!rrrincrement_download_countVsz(AnalyticsReport.increment_download_countN)!rrrr&r*Z REPORT_TYPESrrrarrzr{ parameters file_pathrw file_sizerrUserrtrr,rrrrrr-Z is_publicrrbr|rrrrrrrsz          r)r& django.dbrdjango.core.validatorsrrdjango.utils.translationrr* django.utilsrdjango.contrib.authrr(decimalrrModelr r.r}rrrrrrrrs& %    9 yg