update attribution_data, custom_data and original_event_data fields

Summary:
Update attribution_data, custom_data and original_event_data:
1. add attribution_value to attribution_data
2. add net_revenue to custom_data
3. add order_id & event_id to original_event_data

Reviewed By: kanakb, liliarizona

Differential Revision: D72841933

fbshipit-source-id: 0279a0bc3721aa69e07a503dba22fd45c97a4019

Author: shuaiwa-meta

facebook_business/adobjects/serverside/attribution_data.py

@@ -33,10 +33,11 @@ class AttributionData(object):
         'attribution_share': 'float',
         'attribution_model': 'AttributionModel',
         'attr_window': 'int',
+        'attribution_value': 'float',
     }
 
-    def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = None, campaign_id = None, attribution_share = None, attribution_model = None, attr_window = None):
-        # type: (str, int) -> None
+    def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = None, campaign_id = None, attribution_share = None, attribution_model = None, attr_window = None, attribution_value = None):
+        # type: (str, int, str, str, str, float, AttributionModel, int, float) -> None
 
         """Conversions API Attribution Data"""
         self._scope = None
@@ -47,6 +48,7 @@ def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = Non
         self._attribution_share = None
         self._attribution_model = None
         self._attr_window = None
+        self._attribution_value = None
 
         if scope is not None:
             self.scope = scope
@@ -64,6 +66,8 @@ def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = Non
             self.attribution_model = attribution_model
         if attr_window is not None:
             self.attr_window = attr_window
+        if attribution_value is not None:
+            self.attribution_value = attribution_value
 
     @property
     def scope(self):
@@ -244,6 +248,28 @@ def attr_window(self, attr_window):
         """
         self._attr_window = attr_window
 
+    @property
+    def attribution_value(self):
+        """Gets the attribution_value of Attribution Data.
+
+        The share of value generated by this click-conversion pair that is attributed to Meta.
+
+        :return: The attribution_value of Attribution Data.
+        :rtype: float
+        """
+        return self._attribution_value
+
+    @attribution_value.setter
+    def attribution_value(self, attribution_value):
+        """Sets the attribution_value of Attribution Data.
+
+        The share of value generated by this click-conversion pair that is attributed to Meta.
+
+        :param attribution_value: The attribution_value of Attribution Data.
+        :type: float
+        """
+        self._attribution_value = attribution_value
+
 
     def normalize(self):
         normalized_payload = {
@@ -255,6 +281,7 @@ def normalize(self):
             'attribution_share': self.attribution_share,
             'attribution_model': self.attribution_model,
             'attr_window': self.attr_window,
+            'attribution_value': self.attribution_value,
         }
         normalized_payload = {k: v for k, v in normalized_payload.items() if v is not None}
         return normalized_payload

facebook_business/adobjects/serverside/custom_data.py

@@ -31,6 +31,7 @@ class CustomData(object):
     """
     param_types = {
         'value': 'float',
+        'net_revenue': 'float',
         'currency': 'str',
         'content_name': 'str',
         'content_category': 'str',
@@ -50,6 +51,7 @@ class CustomData(object):
     def __init__(
         self,
         value=None,
+        net_revenue=None,
         currency=None,
         content_name=None,
         content_category=None,
@@ -65,9 +67,10 @@ def __init__(
         item_number=None,
         custom_properties={},
     ):
-        # type: (float, str, str, str, List[str], List[Content], str, str, float, int, str, str, DeliveryCategory ,str, dict) -> None
+        # type: (float, float, str, str, str, list[str], list[Content], str, str, float, int, str, str, DeliveryCategory ,str, dict) -> None
 
         self._value = None
+        self._net_revenue = None
         self._currency = None
         self._content_name = None
         self._content_category = None
@@ -84,6 +87,8 @@ def __init__(
         self._custom_properties = None
         if value is not None:
             self.value = value
+        if net_revenue is not None:
+            self.net_revenue = net_revenue
         if currency is not None:
             self.currency = currency
         if content_name is not None:
@@ -137,6 +142,30 @@ def value(self, value):
             raise TypeError('CustomData.value must be a float or int. TypeError on value: %s' % value)
         self._value = value
 
+    @property
+    def net_revenue(self):
+        """Gets the net_revenue.
+
+        A numeric net revenue associated with this event.
+
+        :return: The net_revenue.
+        :rtype: float or int
+        """
+        return self._net_revenue
+
+    @net_revenue.setter
+    def net_revenue(self, net_revenue):
+        """Sets the net_revenue.
+
+        A numeric net revenue associated with this event.
+
+        :param net_revenue: The net_revenue.
+        :type: float or int
+        """
+        if not isinstance(net_revenue, (float, int)):
+            raise TypeError('CustomData.net_revenue must be a float or int. TypeError on value: %s' % net_revenue)
+        self._net_revenue = net_revenue
+
     @property
     def currency(self):
         """Gets the currency.
@@ -475,6 +504,7 @@ def add_custom_property(self, key, value):
     def normalize(self):
         normalized_payload = {
             'value': self.value,
+            'net_revenue': self.net_revenue,
             'currency': Normalize.normalize_field_skip_hashing('currency', self.currency),
             'content_name': self.content_name,
             'content_category': self.content_category,

facebook_business/adobjects/serverside/original_event_data.py

@@ -26,19 +26,27 @@ class OriginalEventData(object):
     param_types = {
         'event_name': 'str',
         'event_time': 'int',
+        'order_id': 'str',
+        'event_id': 'str'
     }
 
-    def __init__(self, event_name = None, event_time = None):
-        # type: (str, int) -> None
+    def __init__(self, event_name = None, event_time = None, order_id = None, event_id = None):
+        # type: (str, int, str, str) -> None
 
         """Conversions API Original Event Data"""
         self._event_name = None
         self._event_time = None
+        self._order_id = None
+        self._event_id = None
 
         if event_name is not None:
             self.event_name = event_name
         if event_time is not None:
             self.event_time = event_time
+        if order_id is not None:
+            self.order_id = order_id
+        if event_id is not None:
+            self.event_id = event_id
 
     @property
     def event_name(self):
@@ -88,8 +96,59 @@ def event_time(self, event_time):
 
         self._event_time = event_time
 
+    @property
+    def order_id(self):
+        """Gets the order_id of original Event.
+
+        The order ID for this transaction as a string.
+
+        :return: The order_id of original Event.
+        :rtype: str
+        """
+        return self._order_id
+
+    @order_id.setter
+    def order_id(self, order_id):
+        """Sets the order_id of original Event.
+
+        The order ID for this transaction as a string.
+
+        :param order_id: The order_id of original Event.
+        :type: str
+        :return self
+        """
+        self._order_id = order_id
+
+    @property
+    def event_id(self):
+        """Gets the event_id of original Event.
+
+        A unique string chosen by the advertiser.
+
+        :return: The event_id of original Event.
+        :rtype: str
+        """
+        return self._event_id
+
+    @event_id.setter
+    def event_id(self, event_id):
+        """Sets the event_id of original Event.
+
+        A unique string chosen by the advertiser.
+
+        :param event_id: The event_id of original Event.
+        :type: str
+        :return self
+        """
+        self._event_id = event_id
+
     def normalize(self):
-        normalized_payload = {'event_name': self.event_name, 'event_time': self.event_time }
+        normalized_payload = {
+            'event_name': self.event_name,
+            'event_time': self.event_time,
+            'order_id': self.order_id,
+            'event_id': self.event_id,
+        }
         normalized_payload = {k: v for k, v in normalized_payload.items() if v is not None}
         return normalized_payload
 

facebook_business/adobjects/serverside/tests/attribution_data_test.py

@@ -21,19 +21,21 @@
 from unittest import TestCase
 
 from facebook_business.adobjects.serverside.attribution_data import AttributionData
+from facebook_business.adobjects.serverside.attribution_model import AttributionModel
 
 
 class AttributionDataTest(TestCase):
     def test_normalize(self):
         expected = {
-            scope: 'click',
-            visit_time: 12345,
-            ad_id: '123',
-            adset_id: '234',
-            campaign_id: '456',
-            attr_window: 7,
-            attribution_share: 0.5,
-            attribution_model: 'last_click',
+            'scope': 'click',
+            'visit_time': 12345,
+            'ad_id': '123',
+            'adset_id': '234',
+            'campaign_id': '456',
+            'attr_window': 7,
+            'attribution_share': 0.5,
+            'attribution_model': AttributionModel.LAST_CLICK,
+            'attribution_value': 10.5,
         }
         attribution_data = AttributionData(
             scope=expected['scope'],
@@ -44,6 +46,7 @@ def test_normalize(self):
             attr_window=expected['attr_window'],
             attribution_share=expected['attribution_share'],
             attribution_model=expected['attribution_model'],
+            attribution_value=expected['attribution_value'],
         )
 
         self.assertEqual(attribution_data.normalize(), expected)

facebook_business/adobjects/serverside/tests/custom_data_test.py

@@ -33,6 +33,7 @@ def test_normalize(self):
 
         expected = {
             'value': 0.5,
+            'net_revenue': 0.23,
             'currency': 'usd',
             'content_name': 'content-content1',
             'content_category': 'content-category2',
@@ -57,6 +58,7 @@ def test_normalize(self):
         }
         custom_data = CustomData(
             value=expected['value'],
+            net_revenue=expected['net_revenue'],
             currency=expected['currency'],
             content_name=expected['content_name'],
             content_category=expected['content_category'],

facebook_business/adobjects/serverside/tests/original_event_data_test.py

@@ -28,10 +28,14 @@ def test_normalize(self):
         expected = {
             'event_name': 'event-name-1',
             'event_time': 123456,
+            'order_id': 'order-id-1',
+            'event_id': 'event-id-1',
         }
         original_event_data = OriginalEventData(
             event_name=expected['event_name'],
             event_time=expected['event_time'],
+            order_id=expected['order_id'],
+            event_id=expected['event_id'],
         )
 
         self.assertEqual(original_event_data.normalize(), expected)