add new AMM fields to attribution_data

Summary:
Update business SDK to include new AMM fields in attribution data:
attribution_source
-touchpoint_type
-touchpoint_ts

Updated CHANGELOG.md to document the changes in v22.0.4.

Reviewed By: daegwang, satwikareddy3

Differential Revision:
D83920663

Privacy Context Container: L1390617

fbshipit-source-id: bd6d6c06371d1b5a548cf510d5991d67c310c736

Author: Ji Li

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## v24.0.0
+### Changed
+- Add AMM fields to attribution data
+
 ## v22.0.3
 ### Changed
 - Fix the OriginalEventData class to add the missing methods
@@ -161,4 +165,3 @@ All notable changes to this project will be documented in this file.
     $async_job = $async_job->getSelf();
   }
   ```
-

src/FacebookAds/Object/ServerSide/AttributionData.php

@@ -43,6 +43,9 @@ class AttributionData implements ArrayAccess {
   private $attribution_model;
   private $attr_window;
   private $attribution_value;
+  private $attribution_source;
+  private $touchpoint_type;
+  private $touchpoint_ts;
 
   protected static $param_types = array(
     'scope' => 'string',
@@ -54,6 +57,9 @@ class AttributionData implements ArrayAccess {
     'attribution_model' => 'FacebookAds\Object\ServerSide\AttributionModel',
     'attr_window' => 'int',
     'attribution_value' => 'float',
+    'attribution_source' => 'string',
+    'touchpoint_type' => 'string',
+    'touchpoint_ts' => 'int',
   );
 
   protected static $attributeMap = array(
@@ -66,6 +72,9 @@ class AttributionData implements ArrayAccess {
     'attribution_model' => 'attribution_model',
     'attr_window' => 'attr_window',
     'attribution_value' => 'attribution_value',
+    'attribution_source' => 'attribution_source',
+    'touchpoint_type' => 'touchpoint_type',
+    'touchpoint_ts' => 'touchpoint_ts',
   );
 
   protected static $setters = array(
@@ -78,6 +87,9 @@ class AttributionData implements ArrayAccess {
     'attribution_model' => 'setAttributionModel',
     'attr_window' => 'setAttrWindow',
     'attribution_value' => 'setAttributionValue',
+    'attribution_source' => 'setAttributionSource',
+    'touchpoint_type' => 'setTouchpointType',
+    'touchpoint_ts' => 'setTouchpointTs',
   );
 
   protected static $getters = array(
@@ -90,6 +102,9 @@ class AttributionData implements ArrayAccess {
     'attribution_model' => 'getAttributionModel',
     'attr_window' => 'getAttrWindow',
     'attribution_value' => 'getAttributionValue',
+    'attribution_source' => 'getAttributionSource',
+    'touchpoint_type' => 'getTouchpointType',
+    'touchpoint_ts' => 'getTouchpointTs',
   );
 
   protected $container = array();
@@ -104,6 +119,9 @@ public function __construct(?array $data = null) {
     $this->container['attribution_model'] = isset($data['attribution_model']) ? $data['attribution_model'] : null;
     $this->container['attr_window'] = isset($data['attr_window']) ? $data['attr_window'] : null;
     $this->container['attribution_value'] = isset($data['attribution_value']) ? $data['attribution_value'] : null;
+    $this->container['attribution_source'] = isset($data['attribution_source']) ? $data['attribution_source'] : null;
+    $this->container['touchpoint_type'] = isset($data['touchpoint_type']) ? $data['touchpoint_type'] : null;
+    $this->container['touchpoint_ts'] = isset($data['touchpoint_ts']) ? $data['touchpoint_ts'] : null;
   }
 
   public static function paramTypes() {
@@ -230,6 +248,39 @@ public function setAttributionValue($attribution_value) {
     return $this;
   }
 
+  /**
+   * Sets attribution_source
+   * @param string $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.
+   * @return $this
+   */
+  public function setAttributionSource($attribution_source) {
+    $this->container['attribution_source'] = $attribution_source;
+
+    return $this;
+  }
+
+  /**
+   * Sets touchpoint_type
+   * @param string $touchpoint_type The engagement type that caused the original credited conversion.
+   * @return $this
+   */
+  public function setTouchpointType($touchpoint_type) {
+    $this->container['touchpoint_type'] = $touchpoint_type;
+
+    return $this;
+  }
+
+  /**
+   * Sets touchpoint_ts
+   * @param int $touchpoint_ts The time when the touchpoint event occurred with the ad that the install was credited to.
+   * @return $this
+   */
+  public function setTouchpointTs($touchpoint_ts) {
+    $this->container['touchpoint_ts'] = $touchpoint_ts;
+
+    return $this;
+  }
+
   /**
    * Gets touchpoint type.
    * @return string
@@ -302,6 +353,30 @@ public function getAttributionValue() {
     return $this->container['attribution_value'];
   }
 
+  /**
+   * Gets attribution source.
+   * @return string
+   */
+  public function getAttributionSource() {
+    return $this->container['attribution_source'];
+  }
+
+  /**
+   * Gets touchpoint type.
+   * @return string
+   */
+  public function getTouchpointType() {
+    return $this->container['touchpoint_type'];
+  }
+
+  /**
+   * Gets touchpoint timestamp.
+   * @return int
+   */
+  public function getTouchpointTs() {
+    return $this->container['touchpoint_ts'];
+  }
+
   /**
    * Returns true if offset exists. False otherwise.
    * @param integer $offset Offset
@@ -355,6 +430,9 @@ public function normalize() {
     $normalized_payload['attribution_model'] = $this->getAttributionModel();
     $normalized_payload['attr_window'] = $this->getAttrWindow();
     $normalized_payload['attribution_value'] = $this->getAttributionValue();
+    $normalized_payload['attribution_source'] = $this->getAttributionSource();
+    $normalized_payload['touchpoint_type'] = $this->getTouchpointType();
+    $normalized_payload['touchpoint_ts'] = $this->getTouchpointTs();
     return $normalized_payload;
   }
 

test/FacebookAdsTest/Object/ServerSide/AttributionDataTest.php

@@ -37,8 +37,11 @@ public function testBuilderAndConstructor() {
       'campaign_id' => '345',
       'attr_window' => 7,
       'attribution_share' => 0.5,
-      'attribution_model' => 'last_touch'
-      'attribution_value' => 3.45
+      'attribution_model' => 'last_touch',
+      'attribution_value' => 3.45,
+      'attribution_source' => 'AMM',
+      'touchpoint_type' => 'click',
+      'touchpoint_ts' => 1234567890
     );
     $builder = (new AttributionData())
       ->setScope($expected['scope'])
@@ -49,7 +52,10 @@ public function testBuilderAndConstructor() {
       ->setAttrWindow($expected['attr_window'])
       ->setAttributionShare($expected['attribution_share'])
       ->setAttributionModel($expected['attribution_model'])
-      ->setAttributionValue($expected['attribution_value']);
+      ->setAttributionValue($expected['attribution_value'])
+      ->setAttributionSource($expected['attribution_source'])
+      ->setTouchpointType($expected['touchpoint_type'])
+      ->setTouchpointTs($expected['touchpoint_ts']);
     $this->assertEquals($expected, $builder->normalize());
 
     $constructor = new AttributionData(array(
@@ -61,7 +67,10 @@ public function testBuilderAndConstructor() {
       'attr_window' => $expected['attr_window'],
       'attribution_share' => $expected['attribution_share'],
       'attribution_model' => $expected['attribution_model'],
-      'attribution_value' => $expected['attribution_value']
+      'attribution_value' => $expected['attribution_value'],
+      'attribution_source' => $expected['attribution_source'],
+      'touchpoint_type' => $expected['touchpoint_type'],
+      'touchpoint_ts' => $expected['touchpoint_ts']
     ));
     $this->assertEquals($expected, $constructor->normalize());
   }