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

Privacy Context Container: L1246766

fbshipit-source-id: b306f4dce641471670b5cdc8365b7ade1632eb79

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
 
 

lib/facebook_ads/ad_objects/server_side/attribution_data.rb

@@ -46,6 +46,9 @@ class AttributionData
         # Attribution woindow in days.
         attr_accessor :attr_window
 
+        # The share of value generated by this click-conversion pair that is attributed to Meta.
+        attr_accessor :attribution_value
+
 
 
         # @param [String] scope
@@ -56,7 +59,8 @@ class AttributionData
         # @param [Float] attribution_share
         # @param [String] attribution_model
         # @param [String] attr_window
-        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil)
+        # @param [Float] attribution_value
+        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil, attribution_value: nil)
           unless scope.nil?
             self.scope = scope
           end
@@ -81,6 +85,9 @@ def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_
           unless attr_window.nil?
             self.attr_window = attr_window
           end
+          unless attribution_value.nil?
+            self.attribution_value = attribution_value
+          end
         end
 
         # build the object using the input hash
@@ -122,6 +129,10 @@ def build(attributes = {})
           if attributes.has_key?(:'attr_window')
             self.attr_window = attributes[:'attr_window']
           end
+
+          if attributes.has_key?(:'attribution_value')
+            self.attribution_share = attributes[:'attribution_value']
+          end
         end
 
         # Checks equality by comparing each attribute.
@@ -135,7 +146,8 @@ def ==(o)
               campaign_id == o.campaign_id &&
               attribution_share == o.attribution_share &&
               attribution_model == o.attribution_model &&
-              attr_window == o.attr_window
+              attr_window == o.attr_window &&
+              attribution_value == o.attribution_value
         end
 
         # @see the `==` method
@@ -147,7 +159,7 @@ def eql?(o)
         # @return [Fixnum] Hash code
         def hash
           [
-            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value
           ].hash
         end
 
@@ -177,6 +189,9 @@ def to_s
           unless attr_window.nil?
             hash['attr_window'] = attr_window
           end
+          unless attribution_value.nil?
+            hash['attribution_value'] = attribution_value
+          end
           hash.to_s
         end
 
@@ -208,6 +223,9 @@ def normalize
           unless attr_window.nil?
             hash['attr_window'] = attr_window
           end
+          unless attribution_value.nil?
+            hash['attribution_value'] = attribution_value
+          end
           hash
         end
 

lib/facebook_ads/ad_objects/server_side/custom_data.rb

@@ -25,6 +25,10 @@ class CustomData
       # Example: 142.54.
       attr_accessor :value
 
+      # A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric.
+      # Example: 30.54.
+      attr_accessor :net_revenue
+
       # The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
       # Example: 'usd'.
       attr_accessor :currency
@@ -83,6 +87,7 @@ class CustomData
 
 
       # @param [Float] value
+      # @param [Float] net_revenue
       # @param [String] currency
       # @param [String] content_name
       # @param [String] content_category
@@ -98,6 +103,7 @@ class CustomData
       # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
+                     net_revenue: nil,
                      currency: nil,
                      content_name: nil,
                      content_category: nil,
@@ -116,6 +122,9 @@ def initialize(value: nil,
         unless value.nil?
           self.value = value
         end
+        unless net_revenue.nil?
+          self.net_revenue = net_revenue
+        end
         unless currency.nil?
           self.currency = currency
         end
@@ -173,6 +182,10 @@ def build(attributes = {})
           self.value = attributes[:'value']
         end
 
+        if attributes.has_key?(:'net_revenue')
+          self.net_revenue = attributes[:'net_revenue']
+        end
+
         if attributes.has_key?(:'currency')
           self.currency = attributes[:'currency']
         end
@@ -239,6 +252,7 @@ def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
             value == o.value &&
+            net_revenue == o.net_revenue &&
             currency == o.currency &&
             content_name == o.content_name &&
             content_category == o.content_category &&
@@ -265,6 +279,7 @@ def eql?(o)
       def hash
         [
             value,
+            net_revenue,
             currency,
             content_name,
             content_category,
@@ -289,6 +304,9 @@ def to_s
         unless value.nil?
           hash['value'] = value
         end
+        unless net_revenue.nil?
+          hash['net_revenue'] = net_revenue
+        end
         unless currency.nil?
           hash['currency'] = currency
         end
@@ -342,6 +360,9 @@ def normalize
         unless value.nil?
           hash['value'] = value
         end
+        unless net_revenue.nil?
+          hash['net_revenue'] = net_revenue
+        end
         unless currency.nil?
           hash['currency'] = FacebookAds::ServerSide::Util.normalize(currency, 'currency')
         end

lib/facebook_ads/ad_objects/server_side/original_event_data.rb

@@ -29,15 +29,29 @@ class OriginalEventData
         # A Unix timestamp in seconds indicating when the original event occurred.
         attr_accessor :event_time
 
+        # The order ID for this transaction as a string.
+        attr_accessor :order_id
+
+        # A unique string chosen by the advertiser.
+        attr_accessor :event_id
+
         # @param [String] event_name
         # @param [int] event_time
-        def initialize(event_name: nil, event_time: nil)
+        # @param [String] order_id
+        # @param [String] event_id
+        def initialize(event_name: nil, event_time: nil, order_id: nil, event_id: nil)
           unless event_name.nil?
             self.event_name = event_name
           end
           unless event_time.nil?
             self.event_time = event_time
           end
+          unless order_id.nil?
+            self.order_id = order_id
+          end
+          unless event_id.nil?
+            self.event_id = event_id
+          end
         end
 
         # build the object using the input hash
@@ -55,14 +69,24 @@ def build(attributes = {})
           if attributes.has_key?(:'event_time')
             self.event_time = attributes[:'event_time']
           end
+
+          if attributes.has_key?(:'order_id')
+            self.order_id = attributes[:'order_id']
+          end
+
+          if attributes.has_key?(:'event_id')
+            self.event_id = attributes[:'event_id']
+          end
         end
 
         # Checks equality by comparing each attribute.
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
               event_name == o.event_name &&
-              event_time == o.event_time
+              event_time == o.event_time &&
+              order_id == o.order_id &&
+              event_id == o.event_id
         end
 
         # @see the `==` method
@@ -74,7 +98,7 @@ def eql?(o)
         # @return [Fixnum] Hash code
         def hash
           [
-            event_name, event_time,
+            event_name, event_time, order_id, event_id,
           ].hash
         end
 
@@ -86,6 +110,12 @@ def to_s
           unless event_time.nil?
             hash['event_time'] = event_time
           end
+          unless order_id.nil?
+            hash['order_id'] = order_id
+          end
+          unless event_id.nil?
+            hash['event_id'] = event_id
+          end
           hash.to_s
         end
 
@@ -99,6 +129,12 @@ def normalize
           unless event_time.nil?
             hash['event_time'] = event_time
           end
+          unless order_id.nil?
+            hash['order_id'] = order_id
+          end
+          unless event_id.nil?
+            hash['event_id'] = event_id
+          end
           hash
         end
 

spec/lib/facebook_ads/ad_objects/server_side/attribution_data_spec.rb

@@ -27,6 +27,7 @@
         attr_window = 7
         attribution_share = 0.5
         attribution_model = 'last_click'
+        attribution_value = 3.45
         attribution_data = FacebookAds::ServerSide::AttributionData.new(
             scope: scope,
             visit_time: visit_time,
@@ -36,6 +37,7 @@
             attr_window: attr_window,
             attribution_share: attribution_share,
             attribution_model: attribution_model,
+            attribution_value: attribution_value,
         )
 
         expect(attribution_data.normalize).to eq({
@@ -47,6 +49,7 @@
             'attr_window': attr_window,
             'attribution_share': attribution_share,
             'attribution_model': attribution_model,
+            'attribution_value': attribution_value,
         })
     end
 
@@ -65,6 +68,7 @@
             attr_window: 7,
             attribution_share: 0.5,
             attribution_model: 'last_click',
+            attribution_value: 3.45,
         )
         attribution_data2 = FacebookAds::ServerSide::AttributionData.new(
             scope: 'click',
@@ -75,6 +79,7 @@
             attr_window: 7,
             attribution_share: 0.5,
             attribution_model: 'last_click',
+            attribution_value: 3.45,
         )
         expect(attribution_data1).to eq(attribution_data2)
         expect(attribution_data1.hash).to eq(attribution_data2.hash)
@@ -95,6 +100,7 @@
             attr_window: 7,
             attribution_share: 0.5,
             attribution_model: 'last_click',
+            attribution_value: 3.45,
         )
         attribution_data2 = FacebookAds::ServerSide::AttributionData.new(
             scope: 'click',
@@ -106,6 +112,7 @@
             # different attribution share to test
             attribution_share: 0.4,
             attribution_model: 'last_click',
+            attribution_value: 2.45,
         )
         expect(attribution_data1).to_not eq(attribution_data2)
         expect(attribution_data1.hash).to_not eq(attribution_data2.hash)

spec/lib/facebook_ads/ad_objects/server_side/custom_data_spec.rb

@@ -20,6 +20,7 @@
 RSpec.describe 'FacebookAds::ServerSide::CustomData' do
   it 'normalize works' do
     value = 0.1
+    net_revenue = 0.05
     currency = 'usd'
     content_name = 'content-name-1'
     content_category = 'content-category-2'
@@ -36,6 +37,7 @@
     custom_properties = {'custom10' => 'property10'}
     custom_data = FacebookAds::ServerSide::CustomData.new(
       value: value,
+      net_revenue: net_revenue,
       currency: currency,
       content_name: content_name,
       content_category: content_category,
@@ -54,6 +56,7 @@
 
     expect(custom_data.normalize).to eq(custom_properties.merge(
       'value' => value,
+      'net_revenue' => net_revenue,
       'currency' => currency,
       'content_name' => content_name,
       'content_category' => content_category,
@@ -88,6 +91,7 @@
 
     custom_data1 = FacebookAds::ServerSide::CustomData.new(
       value: 0.1,
+      net_revenue: 0.05,
       currency: 'usd',
       content_name: 'content-name-1',
       content_category: 'content-category-2',
@@ -105,6 +109,7 @@
     )
     custom_data2 = FacebookAds::ServerSide::CustomData.new(
       value: 0.1,
+      net_revenue: 0.05,
       currency: 'usd',
       content_name: 'content-name-1',
       content_category: 'content-category-2',
@@ -127,6 +132,7 @@
   it 'not equals works' do
     custom_data1 = FacebookAds::ServerSide::CustomData.new(
       value: 0.1,
+      net_revenue: 0.05,
       currency: 'usd',
       content_name: 'content-name-1',
       content_category: 'content-category-2',
@@ -144,6 +150,7 @@
     )
     custom_data2 = FacebookAds::ServerSide::CustomData.new(
       value: 0.1,
+      net_revenue: 0.03,
       currency: 'usd',
       content_name: 'content-name-1',
       content_category: 'content-category-2',

spec/lib/facebook_ads/ad_objects/server_side/original_event_data_spec.rb

@@ -21,14 +21,20 @@
     it 'normalize works' do
         event_name = 'event-name-1'
         event_time = 12345
+        order_id = 'order_id-1'
+        event_id = 'event_id-1'
         original_event_data = FacebookAds::ServerSide::OriginalEventData.new(
             event_name: event_name,
             event_time: event_time,
+            order_id: order_id,
+            event_id: event_id,
         )
 
         expect(original_event_data.normalize).to eq({
             'event_name' => event_name,
             'event_time' => event_time,
+            'order_id' => order_id,
+            'event_id' => event_id,
         })
     end