facebookbusiness 0.9.0.0 → 0.9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b65eb9667af0fc7eb2f9c86e67515d083b436660bfea5b637e5cebc22fc5ab7e
-  data.tar.gz: 295bb79900331447bac7cc4f555203e0dd8660b4f22360b74c1f9dafec4390de
+  metadata.gz: 37ca4f8749f72bc1cd7eba12b4bcd07c4d4621e95efd3f028e21982037c378e7
+  data.tar.gz: e532f62cf2f842d6a18bc3916aa07bd3799fa4ca2979df9ea3e8362168893cb9
 SHA512:
-  metadata.gz: cb658bda72e696aab26910d5d7a8ec2bae62c0bc0f7d9a0c1c9c4991b53cdc66dd5026b6e5301d46409a2d2edba7eefe30dbb32433adf4925a7131bb988db580
-  data.tar.gz: 9f4f715f3162cb914650677fe17b661717b66393e3804d0fb89a233bf4451e65aa09109086e28fa1bd0b0c158525d1452fb7ebdb3e73f069e41f91aa7e4078e6
+  metadata.gz: 7fb8c27d58ddd9e18a5304adb7ce70031e3e5d1c8c0c3c0d8f09dbf1cd84a6e8a33ea45e2d9c8bc5191bc2fe4b389ecaab36b090855252cbe3e2b95bc66256ac
+  data.tar.gz: 3985f549327ac4d822b6614f6555815f0586ebfae93d2657c42919bf4a04ccd11d5eed5040491b436bee186cf279d76af96f87b2e3618349ecf0ba39ec5c7210

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

@@ -0,0 +1,48 @@
+# 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
+		ActionSource = Set[
+
+			# Conversion happened over email.
+			'email',
+
+			# Conversion was made on your website.
+			'website',
+
+			# Conversion was made using your app.
+			'app',
+
+			# Conversion was made over the phone.
+			'phone_call',
+
+			# Conversion was made via a messaging app, SMS, or online messaging feature.
+			'chat',
+
+			# Conversion was made in person at your physical store.
+			'physical_store',
+
+			# Conversion happened automatically, for example, a subscription renewal that's set on auto-pay each month.
+			'system_generated',
+
+			# Conversion happened in a way that is not listed.
+			'other'
+		]
+	end
+end

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

@@ -64,6 +64,9 @@ module FacebookAds
       # For more details see https://developers.facebook.com/docs/marketing-apis/data-processing-options
       attr_accessor :data_processing_options_state
 
+      # Where the conversion occurred.
+      attr_accessor :action_source
+
       # @param [String] event_name
       # @param [int] event_time
       # @param [String] event_source_url
@@ -74,6 +77,7 @@ module FacebookAds
       # @param [Array<String>] data_processing_options
       # @param [int] data_processing_options_country
       # @param [int] data_processing_options_state
+      # @param String action_source
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
@@ -83,7 +87,8 @@ module FacebookAds
                      custom_data: nil,
                      data_processing_options: nil,
                      data_processing_options_country: nil,
-                     data_processing_options_state: nil)
+                     data_processing_options_state: nil,
+                     action_source: nil)
 
         unless event_name.nil?
           self.event_name = event_name
@@ -115,6 +120,9 @@ module FacebookAds
         unless data_processing_options_state.nil?
           self.data_processing_options_state = data_processing_options_state
         end
+        unless action_source.nil?
+          self.action_source = action_source
+        end
       end
 
       # build the object using the input hash
@@ -154,15 +162,19 @@ module FacebookAds
         end
 
         if attributes.has_key?(:'data_processing_options')
-          self.custom_data = attributes[:'data_processing_options']
+          self.data_processing_options = attributes[:'data_processing_options']
         end
 
         if attributes.has_key?(:'data_processing_options_country')
-          self.custom_data = attributes[:'data_processing_options_country']
+          self.data_processing_options_country = attributes[:'data_processing_options_country']
         end
 
         if attributes.has_key?(:'data_processing_options_state')
-          self.custom_data = attributes[:'data_processing_options_state']
+          self.data_processing_options_state = attributes[:'data_processing_options_state']
+        end
+
+        if attributes.has_key?(:'action_source')
+          self.action_source = attributes[:'action_source']
         end
       end
 
@@ -207,7 +219,8 @@ module FacebookAds
             custom_data == o.custom_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
+            data_processing_options_state == o.data_processing_options_state &&
+            action_source == o.action_source
       end
 
       # @see the `==` method
@@ -218,7 +231,11 @@ module FacebookAds
       # Calculates hash code according to all attributes.
       # @return [Fixnum] Hash code
       def hash
-        [event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data, data_processing_options, data_processing_options_country, data_processing_options_state].hash
+        [
+          event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data,
+          data_processing_options, data_processing_options_country, data_processing_options_state,
+          action_source,
+        ].hash
       end
 
       def to_s
@@ -253,6 +270,9 @@ module FacebookAds
         unless data_processing_options_state.nil?
           hash['data_processing_options_state'] = data_processing_options_state.to_s
         end
+        unless action_source.nil?
+          hash['action_source'] = action_source
+        end
         hash.to_s
       end
 
@@ -290,6 +310,12 @@ module FacebookAds
         unless data_processing_options_state.nil?
           hash['data_processing_options_state'] = data_processing_options_state
         end
+        unless action_source.nil?
+          hash['action_source'] = FacebookAds::ServerSide::Util.normalize(
+            action_source,
+            'action_source'
+          )
+        end
         hash
       end
 

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

@@ -52,6 +52,8 @@ module FacebookAds
 				normalized_input = input;
 
 				case field_type
+				when 'action_source'
+					return normalize_action_source input
 				when 'country'
 					normalized_input = normalize_country input
 				when 'ct'
@@ -290,6 +292,17 @@ module FacebookAds
 				delivery_category;
 			end
 
+			# Normalizes the input action_source and returns valid value (or throw exception if invalid).
+			def self.normalize_action_source(action_source)
+				unless FacebookAds::ServerSide::ActionSource.include?(action_source)
+					values = FacebookAds::ServerSide::ActionSource.to_a.join(',')
+					raise ArgumentError.new(
+						"Invalid action_source passed: #{action_source}. Please use one of the defined values: #{values}"
+					)
+				end
+
+				action_source
+			end
 		end
 	end
 end

data/lib/facebook_ads/version.rb

@@ -19,6 +19,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '0.9.0.0'
+  VERSION = '0.9.0.1'
   API_VERSION = '9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 0.9.0.0
+  version: 0.9.0.1
 platform: ruby
 authors:
 - Facebook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -609,6 +609,7 @@ files:
 - lib/facebook_ads/ad_objects/saved_audience.rb
 - lib/facebook_ads/ad_objects/saved_message_response.rb
 - lib/facebook_ads/ad_objects/security_settings.rb
+- lib/facebook_ads/ad_objects/server_side/action_source.rb
 - lib/facebook_ads/ad_objects/server_side/batch_processor.rb
 - lib/facebook_ads/ad_objects/server_side/content.rb
 - lib/facebook_ads/ad_objects/server_side/custom_data.rb
@@ -735,7 +736,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Facebook Business API SDK for Ruby (Official)