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: satwikareddy3

Differential Revision:
D74686692

Privacy Context Container: L1246766

fbshipit-source-id: 8897af331397000576d0f31a18079ee799b47797

Author: shuaiwa-meta

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## v22.0.2
+### Changed
+- Update attribution_data, custom_data and original_event_data fields
+
 ## v17.0.0
 
 

src/FacebookAds/Object/ServerSide/AttributionData.php

@@ -42,6 +42,7 @@ class AttributionData implements ArrayAccess {
   private $attribution_share;
   private $attribution_model;
   private $attr_window;
+  private $attribution_value;
 
   protected static $param_types = array(
     'scope' => 'string',
@@ -52,6 +53,7 @@ class AttributionData implements ArrayAccess {
     'attribution_share' => 'float',
     'attribution_model' => 'FacebookAds\Object\ServerSide\AttributionModel',
     'attr_window' => 'int',
+    'attribution_value' => 'float',
   );
 
   protected static $attributeMap = array(
@@ -63,6 +65,7 @@ class AttributionData implements ArrayAccess {
     'attribution_share' => 'attribution_share',
     'attribution_model' => 'attribution_model',
     'attr_window' => 'attr_window',
+    'attribution_value' => 'attribution_value',
   );
 
   protected static $setters = array(
@@ -74,6 +77,7 @@ class AttributionData implements ArrayAccess {
     'attribution_share' => 'setAttributionShare',
     'attribution_model' => 'setAttributionModel',
     'attr_window' => 'setAttrWindow',
+    'attribution_value' => 'setAttributionValue',
   );
 
   protected static $getters = array(
@@ -85,6 +89,7 @@ class AttributionData implements ArrayAccess {
     'attribution_share' => 'getAttributionShare',
     'attribution_model' => 'getAttributionModel',
     'attr_window' => 'getAttrWindow',
+    'attribution_value' => 'getAttributionValue',
   );
 
   protected $container = array();
@@ -98,6 +103,7 @@ public function __construct(?array $data = null) {
     $this->container['attribution_share'] = isset($data['attribution_share']) ? $data['attribution_share'] : 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;
   }
 
   public static function paramTypes() {
@@ -213,6 +219,17 @@ public function setAttrWindow($attr_window) {
     return $this;
   }
 
+  /**
+   * Sets attribution_value
+   * @param float $attribution_value The share of value generated by this click-conversion pair that is attributed to Meta.
+   * @return $this
+   */
+  public function setAttributionValue($attribution_value) {
+    $this->container['attribution_value'] = $attribution_value;
+
+    return $this;
+  }
+
   /**
    * Gets touchpoint type.
    * @return string
@@ -277,6 +294,14 @@ public function getAttrWindow() {
     return $this->container['attr_window'];
   }
 
+  /**
+   * Gets attribution value.
+   * @return float
+   */
+  public function getAttributionValue() {
+    return $this->container['attribution_value'];
+  }
+
   /**
    * Returns true if offset exists. False otherwise.
    * @param integer $offset Offset
@@ -329,6 +354,7 @@ public function normalize() {
     $normalized_payload['attribution_share'] = $this->getAttributionShare();
     $normalized_payload['attribution_model'] = $this->getAttributionModel();
     $normalized_payload['attr_window'] = $this->getAttrWindow();
+    $normalized_payload['attribution_value'] = $this->getAttributionValue();
     return $normalized_payload;
   }
 

src/FacebookAds/Object/ServerSide/CustomData.php

@@ -36,6 +36,7 @@ class CustomData implements ArrayAccess {
    */
   protected static $param_types = array(
     'value' => 'float',
+    'net_revenue' => 'float',
     'currency' => 'string',
     'content_name' => 'string',
     'content_category' => 'string',
@@ -57,6 +58,7 @@ class CustomData implements ArrayAccess {
    */
   protected static $attributeMap = array(
     'value' => 'value',
+    'net_revenue' => 'net_revenue',
     'currency' => 'currency',
     'content_name' => 'content_name',
     'content_category' => 'content_category',
@@ -78,6 +80,7 @@ class CustomData implements ArrayAccess {
    */
   protected static $setters = array(
     'value' => 'setValue',
+    'net_revenue' => 'setNetRevenue',
     'currency' => 'setCurrency',
     'content_name' => 'setContentName',
     'content_category' => 'setContentCategory',
@@ -99,6 +102,7 @@ class CustomData implements ArrayAccess {
    */
   protected static $getters = array(
     'value' => 'getValue',
+    'net_revenue' => 'getNetRevenue',
     'currency' => 'getCurrency',
     'content_name' => 'getContentName',
     'content_category' => 'getContentCategory',
@@ -126,6 +130,7 @@ class CustomData implements ArrayAccess {
    */
   public function __construct(?array $data = null) {
     $this->container['value'] = isset($data['value']) ? $data['value'] : null;
+    $this->container['net_revenue'] = isset($data['net_revenue']) ? $data['net_revenue'] : null;
     $this->container['currency'] = isset($data['currency']) ? $data['currency'] : null;
     $this->container['content_name'] = isset($data['content_name']) ? $data['content_name'] : null;
     $this->container['content_category'] = isset($data['content_category']) ? $data['content_category'] : null;
@@ -190,6 +195,18 @@ public function setValue($value) {
     return $this;
   }
 
+  /**
+   * Sets net_revenue
+   * @param float $net_revenue A numeric net_revenue associated with this event.
+   *         This could be a monetary net_revenue or a net_revenue in some other metric.
+   * @return $this
+   */
+  public function setNetRevenue($net_revenue) {
+    $this->container['net_revenue'] = $net_revenue;
+
+    return $this;
+  }
+
   /**
    * Sets currency
    * @param string $currency The currency for the value specified, if applicable.
@@ -422,6 +439,7 @@ public function normalize() {
     $normalized_payload = array();
 
     $normalized_payload['value'] = $this->getValue();
+    $normalized_payload['net_revenue'] = $this->getNetRevenue();
     $normalized_payload['currency'] =
       Normalizer::normalize('currency', $this->getCurrency());
     $normalized_payload['content_name'] = $this->getContentName();
@@ -476,6 +494,15 @@ public function getValue() {
     return $this->container['value'];
   }
 
+  /**
+   * Gets a numeric net_revenue associated with this event.
+   * This could be a monetary net_revenue or a net_revenue in some other metric.
+   * @return float
+   */
+  public function getNetRevenue() {
+    return $this->container['net_revenue'];
+  }
+
   /**
    * Gets currency for the value specified, if applicable.
    * @return string

src/FacebookAds/Object/ServerSide/OriginalEventData.php

@@ -36,32 +36,44 @@ class OriginalEventData implements ArrayAccess {
 
   private $event_name;
   private $event_time;
+  private $order_id;
+  private $event_id;
 
   protected static $param_types = array(
     'event_name' => 'string',
     'event_time' => 'int',
+    'order_id' => 'string',
+    'event_id' => 'string',
   );
 
   protected static $attributeMap = array(
     'event_name' => 'event_name',
     'event_time' => 'event_time',
+    'order_id' => 'order_id',
+    'event_id' => 'event_id',
   );
 
   protected static $setters = array(
     'event_name' => 'setEventName',
     'event_time' => 'setEventTime',
+    'order_id' => 'setOrderID',
+    'event_id' => 'setEventID',
   );
 
   protected static $getters = array(
     'event_name' => 'getEventName',
     'event_time' => 'getEventTime',
+    'order_id' => 'getOrderID',
+    'event_id' => 'getEventID',
   );
 
   protected $container = array();
 
   public function __construct(?array $data = null) {
     $this->container['event_name'] = isset($data['event_name']) ? $data['event_name'] : null;
     $this->container['event_time'] = isset($data['event_time']) ? $data['event_time'] : null;
+    $this->container['order_id'] = isset($data['order_id']) ? $data['order_id'] : null;
+    $this->container['event_id'] = isset($data['event_id']) ? $data['event_id'] : null;
   }
 
   public static function paramTypes() {
@@ -111,6 +123,28 @@ public function setEventTime($event_time) {
     return $this;
   }
 
+  /**
+   * Sets the order ID
+   * @param string $order_id The order ID for this transaction as a string.
+   * @return $this
+   */
+  public function setOrderID($order_id) {
+    $this->container['order_id'] = $order_id;
+
+    return $this;
+  }
+
+  /**
+   * Sets the event ID
+   * @param string $event_id A unique string chosen by the advertiser.
+   * @return $this
+   */
+  public function setEventID($event_id) {
+    $this->container['event_id'] = $event_id;
+
+    return $this;
+  }
+
   /**
    * Gets Meta pixel Standard Event or Custom Event name.
    * @return string
@@ -127,11 +161,29 @@ public function getEventTime() {
     return $this->container['event_time'];
   }
 
+  /**
+   * Gets order ID of the original event.
+   * @return string
+   */
+  public function getOrderID() {
+    return $this->container['order_id'];
+  }
+
+  /**
+   * Gets event ID of the original event.
+   * @return string
+   */
+  public function getEventID() {
+    return $this->container['event_id'];
+  }
+
   public function normalize() {
     $normalized_payload = array();
 
     $normalized_payload['event_name'] = $this->getEventName();
     $normalized_payload['event_time'] = $this->getEventTime();
+    $normalized_payload['order_id'] = $this->getOrderID();
+    $normalized_payload['event_id'] = $this->getEventID();
     return $normalized_payload;
   }
 

test/FacebookAdsTest/Object/ServerSide/AttributionDataTest.php

@@ -38,6 +38,7 @@ public function testBuilderAndConstructor() {
       'attr_window' => 7,
       'attribution_share' => 0.5,
       'attribution_model' => 'last_touch'
+      'attribution_value' => 3.45
     );
     $builder = (new AttributionData())
       ->setScope($expected['scope'])
@@ -47,7 +48,8 @@ public function testBuilderAndConstructor() {
       ->setCampaignId($expected['campaign_id'])
       ->setAttrWindow($expected['attr_window'])
       ->setAttributionShare($expected['attribution_share'])
-      ->setAttributionModel($expected['attribution_model']);
+      ->setAttributionModel($expected['attribution_model'])
+      ->setAttributionValue($expected['attribution_value']);
     $this->assertEquals($expected, $builder->normalize());
 
     $constructor = new AttributionData(array(
@@ -58,7 +60,8 @@ public function testBuilderAndConstructor() {
       'campaign_id' => $expected['campaign_id'],
       'attr_window' => $expected['attr_window'],
       'attribution_share' => $expected['attribution_share'],
-      'attribution_model' => $expected['attribution_model']
+      'attribution_model' => $expected['attribution_model'],
+      'attribution_value' => $expected['attribution_value']
     ));
     $this->assertEquals($expected, $constructor->normalize());
   }

test/FacebookAdsTest/Object/ServerSide/CustomDataTest.php

@@ -39,6 +39,7 @@ public function testBuilderAndConstructor() {
     $content = new Content($content_state);
     $state = array(
       'value' => 0.1,
+      'net_revenue' => 0.05,
       'currency' => 'usd',
       'content_name' => 'content-name-2',
       'content_category' => 'content-category-3',
@@ -59,6 +60,7 @@ public function testBuilderAndConstructor() {
     );
     $builder = (new CustomData())
       ->setValue($state['value'])
+      ->setNetRevenue($state['net_revenue'])
       ->setCurrency($state['currency'])
       ->setContentName($state['content_name'])
       ->setContentCategory($state['content_category'])
@@ -77,6 +79,7 @@ public function testBuilderAndConstructor() {
 
     $constructor = new CustomData(array(
       'value' => $state['value'],
+      'net_revenue' => $state['net_revenue'],
       'currency' => $state['currency'],
       'content_name' => $state['content_name'],
       'content_category' => $state['content_category'],

test/FacebookAdsTest/Object/ServerSide/OriginalEventDataTest.php

@@ -31,16 +31,22 @@ class OriginalEventDataTest extends AbstractUnitTestCase {
   public function testBuilderAndConstructor() {
     $expected = array(
       'event_name' => 'event-name-1',
-      'event_time' => 123456
+      'event_time' => 123456,
+      'order_id' => 'order-1',
+      'event_id' => 'event-1'
     );
     $builder = (new OriginalEventData())
       ->setEventName($expected['event_name'])
-      ->setCurrency($expected['event_time']);
+      ->setCurrency($expected['event_time'])
+      ->setOrderID($expected['order_id'])
+      ->setEventID($expected['event_id']);
     $this->assertEquals($expected, $builder->normalize());
 
     $constructor = new OriginalEventData(array(
       'event_name' => $expected['event_name'],
-      'event_time' => $expected['event_time']
+      'event_time' => $expected['event_time'],
+      'order_id' => $expected['order_id'],
+      'event_id' => $expected['event_id']
     ));
     $this->assertEquals($expected, $constructor->normalize());
   }