facebookbusiness 0.13.0.0 → 18.0.3

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

@@ -0,0 +1,269 @@
+# 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
+      # AppData which contains app data and device information for events happening from an app.
+      class AppData
+        # Use this field to specify ATT permission on an iOS 14.5+ device. Set to 0 for disabled or 1 for enabled.
+        attr_accessor :application_tracking_enabled
+
+        # A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use 0 for disabled, 1 for enabled. `
+        attr_accessor :advertiser_tracking_enabled
+
+        # Specifies that view through data should be considered when determining the ad to attribute this install to. Clicks will always be considered first before views and views will only be returned if there was not a click on an ad for the app
+        attr_accessor :consider_views
+
+        # Extended device information, such as screen width and height.
+        attr_accessor :extinfo
+
+        # Specifies that view dwell ms should be returned as part of view through data
+        attr_accessor :include_dwell_data
+
+        # Specifies that video view completion percentages should be returned as part of view through data
+        attr_accessor :include_video_data
+
+        # Third party install referrer, currently available for Android only, see here for more.
+        attr_accessor :install_referrer
+
+        # Used internally by the Android SDKs
+        attr_accessor :installer_package
+
+        # Used internally by the iOS and Android SDKs.
+        attr_accessor :url_schemes
+
+        # Attribution token used for Windows 10.
+        attr_accessor :windows_attribution_id
+
+        # @param [Boolean] application_tracking_enabled
+        # @param [Boolean] advertiser_tracking_enabled
+        # @param [Boolean] consider_views
+        # @param [ExtendedDeviceInfo] extinfo
+        # @param [Boolean] include_dwell_data
+        # @param [Boolean] include_video_data
+        # @param [String] install_referrer
+        # @param [String] installer_package
+        # @param [Array<String>] url_schemes
+        # @param [String] windows_attribution_id
+        def initialize(application_tracking_enabled: nil,
+          advertiser_tracking_enabled: nil,
+          consider_views: nil,
+          extinfo: nil,
+          include_dwell_data: nil,
+          include_video_data: nil,
+          install_referrer: nil,
+          installer_package: nil,
+          url_schemes: nil,
+          windows_attribution_id: nil)
+
+          unless application_tracking_enabled.nil?
+            self.application_tracking_enabled = application_tracking_enabled
+          end
+          unless advertiser_tracking_enabled.nil?
+            self.advertiser_tracking_enabled = advertiser_tracking_enabled
+          end
+          unless consider_views.nil?
+            self.consider_views = consider_views
+          end
+          unless extinfo.nil?
+            self.extinfo = extinfo
+          end
+          unless include_dwell_data.nil?
+            self.include_dwell_data = include_dwell_data
+          end
+          unless include_video_data.nil?
+            self.include_video_data = include_video_data
+          end
+          unless install_referrer.nil?
+            self.install_referrer = install_referrer
+          end
+          unless installer_package.nil?
+            self.installer_package = installer_package
+          end
+          unless url_schemes.nil?
+            self.url_schemes = url_schemes
+          end
+          unless windows_attribution_id.nil?
+            self.windows_attribution_id = windows_attribution_id
+          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?(:'application_tracking_enabled')
+            self.application_tracking_enabled = attributes[:'application_tracking_enabled']
+          end
+
+          if attributes.has_key?(:'advertiser_tracking_enabled')
+            self.advertiser_tracking_enabled = attributes[:'advertiser_tracking_enabled']
+          end
+
+          if attributes.has_key?(:'consider_views')
+            self.consider_views = attributes[:'consider_views']
+          end
+
+          if attributes.has_key?(:'extinfo')
+            self.extinfo = attributes[:'extinfo']
+          end
+
+          if attributes.has_key?(:'include_dwell_data')
+            self.include_dwell_data = attributes[:'include_dwell_data']
+          end
+
+
+          if attributes.has_key?(:'include_video_data')
+            self.include_video_data = attributes[:'include_video_data']
+          end
+
+          if attributes.has_key?(:'install_referrer')
+            self.install_referrer = attributes[:'install_referrer']
+          end
+
+          if attributes.has_key?(:'installer_package')
+            self.installer_package = attributes[:'installer_package']
+          end
+
+          if attributes.has_key?(:'url_schemes')
+            self.url_schemes = attributes[:'url_schemes']
+          end
+
+          if attributes.has_key?(:'windows_attribution_id')
+            self.windows_attribution_id = attributes[:'windows_attribution_id']
+          end
+        end
+
+      # Checks equality by comparing each attribute.
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+            application_tracking_enabled == o.application_tracking_enabled &&
+            advertiser_tracking_enabled == o.advertiser_tracking_enabled &&
+            consider_views == o.consider_views &&
+            extinfo == o.extinfo &&
+            include_dwell_data == o.include_dwell_data &&
+            include_video_data == o.include_video_data &&
+            install_referrer == o.install_referrer &&
+            installer_package == o.installer_package &&
+            url_schemes == o.url_schemes &&
+            windows_attribution_id == o.windows_attribution_id
+      end
+
+      # @see the `==` method
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Fixnum] Hash code
+      def hash
+        [
+            application_tracking_enabled,
+            advertiser_tracking_enabled,
+            consider_views,
+            extinfo,
+            include_dwell_data,
+            include_video_data,
+            install_referrer,
+            installer_package,
+            url_schemes,
+            windows_attribution_id
+        ].hash
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        hash = {}
+        unless vapplication_tracking_enabledalue.nil?
+          hash['application_tracking_enabled'] = application_tracking_enabled
+        end
+        unless advertiser_tracking_enabled.nil?
+          hash['advertiser_tracking_enabled'] = advertiser_tracking_enabled
+        end
+        unless consider_views.nil?
+          hash['consider_views'] = consider_views
+        end
+        unless extinfo.nil?
+          hash['extinfo'] = extinfo.to_s
+        end
+        unless include_dwell_data.nil?
+          hash['include_dwell_data'] = include_dwell_data
+        end
+        unless include_video_data.nil?
+          hash['include_video_data'] = include_video_data
+        end
+        unless install_referrer.nil?
+          hash['install_referrer'] = install_referrer
+        end
+        unless installer_package.nil?
+          hash['installer_package'] = installer_package
+        end
+        unless url_schemes.nil?
+          hash['url_schemes'] = url_schemes.to_s
+        end
+        unless windows_attribution_id.nil?
+          hash['windows_attribution_id'] = windows_attribution_id
+        end
+        hash.to_s
+      end
+
+      # Normalize input fields to server request format.
+      def normalize
+        hash = {}
+        unless application_tracking_enabled.nil?
+          hash['application_tracking_enabled'] = application_tracking_enabled
+        end
+        unless advertiser_tracking_enabled.nil?
+          hash['advertiser_tracking_enabled'] = advertiser_tracking_enabled
+        end
+        unless consider_views.nil?
+          hash['consider_views'] = consider_views
+        end
+        unless include_dwell_data.nil?
+          hash['include_dwell_data'] = include_dwell_data
+        end
+        unless include_video_data.nil?
+          hash['include_video_data'] = include_video_data
+        end
+        unless install_referrer.nil?
+          hash['install_referrer'] = install_referrer
+        end
+        unless installer_package.nil?
+          hash['installer_package'] = installer_package
+        end
+        unless url_schemes.nil?
+          hash['url_schemes'] = url_schemes
+        end
+        unless windows_attribution_id.nil?
+          hash['windows_attribution_id'] = windows_attribution_id
+        end
+
+        unless extinfo.nil?
+          hash['extinfo'] = extinfo.normalize
+        end
+        hash
+      end
+      end
+    end
+end

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

@@ -18,6 +18,7 @@
 
 require_relative './user_data'
 require_relative './custom_data'
+require_relative './app_data'
 
 module FacebookAds
   module ServerSide
@@ -52,6 +53,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 +71,10 @@ 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
+
       # @param [String] event_name
       # @param [int] event_time
       # @param [String] event_source_url
@@ -74,10 +82,12 @@ 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
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
@@ -85,10 +95,12 @@ 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)
 
         unless event_name.nil?
           self.event_name = event_name
@@ -111,6 +123,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 +138,9 @@ 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
       end
 
       # build the object using the input hash
@@ -161,6 +179,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 +198,10 @@ 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
       end
 
       # Show invalid properties with the reasons. Usually used together with valid?
@@ -217,10 +243,12 @@ 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
       end
 
       # @see the `==` method
@@ -232,9 +260,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,
         ].hash
       end
 
@@ -261,6 +289,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 +304,9 @@ 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
         hash.to_s
       end
 
@@ -301,6 +335,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 +353,9 @@ module FacebookAds
             'action_source'
           )
         end
+        unless advanced_measurement_table.nil?
+          hash['advanced_measurement_table'] = advanced_measurement_table
+        end
         hash
       end
 

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

@@ -51,6 +51,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 +65,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 +94,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 +160,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(