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

Reviewed By: satwikareddy3, daegwang

Differential Revision:
D83916694

Privacy Context Container: L1390617

fbshipit-source-id: eb964c937f20e758d9f3c7d0f4a341bef1950882

Author: Ji Li

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## v24.0.0
+
+
+### Added
+- Add AMM fields to attribution data
+
 ## v17.0.0
 
 
@@ -112,4 +118,3 @@ All notable changes to this project will be documented in this file.
 ## v3.3.0
 ### Changed
 - Graph API call upgrade to [v3.3](https://developers.facebook.com/docs/graph-api/changelog/version3.3)
-

src/main/java/com/facebook/ads/sdk/serverside/AttributionData.java

@@ -47,6 +47,15 @@ public class AttributionData {
 
     @SerializedName("attribution_value")
     private Float attributionValue = null;
+
+    @SerializedName("attribution_source")
+    private String attributionSource = null;
+
+    @SerializedName("touchpoint_type")
+    private String touchpointType = null;
+
+    @SerializedName("touchpoint_ts")
+    private Integer touchpointTs = null;
 
     /**
      * Default constructor
@@ -64,10 +73,15 @@ public AttributionData() {
      * @param campaignId Meta-provided campaign id from URL/deeplink
      * @param attributionShare [0-1] weight of credit assigned to the visit
      * @param attributionModel Attribution model used to attribute the event
+     * @param attributionWindow Attribution window in days
      * @param attributionValue The share of value generated by this click-conversion pair that is attributed to Meta.
+     * @param attributionSource 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 touchpointType The engagement type that caused the original credited conversion.
+     * @param touchpointTs The time when the touchpoint event occurred with the ad that the install was credited to.
      */
     public AttributionData(String scope, Long visitTime, String adId, String adsetId, String campaignId, 
-        Float attributionShare, AttributionModelEnum attributionModel, Integer attributionWindow, Float attributionValue) {
+        Float attributionShare, AttributionModelEnum attributionModel, Integer attributionWindow, Float attributionValue,
+        String attributionSource, String touchpointType, Integer touchpointTs) {
       this.scope = scope;
       this.visitTime = visitTime;
       this.adId = adId;
@@ -77,6 +91,9 @@ public AttributionData(String scope, Long visitTime, String adId, String adsetId
       this.attributionModel = attributionModel;
       this.attributionWindow = attributionWindow;
       this.attributionValue = attributionValue;
+      this.attributionSource = attributionSource;
+      this.touchpointType = touchpointType;
+      this.touchpointTs = touchpointTs;
     }
 
     /**
@@ -340,6 +357,93 @@ public void setAttributionValue(Float attributionValue) {
         this.attributionValue = attributionValue;
     }
 
+    /**
+     * Set attributionSource
+     * 
+     * @param attributionSource 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 AttributionData
+     */
+    public AttributionData attributionSource(String attributionSource) {
+      this.attributionSource = attributionSource;
+      return this;
+    }
+
+    /**
+     * Get attributionSource
+     * 
+     * @return attributionSource
+     */
+    public String getAttributionSource() {
+      return attributionSource;
+    }
+
+    /**
+     * Set attributionSource
+     * 
+     * @param attributionSource The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.
+     */
+    public void setAttributionSource(String attributionSource) {
+      this.attributionSource = attributionSource;
+    }
+
+    /**
+     * Set touchpointType
+     * 
+     * @param touchpointType The engagement type that caused the original credited conversion.
+     * @return AttributionData
+     */
+    public AttributionData touchpointType(String touchpointType) {
+      this.touchpointType = touchpointType;
+      return this;
+    }
+
+    /**
+     * Get touchpointType
+     * 
+     * @return touchpointType
+     */
+    public String getTouchpointType() {
+      return touchpointType;
+    }
+
+    /**
+     * Set touchpointType
+     * 
+     * @param touchpointType The engagement type that caused the original credited conversion.
+     */
+    public void setTouchpointType(String touchpointType) {
+      this.touchpointType = touchpointType;
+    }
+
+    /**
+     * Set touchpointTs
+     * 
+     * @param touchpointTs The time when the touchpoint event occurred with the ad that the install was credited to.
+     * @return AttributionData
+     */
+    public AttributionData touchpointTs(Integer touchpointTs) {
+      this.touchpointTs = touchpointTs;
+      return this;
+    }
+
+    /**
+     * Get touchpointTs
+     * 
+     * @return touchpointTs
+     */
+    public Integer getTouchpointTs() {
+      return touchpointTs;
+    }
+
+    /**
+     * Set touchpointTs
+     * 
+     * @param touchpointTs The time when the touchpoint event occurred with the ad that the install was credited to.
+     */
+    public void setTouchpointTs(Integer touchpointTs) {
+      this.touchpointTs = touchpointTs;
+    }
+
     @Override
     public boolean equals(Object o) {
       if (this == o) return true;
@@ -355,12 +459,15 @@ public boolean equals(Object o) {
         && Objects.equals(this.attributionShare, attributionData.attributionShare)
         && Objects.equals(this.attributionModel, attributionData.attributionModel)
         && Objects.equals(this.attributionWindow, attributionData.attributionWindow)
-        && Objects.equals(this.attributionValue, attributionData.attributionValue);
+        && Objects.equals(this.attributionValue, attributionData.attributionValue)
+        && Objects.equals(this.attributionSource, attributionData.attributionSource)
+        && Objects.equals(this.touchpointType, attributionData.touchpointType)
+        && Objects.equals(this.touchpointTs, attributionData.touchpointTs);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hash(scope, visitTime, adId, adsetId, campaignId, attributionShare, attributionModel, attributionWindow, attributionValue);
+      return Objects.hash(scope, visitTime, adId, adsetId, campaignId, attributionShare, attributionModel, attributionWindow, attributionValue, attributionSource, touchpointType, touchpointTs);
     }
 
     @Override
@@ -376,6 +483,9 @@ public String toString() {
       sb.append("    attributionModel: ").append(toIndentedString(attributionModel)).append("\n");
       sb.append("    attributionWindow: ").append(toIndentedString(attributionWindow)).append("\n");
       sb.append("    attributionValue: ").append(toIndentedString(attributionValue)).append("\n");
+      sb.append("    attributionSource: ").append(toIndentedString(attributionSource)).append("\n");
+      sb.append("    touchpointType: ").append(toIndentedString(touchpointType)).append("\n");
+      sb.append("    touchpointTs: ").append(toIndentedString(touchpointTs)).append("\n");
       sb.append("}");
       return sb.toString();
     }

src/test/java/com/facebook/ads/sdk/serverside/AttributionDataTest.java

@@ -35,6 +35,9 @@ public void TestAttributionDataBuilderAndGetters() {
         float attributionShare = 0.5f;
         float attributionValue = 0.3f;
         AttributionModelEnum attributionModel = AttributionModelEnum.LAST_CLICK;
+        String attributionSource = "amm";
+        String touchpointType = "onsite_click";
+        int touchpointTs = 123;
 
         attributionData
                      .scope(scope)
@@ -45,7 +48,10 @@ public void TestAttributionDataBuilderAndGetters() {
                      .attributionWindow(attributionWindow)
                      .attributionShare(attributionShare)
                      .attributionModel(attributionModel)
-                     .attributionValue(attributionValue);
+                     .attributionValue(attributionValue)
+                     .attributionSource(attributionSource)
+                     .touchpointType(touchpointType)
+                     .touchpointTs(touchpointTs);
 
         assertEquals(attributionData.getScope(), scope);
         assertEquals(attributionData.getAdId(), adId);
@@ -56,6 +62,9 @@ public void TestAttributionDataBuilderAndGetters() {
         assertEquals((long) attributionData.getVisitTime(), visitTime);
         assertEquals(attributionData.getAttributionModel(), attributionModel);
         assertEquals((float)attributionData.getAttributionValue(), attributionValue, 0);
+        assertEquals(attributionData.getAttributionSource(), attributionSource);
+        assertEquals(attributionData.getTouchpointType(), touchpointType);
+        assertEquals((int)attributionData.getTouchpointTs(), touchpointTs);
     }
 
     @Test
@@ -71,6 +80,9 @@ public void TestWhenInstancesAreEqual() {
         float attributionShare = 0.5f;
         float attributionValue = 0.3f;
         AttributionModelEnum attributionModel = AttributionModelEnum.LAST_CLICK;
+        String attributionSource = "amm";
+        String touchpointType = "onsite_click";
+        int touchpointTs = 123;
 
         attributionData1
                      .scope(scope)
@@ -81,7 +93,10 @@ public void TestWhenInstancesAreEqual() {
                      .attributionWindow(attributionWindow)
                      .attributionShare(attributionShare)
                      .attributionModel(attributionModel)
-                     .attributionValue(attributionValue);
+                     .attributionValue(attributionValue)
+                     .attributionSource(attributionSource)
+                     .touchpointType(touchpointType)
+                     .touchpointTs(touchpointTs);
 
         attributionData2
                      .scope(scope)
@@ -92,7 +107,10 @@ public void TestWhenInstancesAreEqual() {
                      .attributionWindow(attributionWindow)
                      .attributionShare(attributionShare)
                      .attributionModel(attributionModel)
-                     .attributionValue(attributionValue);
+                     .attributionValue(attributionValue)
+                     .attributionSource(attributionSource)
+                     .touchpointType(touchpointType)
+                     .touchpointTs(touchpointTs);
 
         assertEquals(attributionData1, attributionData2);
         assertEquals(attributionData1.hashCode(), attributionData2.hashCode());
@@ -110,6 +128,9 @@ public void TestWhenInstancesAreNotEqual() {
         float attributionShare = 0.5f;
         float attributionValue = 0.3f;
         AttributionModelEnum attributionModel = AttributionModelEnum.LAST_CLICK;
+        String attributionSource = "amm";
+        String touchpointType = "onsite_click";
+        int touchpointTs = 123;
 
         // set different attribution windown to test
         attributionData1
@@ -121,7 +142,10 @@ public void TestWhenInstancesAreNotEqual() {
                      .attributionWindow(28)
                      .attributionShare(attributionShare)
                      .attributionModel(attributionModel)
-                     .attributionValue(attributionValue);
+                     .attributionValue(attributionValue)
+                     .attributionSource(attributionSource)
+                     .touchpointType(touchpointType)
+                     .touchpointTs(touchpointTs);
 
         attributionData2
                      .scope(scope)
@@ -132,7 +156,10 @@ public void TestWhenInstancesAreNotEqual() {
                      .attributionWindow(7)
                      .attributionShare(attributionShare)
                      .attributionModel(attributionModel)
-                     .attributionValue(attributionValue);
+                     .attributionValue(attributionValue)
+                     .attributionSource(attributionSource)
+                     .touchpointType(touchpointType)
+                     .touchpointTs(touchpointTs);
 
         assertNotEquals(attributionData1, attributionData2);
         assertNotEquals(attributionData1.hashCode(), attributionData2.hashCode());