Add touchpoint_id to AttributionData

Summary:
# Problem

AttributionData in the Java Business SDK does not include the touchpoint_id field, which is needed for advertisers to pass back the opaque TouchpointID received from Meta via CAPI AppendAttribution events.

# Solution

Add touchpoint_id as a string field to AttributionData with getter/setter/fluent builder, equals/hashCode/toString support, and test coverage.

Reviewed By: HeyMultiverse

Differential Revision: D96984230

fbshipit-source-id: 632ffeacb9ea1659c3a5aedc414ddcbb6b757258

Author: Dan Cromer

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## v24.0.2
+### Added
+- Add touchpoint_id field to AttributionData
+
 ## v24.0.1
 ### Added
 - Add additional AMM fields: attribution_method, decline_reason, auditing_token, linkage_key

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

@@ -69,6 +69,9 @@ public class AttributionData {
     @SerializedName("linkage_key")
     private String linkageKey = null;
 
+    @SerializedName("touchpoint_id")
+    private String touchpointId = null;
+
     @SerializedName("attribution_setting")
     private AttributionSetting attributionSetting = null;
 
@@ -97,12 +100,13 @@ public AttributionData() {
      * @param declineReason The decline reason for the attribution.
      * @param auditingToken The auditing token for the attribution.
      * @param linkageKey The linkage key for the attribution.
+     * @param touchpointId Unique identifier for touchpoint events shared by Meta with advertisers.
      * @param attributionSetting The attribution setting with inactivity and reattribution window configuration.
      */
-    public AttributionData(String scope, Long visitTime, String adId, String adsetId, String campaignId, 
+    public AttributionData(String scope, Long visitTime, String adId, String adsetId, String campaignId,
         Float attributionShare, AttributionModelEnum attributionModel, Integer attributionWindow, Float attributionValue,
         String attributionSource, String touchpointType, Integer touchpointTs, AttributionMethodEnum attributionMethod,
-        DeclineReasonEnum declineReason, String auditingToken, String linkageKey, AttributionSetting attributionSetting) {
+        DeclineReasonEnum declineReason, String auditingToken, String linkageKey, String touchpointId, AttributionSetting attributionSetting) {
       this.scope = scope;
       this.visitTime = visitTime;
       this.adId = adId;
@@ -119,6 +123,7 @@ public AttributionData(String scope, Long visitTime, String adId, String adsetId
       this.declineReason = declineReason;
       this.auditingToken = auditingToken;
       this.linkageKey = linkageKey;
+      this.touchpointId = touchpointId;
       this.attributionSetting = attributionSetting;
     }
 
@@ -586,9 +591,38 @@ public void setLinkageKey(String linkageKey) {
       this.linkageKey = linkageKey;
     }
 
+    /**
+     * Set touchpointId
+     *
+     * @param touchpointId Unique identifier for touchpoint events shared by Meta with advertisers.
+     * @return AttributionData
+     */
+    public AttributionData touchpointId(String touchpointId) {
+      this.touchpointId = touchpointId;
+      return this;
+    }
+
+    /**
+     * Get touchpointId
+     *
+     * @return touchpointId
+     */
+    public String getTouchpointId() {
+      return touchpointId;
+    }
+
+    /**
+     * Set touchpointId
+     *
+     * @param touchpointId Unique identifier for touchpoint events shared by Meta with advertisers.
+     */
+    public void setTouchpointId(String touchpointId) {
+      this.touchpointId = touchpointId;
+    }
+
     /**
      * Set attributionSetting
-     * 
+     *
      * @param attributionSetting The attribution setting with inactivity and reattribution window configuration.
      * @return AttributionData
      */
@@ -638,12 +672,13 @@ public boolean equals(Object o) {
         && Objects.equals(this.declineReason, attributionData.declineReason)
         && Objects.equals(this.auditingToken, attributionData.auditingToken)
         && Objects.equals(this.linkageKey, attributionData.linkageKey)
+        && Objects.equals(this.touchpointId, attributionData.touchpointId)
         && Objects.equals(this.attributionSetting, attributionData.attributionSetting);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hash(scope, visitTime, adId, adsetId, campaignId, attributionShare, attributionModel, attributionWindow, attributionValue, attributionSource, touchpointType, touchpointTs, attributionMethod, declineReason, auditingToken, linkageKey, attributionSetting);
+      return Objects.hash(scope, visitTime, adId, adsetId, campaignId, attributionShare, attributionModel, attributionWindow, attributionValue, attributionSource, touchpointType, touchpointTs, attributionMethod, declineReason, auditingToken, linkageKey, touchpointId, attributionSetting);
     }
 
     @Override
@@ -666,6 +701,7 @@ public String toString() {
       sb.append("    declineReason: ").append(toIndentedString(declineReason)).append("\n");
       sb.append("    auditingToken: ").append(toIndentedString(auditingToken)).append("\n");
       sb.append("    linkageKey: ").append(toIndentedString(linkageKey)).append("\n");
+      sb.append("    touchpointId: ").append(toIndentedString(touchpointId)).append("\n");
       sb.append("    attributionSetting: ").append(toIndentedString(attributionSetting)).append("\n");
       sb.append("}");
       return sb.toString();

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

@@ -42,8 +42,9 @@ public void TestAttributionDataBuilderAndGetters() {
         DeclineReasonEnum declineReason = DeclineReasonEnum.LOOKBACK;
         String auditingToken = "token123";
         String linkageKey = "key123";
+        String touchpointId = "tp_test_touchpoint_id_123";
         AttributionSetting attributionSetting = new AttributionSetting(24, 48);
-          
+
         attributionData
                      .scope(scope)
                      .adId(adId)
@@ -61,6 +62,7 @@ public void TestAttributionDataBuilderAndGetters() {
                      .declineReason(declineReason)
                      .auditingToken(auditingToken)
                      .linkageKey(linkageKey)
+                     .touchpointId(touchpointId)
                      .attributionSetting(attributionSetting);
 
         assertEquals(attributionData.getScope(), scope);
@@ -79,6 +81,7 @@ public void TestAttributionDataBuilderAndGetters() {
         assertEquals(attributionData.getDeclineReason(), declineReason);
         assertEquals(attributionData.getAuditingToken(), auditingToken);
         assertEquals(attributionData.getLinkageKey(), linkageKey);
+        assertEquals(attributionData.getTouchpointId(), touchpointId);
         assertEquals(attributionData.getAttributionSetting(), attributionSetting);
         assertEquals((int)attributionData.getAttributionSetting().getInactivityWindowHours(), 24);
         assertEquals((int)attributionData.getAttributionSetting().getReattributionWindowHours(), 48);
@@ -104,8 +107,9 @@ public void TestWhenInstancesAreEqual() {
         DeclineReasonEnum declineReason = DeclineReasonEnum.LOOKBACK;
         String auditingToken = "token123";
         String linkageKey = "key123";
+        String touchpointId = "tp_test_touchpoint_id_123";
         AttributionSetting attributionSetting = new AttributionSetting(24, 48);
-          
+
         attributionData1
                      .scope(scope)
                      .adId(adId)
@@ -123,6 +127,7 @@ public void TestWhenInstancesAreEqual() {
                      .declineReason(declineReason)
                      .auditingToken(auditingToken)
                      .linkageKey(linkageKey)
+                     .touchpointId(touchpointId)
                      .attributionSetting(attributionSetting);
 
         attributionData2
@@ -142,6 +147,7 @@ public void TestWhenInstancesAreEqual() {
                      .declineReason(declineReason)
                      .auditingToken(auditingToken)
                      .linkageKey(linkageKey)
+                     .touchpointId(touchpointId)
                      .attributionSetting(attributionSetting);
 
         assertEquals(attributionData1, attributionData2);
@@ -170,7 +176,7 @@ public void TestWhenInstancesAreNotEqual() {
         AttributionSetting attributionSetting1 = new AttributionSetting(24, 48);
         AttributionSetting attributionSetting2 = new AttributionSetting(24, 48);
 
-        // set different attribution windown to test
+        // set different attribution window to test
         attributionData1
                      .scope(scope)
                      .adId(adId)
@@ -188,6 +194,7 @@ public void TestWhenInstancesAreNotEqual() {
                      .declineReason(declineReason)
                      .auditingToken(auditingToken)
                      .linkageKey(linkageKey)
+                     .touchpointId("tp_test_touchpoint_id_123")
                      .attributionSetting(attributionSetting1);
 
         attributionData2
@@ -207,6 +214,7 @@ public void TestWhenInstancesAreNotEqual() {
                      .declineReason(declineReason)
                      .auditingToken(auditingToken)
                      .linkageKey(linkageKey)
+                     .touchpointId("tp_test_touchpoint_id_456")
                      .attributionSetting(attributionSetting2);
 
         assertNotEquals(attributionData1, attributionData2);