facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/server_side/attribution_data.rb

@@ -0,0 +1,216 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+    module ServerSide
+
+      # AttributionData indicated the attribution data used for attribution passback event to optimize the performance.
+      class AttributionData
+
+        # Touchpoint type.
+        attr_accessor :scope
+
+        # A Unix timestamp in seconds indicating when the campaign_id or fbc was first received.
+        attr_accessor :visit_time
+
+        # Meta-provided ad id from URL/deeplink.
+        attr_accessor :ad_id
+
+        # Meta-provided adset id from URL/deeplink.
+        attr_accessor :adset_id
+
+        # Meta-provided campaign id from URL/deeplink.
+        attr_accessor :campaign_id
+
+        # [0-1] weight of credit assigned to the visit.
+        attr_accessor :attribution_share
+
+        # Attribution model used to attribute the event.
+        attr_accessor :attribution_model
+
+        # Attribution woindow in days.
+        attr_accessor :attr_window
+
+
+
+        # @param [String] scope
+        # @param [Integer] visit_time
+        # @param [String] ad_id
+        # @param [String] adset_id
+        # @param [String] campaign_id
+        # @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)
+          unless scope.nil?
+            self.scope = scope
+          end
+          unless visit_time.nil?
+            self.visit_time = visit_time
+          end
+          unless ad_id.nil?
+            self.ad_id = ad_id
+          end
+          unless adset_id.nil?
+            self.adset_id = adset_id
+          end
+          unless campaign_id.nil?
+            self.campaign_id = campaign_id
+          end
+          unless attribution_share.nil?
+            self.attribution_share = attribution_share
+          end
+          unless attribution_model.nil?
+            self.attribution_model = attribution_model
+          end
+          unless attr_window.nil?
+            self.attr_window = attr_window
+          end
+        end
+
+        # build the object using the input hash
+        # @param [Hash] attributes  attributes in the form of hash
+        def build(attributes = {})
+          return unless attributes.is_a?(Hash)
+
+          # convert string to symbol for hash key
+          attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+          if attributes.has_key?(:'scope')
+            self.scope = attributes[:'scope']
+          end
+
+          if attributes.has_key?(:'visit_time')
+            self.visit_time = attributes[:'visit_time']
+          end
+
+          if attributes.has_key?(:'ad_id')
+            self.ad_id = attributes[:'ad_id']
+          end
+
+          if attributes.has_key?(:'adset_id')
+            self.adset_id = attributes[:'adset_id']
+          end
+
+          if attributes.has_key?(:'campaign_id')
+            self.campaign_id = attributes[:'campaign_id']
+          end
+
+          if attributes.has_key?(:'attribution_share')
+            self.attribution_share = attributes[:'attribution_share']
+          end
+
+          if attributes.has_key?(:'attribution_model')
+            self.attribution_model = attributes[:'attribution_model']
+          end
+
+          if attributes.has_key?(:'attr_window')
+            self.attr_window = attributes[:'attr_window']
+          end
+        end
+
+        # Checks equality by comparing each attribute.
+        def ==(o)
+          return true if self.equal?(o)
+          self.class == o.class &&
+              scope == o.scope &&
+              visit_time == o.visit_time &&
+              ad_id == o.ad_id &&
+              adset_id == o.adset_id &&
+              campaign_id == o.campaign_id &&
+              attribution_share == o.attribution_share &&
+              attribution_model == o.attribution_model &&
+              attr_window == o.attr_window
+        end
+
+        # @see the `==` method
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Fixnum] Hash code
+        def hash
+          [
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window
+          ].hash
+        end
+
+        def to_s
+          hash = {}
+          unless scope.nil?
+            hash['scope'] = scope
+          end
+          unless visit_time.nil?
+            hash['visit_time'] = visit_time
+          end
+          unless ad_id.nil?
+            hash['ad_id'] = ad_id
+          end
+          unless adset_id.nil?
+            hash['adset_id'] = adset_id
+          end
+          unless campaign_id.nil?
+            hash['campaign_id'] = campaign_id
+          end
+          unless attribution_share.nil?
+            hash['attribution_share'] = attribution_share
+          end
+          unless attribution_model.nil?
+            hash['attribution_model'] = attribution_model
+          end
+          unless attr_window.nil?
+            hash['attr_window'] = attr_window
+          end
+          hash.to_s
+        end
+
+
+        # Normalize input fields to server request format.
+        def normalize
+          hash = {}
+          unless scope.nil?
+            hash['scope'] = scope
+          end
+          unless visit_time.nil?
+            hash['visit_time'] = visit_time
+          end
+          unless ad_id.nil?
+            hash['ad_id'] = ad_id
+          end
+          unless adset_id.nil?
+            hash['adset_id'] = adset_id
+          end
+          unless campaign_id.nil?
+            hash['campaign_id'] = campaign_id
+          end
+          unless attribution_share.nil?
+            hash['attribution_share'] = attribution_share
+          end
+          unless attribution_model.nil?
+            hash['attribution_model'] = attribution_model
+          end
+          unless attr_window.nil?
+            hash['attr_window'] = attr_window
+          end
+          hash
+        end
+
+      end
+    end
+  end

data/lib/facebook_ads/ad_objects/server_side/event.rb

@@ -18,6 +18,9 @@
 
 require_relative './user_data'
 require_relative './custom_data'
+require_relative './app_data'
+require_relative './original_event_data'
+require_relative './attribution_data'
 
 module FacebookAds
   module ServerSide
@@ -52,6 +55,9 @@ module FacebookAds
       # An Object that includes additional business data about the event.
       attr_accessor :custom_data
 
+      # An Object that contains app data.
+      attr_accessor :app_data
+
       # Processing options you would like to enable for a specific event.
       # For more details see https://developers.facebook.com/docs/marketing-apis/data-processing-options
       attr_accessor :data_processing_options
@@ -67,6 +73,19 @@ module FacebookAds
       # Where the conversion occurred.
       attr_accessor :action_source
 
+      # Name of Advanced Measurement table.
+      # Only used for the Advanced Measurement API in the Advanced Analytics product
+      attr_accessor :advanced_measurement_table
+
+      # Messaging channel for the event
+      attr_accessor :messaging_channel
+
+      # Original event info
+      attr_accessor :original_event_data
+
+      # Attribution data info
+      attr_accessor :attribution_data
+
       # @param [String] event_name
       # @param [int] event_time
       # @param [String] event_source_url
@@ -74,10 +93,15 @@ module FacebookAds
       # @param [String] event_id
       # @param [FacebookAds::ServerSide::UserData] user_data
       # @param [FacebookAds::ServerSide::CustomData] custom_data
+      # @param [FacebookAds::ServerSide::AppData] app_data
       # @param [Array<String>] data_processing_options
       # @param [int] data_processing_options_country
       # @param [int] data_processing_options_state
       # @param String action_source
+      # @param [String] advanced_measurement_table
+      # @param [String] messaging_channel
+      # @param [FacebookAds::ServerSide::OriginalEventData] original_event_data
+      # @param [FacebookAds::ServerSide::AttributionData] attribution_data
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
@@ -85,10 +109,16 @@ module FacebookAds
                      event_id: nil,
                      user_data: nil,
                      custom_data: nil,
+                     app_data: nil,
                      data_processing_options: nil,
                      data_processing_options_country: nil,
                      data_processing_options_state: nil,
-                     action_source: nil)
+                     action_source: nil,
+                     advanced_measurement_table: nil,
+                     messaging_channel: nil,
+                     original_event_data: nil,
+                     attribution_data: nil
+                     )
 
         unless event_name.nil?
           self.event_name = event_name
@@ -111,6 +141,9 @@ module FacebookAds
         unless custom_data.nil?
           self.custom_data = custom_data
         end
+        unless app_data.nil?
+          self.app_data = app_data
+        end
         unless data_processing_options.nil?
           self.data_processing_options = data_processing_options
         end
@@ -123,6 +156,18 @@ module FacebookAds
         unless action_source.nil?
           self.action_source = action_source
         end
+        unless advanced_measurement_table.nil?
+          self.advanced_measurement_table = advanced_measurement_table
+        end
+        unless messaging_channel.nil?
+          self.messaging_channel = messaging_channel
+        end
+        unless original_event_data.nil?
+          self.original_event_data = original_event_data
+        end
+        unless attribution_data.nil?
+          self.attribution_data = attribution_data
+        end
       end
 
       # build the object using the input hash
@@ -161,6 +206,10 @@ module FacebookAds
           self.custom_data = attributes[:'custom_data']
         end
 
+        if attributes.has_key?(:'app_data')
+          self.app_data = attributes[:'app_data']
+        end
+
         if attributes.has_key?(:'data_processing_options')
           self.data_processing_options = attributes[:'data_processing_options']
         end
@@ -176,6 +225,22 @@ module FacebookAds
         if attributes.has_key?(:'action_source')
           self.action_source = attributes[:'action_source']
         end
+
+        if attributes.has_key?(:'advanced_measurement_table')
+          self.advanced_measurement_table = attributes[:'advanced_measurement_table']
+        end
+
+        if attributes.has_key?(:'messaging_channel')
+          self.messaging_channel = attributes[:'messaging_channel']
+        end
+
+        if attributes.has_key?(:'original_event_data')
+          self.original_event_data = attributes[:'original_event_data']
+        end
+
+        if attributes.has_key?(:'attribution_data')
+          self.attribution_data = attributes[:'attribution_data']
+        end
       end
 
       # Show invalid properties with the reasons. Usually used together with valid?
@@ -217,10 +282,15 @@ module FacebookAds
             event_id == o.event_id &&
             user_data == o.user_data &&
             custom_data == o.custom_data &&
+            app_data == o.app_data &&
             data_processing_options == o.data_processing_options &&
             data_processing_options_country == o.data_processing_options_country &&
             data_processing_options_state == o.data_processing_options_state &&
-            action_source == o.action_source
+            action_source == o.action_source &&
+            advanced_measurement_table == o.advanced_measurement_table &&
+            messaging_channel == o.messaging_channel &&
+            original_event_data == o.original_event_data &&
+            attribution_data == o.attribution_data
       end
 
       # @see the `==` method
@@ -232,9 +302,9 @@ module FacebookAds
       # @return [Fixnum] Hash code
       def hash
         [
-          event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data,
+          event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data, app_data,
           data_processing_options, data_processing_options_country, data_processing_options_state,
-          action_source,
+          action_source, advanced_measurement_table, messaging_channel, original_event_data, attribution_data
         ].hash
       end
 
@@ -261,6 +331,9 @@ module FacebookAds
         unless custom_data.nil?
           hash['custom_data'] = custom_data.to_s
         end
+        unless app_data.nil?
+          hash['app_data'] = app_data.to_s
+        end
         unless data_processing_options.nil?
           hash['data_processing_options'] = data_processing_options.to_s
         end
@@ -273,6 +346,18 @@ module FacebookAds
         unless action_source.nil?
           hash['action_source'] = action_source
         end
+        unless advanced_measurement_table.nil?
+          hash['advanced_measurement_table'] = advanced_measurement_table
+        end
+        unless messaging_channel.nil?
+          hash['messaging_channel'] = messaging_channel
+        end
+        unless original_event_data.nil?
+          hash['original_event_data'] = original_event_data
+        end
+        unless attribution_data.nil?
+          hash['attribution_data'] = attribution_data
+        end
         hash.to_s
       end
 
@@ -301,6 +386,9 @@ module FacebookAds
         unless custom_data.nil?
           hash['custom_data'] = custom_data.normalize
         end
+        unless app_data.nil?
+          hash['app_data'] = app_data.normalize
+        end
         unless data_processing_options.nil?
           hash['data_processing_options'] = data_processing_options
         end
@@ -316,6 +404,18 @@ module FacebookAds
             'action_source'
           )
         end
+        unless advanced_measurement_table.nil?
+          hash['advanced_measurement_table'] = advanced_measurement_table
+        end
+        unless messaging_channel.nil?
+          hash['messaging_channel'] = messaging_channel
+        end
+        unless original_event_data.nil?
+          hash['original_event_data'] = original_event_data
+        end
+        unless attribution_data.nil?
+          hash['attribution_data'] = attribution_data
+        end
         hash
       end
 

data/lib/facebook_ads/ad_objects/server_side/event_request.rb

@@ -17,6 +17,7 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'json'
+require 'ostruct'
 
 require_relative './event'
 require_relative './event_response'
@@ -51,6 +52,9 @@ module FacebookAds
       # The origin/source of data for the dataset to be uploaded.
       attr_accessor :upload_source
 
+      # Access token to use for AdObject Session
+      attr_accessor :access_token
+
       # The HttpServiceInterface client to use for executing the request.
       attr_accessor :http_service_client
 
@@ -62,10 +66,11 @@ module FacebookAds
       # @param [String] upload_id
       # @param [String] upload_tag
       # @param [String] upload_source
+      # @param [String] access_token
       # @param [HttpServiceInterface] http_service_client
       def initialize(pixel_id: nil, events: nil, test_event_code: nil, partner_agent: nil,
           namespace_id: nil, upload_id: nil, upload_tag: nil, upload_source: nil,
-          http_service_client: nil)
+          access_token: nil, http_service_client: nil)
         unless pixel_id.nil?
           self.pixel_id = pixel_id
         end
@@ -90,6 +95,9 @@ module FacebookAds
         unless upload_source.nil?
           self.upload_source = upload_source
         end
+        unless access_token.nil?
+          self.access_token = access_token
+        end
         unless http_service_client.nil?
           self.http_service_client = http_service_client
         end
@@ -153,7 +161,8 @@ module FacebookAds
         end
         params = get_params()
         params[:data] = normalize
-        ads_pixel = FacebookAds::AdsPixel.get(pixel_id)
+        session = FacebookAds::Session.new(access_token: access_token) if access_token
+        ads_pixel = FacebookAds::AdsPixel.get(pixel_id, session)
         response = ads_pixel.events.create(params)
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
         FacebookAds::ServerSide::EventResponse.new(