From 0821b16eb84cede7cea4e1aee0bb3bdda2e60088 Mon Sep 17 00:00:00 2001
From: David Fischer <david@readthedocs.org>
Date: Mon, 19 Feb 2024 16:35:36 -0800
Subject: [PATCH] Add publisher eCPM to report table

---
 adserver/reports.py                                        | 6 ++++++
 .../adserver/reports/includes/publisher-report-table.html  | 7 +++++--
 adserver/tests/test_reports.py                             | 4 ++--
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/adserver/reports.py b/adserver/reports.py
index f5d19991..35ff0a25 100644
--- a/adserver/reports.py
+++ b/adserver/reports.py
@@ -264,6 +264,9 @@ def generate(self):
             results[index]["revenue_share"] = results[index]["revenue"] * (
                 applied_rev_share / 100.0
             )
+            results[index]["revenue_share_ecpm"] = calculate_ecpm(
+                results[index]["revenue_share"], results[index]["views"]
+            )
             results[index]["our_revenue"] = (
                 results[index]["revenue"] - results[index]["revenue_share"]
             )
@@ -301,6 +304,9 @@ def calculate_totals(self):
         self.total["revenue_share"] = sum(
             result["revenue_share"] for result in self.results
         )
+        self.total["revenue_share_ecpm"] = calculate_ecpm(
+            self.total["revenue_share"], self.total["views"]
+        )
         self.total["our_revenue"] = self.total["revenue"] - self.total["revenue_share"]
         self.total["ctr"] = calculate_ctr(self.total["clicks"], self.total["views"])
         self.total["ecpm"] = calculate_ecpm(self.total["revenue"], self.total["views"])
diff --git a/adserver/templates/adserver/reports/includes/publisher-report-table.html b/adserver/templates/adserver/reports/includes/publisher-report-table.html
index 07657074..e4785164 100644
--- a/adserver/templates/adserver/reports/includes/publisher-report-table.html
+++ b/adserver/templates/adserver/reports/includes/publisher-report-table.html
@@ -10,9 +10,10 @@
       <th class="text-right"><strong>{% blocktrans %}<abbr title="Click through rate">CTR</abbr>{% endblocktrans %}</strong></th>
       <th class="text-right"><strong>{% blocktrans %}<abbr title="% of traffic that viewed the ad">View Rate</abbr>{% endblocktrans %}</strong></th>
       {% if publisher.saas %}
-      <th class="text-right"><strong>{% blocktrans %}<abbr title="Billable API requests">API Requests</abbr>{% endblocktrans %}</strong></th>
+        <th class="text-right"><strong>{% blocktrans %}<abbr title="Billable API requests">API Requests</abbr>{% endblocktrans %}</strong></th>
       {% else %}
-      <th class="text-right"><strong>{% trans 'Revenue' %}</strong></th>
+        <th class="text-right"><strong>{% blocktrans %}<abbr title="Effective publisher revenue per thousand impressions">eCPM</abbr>{% endblocktrans %}</strong></th>
+        <th class="text-right"><strong>{% trans 'Revenue' %}</strong></th>
       {% endif %}
       {% if "adserver.staff_publisher_fields" in perms %}
         <th class="text-right staff-only"><strong>{% trans 'Our&nbsp;Rev' %}</strong></th>
@@ -34,6 +35,7 @@
         {% if publisher.saas %}
           <td class="text-right">{{ result.decisions|intcomma }}</td>
         {% else %}
+          <td class="text-right">${{ result.revenue_share_ecpm|floatformat:2|intcomma }}</td>
           <td class="text-right">${{ result.revenue_share|floatformat:2|intcomma }}</td>
         {% endif %}
         {% if "adserver.staff_publisher_fields" in perms %}
@@ -54,6 +56,7 @@
       {% if publisher.saas %}
         <td class="text-right"><strong>{{ report.total.decisions|intcomma }}</strong></td>
       {% else %}
+        <td class="text-right"><strong>${{ report.total.revenue_share_ecpm|floatformat:2|intcomma }}</strong></td>
         <td class="text-right"><strong>${{ report.total.revenue_share|floatformat:2|intcomma }}</strong></td>
       {% endif %}
       {% if "adserver.staff_publisher_fields" in perms %}
diff --git a/adserver/tests/test_reports.py b/adserver/tests/test_reports.py
index cb427eeb..fad93de4 100644
--- a/adserver/tests/test_reports.py
+++ b/adserver/tests/test_reports.py
@@ -557,7 +557,7 @@ def test_publisher_report_contents(self):
         self.assertContains(response, "CSV Export")
 
         # Check staff fields not present since the permission wasn't configured
-        self.assertNotContains(response, "eCPM")
+        self.assertNotContains(response, "Fill Rate")
 
         # Add the permission
         self.staff_user.user_permissions.add(
@@ -567,7 +567,7 @@ def test_publisher_report_contents(self):
             )
         )
         response = self.client.get(url)
-        self.assertContains(response, "eCPM")
+        self.assertContains(response, "Fill Rate")
 
     def test_publisher_placement_report_contents(self):
         self.client.force_login(self.staff_user)