add new AMM fields to attribution_data

Summary:
Update business SDK to include new AMM fields in attribution data:
- attribution_source: The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources
- touchpoint_type: The engagement type that caused the original credited conversion
- touchpoint_ts: The time when the touchpoint event occurred with the ad that the install was credited to

Added full implementation including:
- param_types definitions
- __init__ method parameters
- complete getter/setter properties
- normalize() method updates
- comprehensive documentation
- updated test coverage

Reviewed By: wenhaizhu, satwikareddy3

Differential Revision:
D83868650

Privacy Context Container: L1390617

fbshipit-source-id: d390862a0f62508869771befd882db7b2bac9a7d

Author: Ji Li

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## v24.0.0
+
+
+### Added
+- Add AMM fields to attribution data
+
 ## v23.0.0
 
 
@@ -136,4 +142,3 @@ All notable changes to this project will be documented in this file.
 ### Deprecated
 - `parent_id` in `AbstractCrudObject`.
 - Function `remote_create`, `remote_read`, `remote_update` and `remote_delete` for `AbstractCrudObject`. Check out our [recommended way](https://github.com/facebook/facebook-python-business-sdk#exploring-the-graph) to make API call with python SDK.
-

facebook_business/adobjects/serverside/attribution_data.py

@@ -34,9 +34,12 @@ class AttributionData(object):
         'attribution_model': 'AttributionModel',
         'attr_window': 'int',
         'attribution_value': 'float',
+        'attribution_source': 'str', 
+        'touchpoint_type': 'str', 
+        'touchpoint_ts': 'int',
     }
 
-    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):
+    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, attribution_source = None, touchpoint_type = None, touchpoint_ts = None):
         # type: (str, int, str, str, str, float, AttributionModel, int, float) -> None
 
         """Conversions API Attribution Data"""
@@ -49,6 +52,9 @@ def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = Non
         self._attribution_model = None
         self._attr_window = None
         self._attribution_value = None
+        self._attribution_source = None
+        self._touchpoint_type = None
+        self._touchpoint_ts = None
 
         if scope is not None:
             self.scope = scope
@@ -68,6 +74,12 @@ def __init__(self, scope = None, visit_time = None, ad_id = None, adset_id = Non
             self.attr_window = attr_window
         if attribution_value is not None:
             self.attribution_value = attribution_value
+        if attribution_source is not None:
+            self.attribution_source = attribution_source
+        if touchpoint_type is not None:
+            self.touchpoint_type = touchpoint_type
+        if touchpoint_ts is not None:
+            self.touchpoint_ts = touchpoint_ts
 
     @property
     def scope(self):
@@ -270,6 +282,72 @@ def attribution_value(self, attribution_value):
         """
         self._attribution_value = attribution_value
 
+    @property
+    def attribution_source(self):
+        """Gets the attribution_source of Attribution Data.
+
+        The attribution source To differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.
+
+        :return: The attribution_source of Attribution Data.
+        :rtype: float
+        """
+        return self._attribution_source
+
+    @attribution_source.setter
+    def attribution_source(self, attribution_source):
+        """Sets the attribution_source of Attribution Data.
+
+        The attribution source To differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.
+
+        :param attribution_source: The attribution_source of Attribution Data.
+        :type: float
+        """
+        self._attribution_source = attribution_source
+
+    @property
+    def touchpoint_type(self):
+        """Gets the touchpoint_type of Attribution Data.
+
+        The engagement type that caused the original credited conversion.
+
+        :return: The touchpoint_type of Attribution Data.
+        :rtype: float
+        """
+        return self._touchpoint_type
+
+    @touchpoint_type.setter
+    def touchpoint_type(self, touchpoint_type):
+        """Sets the touchpoint_type of Attribution Data.
+
+        The engagement type that caused the original credited conversion.
+
+        :param touchpoint_type: The touchpoint_type of Attribution Data.
+        :type: float
+        """
+        self._touchpoint_type = touchpoint_type
+
+    @property
+    def touchpoint_ts(self):
+        """Gets the touchpoint_ts of Attribution Data.
+
+        The time when the touchpoint event occurred with the ad that the install was credited to.
+
+        :return: The touchpoint_ts of Attribution Data.
+        :rtype: float
+        """
+        return self._touchpoint_ts
+
+    @touchpoint_ts.setter
+    def touchpoint_ts(self, touchpoint_ts):
+        """Sets the touchpoint_ts of Attribution Data.
+
+        The time when the touchpoint event occurred with the ad that the install was credited to.
+
+        :param touchpoint_ts: The touchpoint_ts of Attribution Data.
+        :type: float
+        """
+        self._touchpoint_ts = touchpoint_ts
+
 
     def normalize(self):
         normalized_payload = {
@@ -282,6 +360,9 @@ def normalize(self):
             'attribution_model': self.attribution_model,
             'attr_window': self.attr_window,
             'attribution_value': self.attribution_value,
+            'attribution_source': self.attribution_source,
+            'touchpoint_type': self.touchpoint_type,
+            'touchpoint_ts': self.touchpoint_ts,
         }
         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

@@ -36,6 +36,9 @@ def test_normalize(self):
             'attribution_share': 0.5,
             'attribution_model': AttributionModel.LAST_CLICK,
             'attribution_value': 10.5,
+            'attribution_source': 'amm',
+            'touchpoint_type': 'onsite_click',
+            'touchpoint_ts': 12345,
         }
         attribution_data = AttributionData(
             scope=expected['scope'],
@@ -47,6 +50,9 @@ def test_normalize(self):
             attribution_share=expected['attribution_share'],
             attribution_model=expected['attribution_model'],
             attribution_value=expected['attribution_value'],
+            attribution_source=expected['attribution_source'],
+            touchpoint_type=expected['touchpoint_type'],
+            touchpoint_ts=expected['touchpoint_ts'],
         )
 
         self.assertEqual(attribution_data.normalize(), expected)