facebookbusiness 0.6.0.3 → 0.7.0.3

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

@@ -69,7 +69,11 @@ module FacebookAds
       # Use only with Search events. A search query made by a user.
       # Example: 'lettuce'.
       attr_accessor :search_string
-      
+
+      # The item number.
+      # Example: 'item1234'.
+      attr_accessor :item_number
+
       # Custom Properties bag for storing other custom fields
       attr_accessor :custom_properties
 
@@ -86,6 +90,7 @@ module FacebookAds
       # @param [Integer] num_items
       # @param [String] status
       # @param [String] search_string
+      # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
                      currency: nil,
@@ -99,6 +104,7 @@ module FacebookAds
                      num_items: nil,
                      status: nil,
                      search_string: nil,
+                     item_number: nil,
                      custom_properties: {})
 
         unless value.nil?
@@ -137,6 +143,9 @@ module FacebookAds
         unless search_string.nil?
           self.search_string = search_string
         end
+        unless item_number.nil?
+          self.item_number = item_number
+        end
         unless custom_properties.nil?
           self.custom_properties = custom_properties
         end
@@ -203,6 +212,10 @@ module FacebookAds
           self.search_string = attributes[:'search_string']
         end
 
+        if attributes.has_key?(:'item_number')
+          self.item_number = attributes[:'item_number']
+        end
+
         if attributes.has_key?(:'custom_properties')
           self.custom_properties = attributes[:'custom_properties']
         end
@@ -224,6 +237,7 @@ module FacebookAds
             num_items == o.num_items &&
             status == o.status &&
             search_string == o.search_string &&
+            item_number == o.item_number &&
             custom_properties == o.custom_properties
       end
 
@@ -248,6 +262,7 @@ module FacebookAds
             num_items,
             status,
             search_string,
+            item_number,
             custom_properties
         ].hash
       end
@@ -294,23 +309,23 @@ module FacebookAds
         end
         unless custom_properties.nil?
           hash['custom_properties'] = custom_properties
-        end        
+        end
         hash.to_s
       end
 
       # Add other custom fields to custom properties.
       def add_custom_property(key, value)
-        custom_properties[key] = value;        
+        custom_properties[key] = value;
       end
 
       # Normalize input fields to server request format.
-      def normalize        
+      def normalize
         hash = {}
         unless value.nil?
           hash['value'] = value
         end
         unless currency.nil?
-          hash['currency'] = FacebookAds::ServerSide::normalize(currency, 'currency')
+          hash['currency'] = FacebookAds::ServerSide::Util.normalize(currency, 'currency')
         end
         unless content_name.nil?
           hash['content_name'] = content_name
@@ -339,6 +354,9 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless item_number.nil?
+          hash['item_number'] = item_number
+        end
 
         unless contents.nil?
           content_array = []
@@ -348,7 +366,7 @@ module FacebookAds
           hash['contents'] = content_array
         end
 
-        hash.merge!(custom_properties) unless custom_properties.nil?        
+        hash.merge!(custom_properties) unless custom_properties.nil?
         hash
       end
     end

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

@@ -52,6 +52,17 @@ module FacebookAds
       # An Object that includes additional business data about the event.
       attr_accessor :custom_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
+
+      # A country that you want to associate to this data processing option
+      # For more details see https://developers.facebook.com/docs/marketing-apis/data-processing-options
+      attr_accessor :data_processing_options_country
+
+      # A state that you want to associate with this data processing option.
+      # For more details see https://developers.facebook.com/docs/marketing-apis/data-processing-options
+      attr_accessor :data_processing_options_state
 
       # @param [String] event_name
       # @param [int] event_time
@@ -60,13 +71,19 @@ module FacebookAds
       # @param [String] event_id
       # @param [FacebookAds::ServerSide::UserData] user_data
       # @param [FacebookAds::ServerSide::CustomData] custom_data
+      # @param [Array<String>] data_processing_options
+      # @param [int] data_processing_options_country
+      # @param [int] data_processing_options_state
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
                      opt_out: nil,
                      event_id: nil,
                      user_data: nil,
-                     custom_data: nil)
+                     custom_data: nil,
+                     data_processing_options: nil,
+                     data_processing_options_country: nil,
+                     data_processing_options_state: nil)
 
         unless event_name.nil?
           self.event_name = event_name
@@ -89,6 +106,15 @@ module FacebookAds
         unless custom_data.nil?
           self.custom_data = custom_data
         end
+        unless data_processing_options.nil?
+          self.data_processing_options = data_processing_options
+        end
+        unless data_processing_options_country.nil?
+          self.data_processing_options_country = data_processing_options_country
+        end
+        unless data_processing_options_state.nil?
+          self.data_processing_options_state = data_processing_options_state
+        end
       end
 
       # build the object using the input hash
@@ -126,6 +152,18 @@ module FacebookAds
         if attributes.has_key?(:'custom_data')
           self.custom_data = attributes[:'custom_data']
         end
+
+        if attributes.has_key?(:'data_processing_options')
+          self.custom_data = attributes[:'data_processing_options']
+        end
+
+        if attributes.has_key?(:'data_processing_options_country')
+          self.custom_data = attributes[:'data_processing_options_country']
+        end
+
+        if attributes.has_key?(:'data_processing_options_state')
+          self.custom_data = attributes[:'data_processing_options_state']
+        end
       end
 
       # Show invalid properties with the reasons. Usually used together with valid?
@@ -166,7 +204,10 @@ module FacebookAds
             opt_out == o.opt_out &&
             event_id == o.event_id &&
             user_data == o.user_data &&
-            custom_data == o.custom_data
+            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
       end
 
       # @see the `==` method
@@ -177,7 +218,7 @@ 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].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
       end
 
       def to_s
@@ -203,6 +244,15 @@ module FacebookAds
         unless custom_data.nil?
           hash['custom_data'] = custom_data.to_s
         end
+        unless data_processing_options.nil?
+          hash['data_processing_options'] = data_processing_options.to_s
+        end
+        unless data_processing_options_country.nil?
+          hash['data_processing_options_country'] = data_processing_options_country.to_s
+        end
+        unless data_processing_options_state.nil?
+          hash['data_processing_options_state'] = data_processing_options_state.to_s
+        end
         hash.to_s
       end
 
@@ -231,6 +281,15 @@ module FacebookAds
         unless custom_data.nil?
           hash['custom_data'] = custom_data.normalize
         end
+        unless data_processing_options.nil?
+          hash['data_processing_options'] = data_processing_options
+        end
+        unless data_processing_options_country.nil?
+          hash['data_processing_options_country'] = data_processing_options_country
+        end
+        unless data_processing_options_state.nil?
+          hash['data_processing_options_state'] = data_processing_options_state
+        end
         hash
       end
 

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

@@ -39,11 +39,28 @@ module FacebookAds
       # Platform from which the event is sent e.g. wordpress
       attr_accessor :partner_agent
 
+      # Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.
+      attr_accessor :namespace_id
+
+      # Unique id used to denote the current set being uploaded.
+      attr_accessor :upload_id
+
+      # Tag string added to track your Offline event uploads.
+      attr_accessor :upload_tag
+
+      # The origin/source of data for the dataset to be uploaded.
+      attr_accessor :upload_source
+
       # @param [String] pixel_id
       # @param [Array(FacebookAds::ServerSide::Event)] events
       # @param [String] test_event_code
       # @param [String] partner_agent
-      def initialize(pixel_id: nil, events: nil, test_event_code: nil, partner_agent: nil)
+      # @param [String] namespace_id
+      # @param [String] upload_id
+      # @param [String] upload_tag
+      # @param [String] upload_source
+      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)
         unless pixel_id.nil?
           self.pixel_id = pixel_id
         end
@@ -56,6 +73,18 @@ module FacebookAds
         unless partner_agent.nil?
           self.partner_agent = partner_agent
         end
+        unless namespace_id.nil?
+          self.namespace_id = namespace_id
+        end
+        unless upload_id.nil?
+          self.upload_id = upload_id
+        end
+        unless upload_tag.nil?
+          self.upload_tag = upload_tag
+        end
+        unless upload_source.nil?
+          self.upload_source = upload_source
+        end
       end
 
       # build the object using the input hash
@@ -83,6 +112,22 @@ module FacebookAds
         if attributes.has_key?(:'partner_agent')
           self.partner_agent = attributes[:'partner_agent']
         end
+
+        if attributes.has_key?(:'namespace_id')
+          self.namespace_id = attributes[:'namespace_id']
+        end
+
+        if attributes.has_key?(:'upload_id')
+          self.upload_id = attributes[:'upload_id']
+        end
+
+        if attributes.has_key?(:'upload_tag')
+          self.upload_tag = attributes[:'upload_tag']
+        end
+
+        if attributes.has_key?(:'upload_source')
+          self.upload_source = attributes[:'upload_source']
+        end
       end
 
       # Execute request
@@ -96,7 +141,11 @@ module FacebookAds
             {
                 data: normalized_events,
                 test_event_code: test_event_code,
-                partner_agent: partner_agent
+                partner_agent: partner_agent,
+                namespace_id: namespace_id,
+                upload_id: upload_id,
+                upload_tag: upload_tag,
+                upload_source: upload_source,
             }
         )
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
@@ -137,9 +186,14 @@ module FacebookAds
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
+            pixel_id == o.pixel_id &&
             events == o.events &&
-            test_event_code == o.test_event_code
-            partner_agent == o.partner_agent
+            test_event_code == o.test_event_code &&
+            partner_agent == o.partner_agent &&
+            namespace_id == o.namespace_id &&
+            upload_id == o.upload_id &&
+            upload_tag == o.upload_tag &&
+            upload_source == o.upload_source
       end
 
       # @see the `==` method
@@ -150,7 +204,16 @@ module FacebookAds
       # Calculates hash code according to all attributes.
       # @return [Fixnum] Hash code
       def hash
-        [events, test_event_code, partner_agent].hash
+        [
+          pixel_id,
+          events,
+          test_event_code,
+          partner_agent,
+          namespace_id,
+          upload_id,
+          upload_tag,
+          upload_source,
+        ].hash
       end
 
       def to_s
@@ -167,9 +230,20 @@ module FacebookAds
         unless partner_agent.nil?
           hash['partner_agent'] = partner_agent
         end
+        unless namespace_id.nil?
+          hash['namespace_id'] = namespace_id
+        end
+        unless upload_id.nil?
+          hash['upload_id'] = upload_id
+        end
+        unless upload_tag.nil?
+          hash['upload_tag'] = upload_tag
+        end
+        unless upload_source.nil?
+          hash['upload_source'] = upload_source
+        end
         hash.to_s
       end
     end
   end
 end
-

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

@@ -16,8 +16,6 @@
 # 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.
 
-require_relative 'util'
-
 module FacebookAds
   module ServerSide
 
@@ -93,6 +91,24 @@ module FacebookAds
       # The subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
       attr_accessor :subscription_id
 
+      # The first 5 letters of the first name.
+      attr_accessor :f5first
+
+      # The first 5 letters of the last name.
+      attr_accessor :f5last
+
+      # The first initial.
+      attr_accessor :fi
+
+      # The date of birth day.
+      attr_accessor :dobd
+
+      # The date of birth month.
+      attr_accessor :dobm
+
+      # THe date of birth year.
+      attr_accessor :doby
+
       #UserData is a set of identifiers Facebook can use for targeted attribution
       # @param [String] email
       # @param [String] phone
@@ -110,10 +126,17 @@ module FacebookAds
       # @param [String] fbc
       # @param [String] fbp
       # @param [String] subscription_id
+      # @param [String] f5first
+      # @param [String] f5last
+      # @param [String] fi
+      # @param [String] dobd
+      # @param [String] dobm
+      # @param [String] doby
       def initialize(email: nil, phone: nil, gender: nil, date_of_birth: nil,
                      last_name: nil, first_name: nil, city: nil, state: nil,
                      country_code: nil, zip_code: nil, external_id: nil, client_ip_address: nil,
-                     client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil)
+                     client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil,
+                     f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil)
         unless email.nil?
           self.email = email
         end
@@ -162,6 +185,24 @@ module FacebookAds
         unless subscription_id.nil?
           self.subscription_id = subscription_id
         end
+        unless f5first.nil?
+          self.f5first = f5first
+        end
+        unless f5last.nil?
+          self.f5last = f5last
+        end
+        unless fi.nil?
+          self.fi = fi
+        end
+        unless dobd.nil?
+          self.dobd = dobd
+        end
+        unless dobm.nil?
+          self.dobm = dobm
+        end
+        unless doby.nil?
+          self.doby = doby
+        end
       end
 
       # build the object using the input hash
@@ -232,8 +273,28 @@ module FacebookAds
           self.fbp = attributes[:'fbp']
         end
 
-        if attributes.has_key?(:'subscription_id')
-          self.subscription_id = attributes[:'subscription_id']
+        if attributes.has_key?(:'f5first')
+          self.f5first = attributes[:'f5first']
+        end
+
+        if attributes.has_key?(:'f5last')
+          self.f5last = attributes[:'f5last']
+        end
+
+        if attributes.has_key?(:'fi')
+          self.fi = attributes[:'fi']
+        end
+
+        if attributes.has_key?(:'dobd')
+          self.dobd = attributes[:'dobd']
+        end
+
+        if attributes.has_key?(:'dobm')
+          self.dobm = attributes[:'dobm']
+        end
+
+        if attributes.has_key?(:'doby')
+          self.doby = attributes[:'doby']
         end
       end
 
@@ -256,7 +317,13 @@ module FacebookAds
             client_user_agent == o.client_user_agent &&
             fbc == o.fbc &&
             fbp == o.fbp &&
-            subscription_id == o.subscription_id
+            subscription_id == o.subscription_id &&
+            f5first == o.f5first &&
+            f5last == o.f5last &&
+            fi == o.fi &&
+            dobd == o.dobd &&
+            dobm == o.dobm &&
+            doby == o.doby
       end
 
       # @see the `==` method
@@ -283,7 +350,13 @@ module FacebookAds
             client_user_agent,
             fbc,
             fbp,
-            subscription_id
+            subscription_id,
+            f5first,
+            f5last,
+            fi,
+            dobd,
+            dobm,
+            doby,
         ].hash
 
       end
@@ -328,6 +401,9 @@ module FacebookAds
         unless client_ip_address.nil?
           hash['client_ip_address'] = client_ip_address
         end
+        unless client_user_agent.nil?
+          hash['client_user_agent'] = client_user_agent
+        end
         unless fbc.nil?
           hash['fbc'] = fbc
         end
@@ -337,6 +413,24 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless f5first.nil?
+          hash['f5first'] = f5first
+        end
+        unless f5last.nil?
+          hash['f5last'] = f5last
+        end
+        unless fi.nil?
+          hash['fi'] = fi
+        end
+        unless dobd.nil?
+          hash['dobd'] = dobd
+        end
+        unless dobm.nil?
+          hash['dobm'] = dobm
+        end
+        unless doby.nil?
+          hash['doby'] = doby
+        end
         hash.to_s
       end
 
@@ -345,34 +439,34 @@ module FacebookAds
       def normalize
         hash = {}
         unless email.nil?
-          hash['em'] = FacebookAds::ServerSide::normalize(email, 'em')
+          hash['em'] = FacebookAds::ServerSide::Util.normalize(email, 'em')
         end
         unless phone.nil?
-          hash['ph'] = FacebookAds::ServerSide::normalize(phone, 'ph')
+          hash['ph'] = FacebookAds::ServerSide::Util.normalize(phone, 'ph')
         end
         unless gender.nil?
-          hash['ge'] = FacebookAds::ServerSide::normalize(gender, 'ge')
+          hash['ge'] = FacebookAds::ServerSide::Util.normalize(gender, 'ge')
         end
         unless date_of_birth.nil?
-          hash['db'] = FacebookAds::ServerSide::normalize(date_of_birth, 'db')
+          hash['db'] = FacebookAds::ServerSide::Util.normalize(date_of_birth, 'db')
         end
         unless last_name.nil?
-          hash['ln'] = FacebookAds::ServerSide::normalize(last_name, 'ln')
+          hash['ln'] = FacebookAds::ServerSide::Util.normalize(last_name, 'ln')
         end
         unless first_name.nil?
-          hash['fn'] = FacebookAds::ServerSide::normalize(first_name, 'fn')
+          hash['fn'] = FacebookAds::ServerSide::Util.normalize(first_name, 'fn')
         end
         unless city.nil?
-          hash['ct'] = FacebookAds::ServerSide::normalize(city, 'ct')
+          hash['ct'] = FacebookAds::ServerSide::Util.normalize(city, 'ct')
         end
         unless country_code.nil?
-          hash['country'] = FacebookAds::ServerSide::normalize(country_code, 'country')
+          hash['country'] = FacebookAds::ServerSide::Util.normalize(country_code, 'country')
         end
         unless state.nil?
-          hash['st'] = FacebookAds::ServerSide::normalize(state, 'st')
+          hash['st'] = FacebookAds::ServerSide::Util.normalize(state, 'st')
         end
         unless zip_code.nil?
-          hash['zp'] = FacebookAds::ServerSide::normalize(zip_code, 'zp')
+          hash['zp'] = FacebookAds::ServerSide::Util.normalize(zip_code, 'zp')
         end
         unless external_id.nil?
           hash['external_id'] = external_id
@@ -380,6 +474,9 @@ module FacebookAds
         unless client_ip_address.nil?
           hash['client_ip_address'] = client_ip_address
         end
+        unless client_user_agent.nil?
+          hash['client_user_agent'] = client_user_agent
+        end
         unless fbc.nil?
           hash['fbc'] = fbc
         end
@@ -389,6 +486,24 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless f5first.nil?
+          hash['f5first'] = FacebookAds::ServerSide::Util.normalize(f5first, 'f5first')
+        end
+        unless f5last.nil?
+          hash['f5last'] = FacebookAds::ServerSide::Util.normalize(f5last, 'f5last')
+        end
+        unless fi.nil?
+          hash['fi'] = FacebookAds::ServerSide::Util.normalize(fi, 'fi')
+        end
+        unless dobd.nil?
+          hash['dobd'] = FacebookAds::ServerSide::Util.normalize(dobd, 'dobd')
+        end
+        unless dobm.nil?
+          hash['dobm'] = FacebookAds::ServerSide::Util.normalize(dobm, 'dobm')
+        end
+        unless doby.nil?
+          hash['doby'] = FacebookAds::ServerSide::Util.normalize(doby, 'doby')
+        end
         hash
       end
     end