facebookbusiness 0.7.0.1 → 0.8.0.3

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

@@ -22,20 +22,23 @@ module FacebookAds
     # Content object contains information about the products.
     class Content
 
-      # Product Id
-      attr_accessor :product_id
-
-      # number of product
-      attr_accessor :quantity
-
-      # Item Price.
-      attr_accessor :item_price
+      attr_accessor :product_id,
+                    :quantity,
+                    :item_price,
+                    :title,
+                    :description,
+                    :brand,
+                    :category
 
       # Initializes the object
       # @param [String] product_id
       # @param [Integer] quantity
       # @param [Float] item_price
-      def initialize(product_id: nil, quantity: nil, item_price: nil)
+      # @param [String] title
+      # @param [String] description
+      # @param [String] brand
+      # @param [String] category
+      def initialize(product_id: nil, quantity: nil, item_price: nil, title: nil, description: nil, brand: nil, category: nil)
         unless product_id.nil?
           self.product_id = String(product_id)
         end
@@ -45,6 +48,18 @@ module FacebookAds
         unless item_price.nil?
           self.item_price = Float(item_price)
         end
+        unless title.nil?
+          self.title = String(title)
+        end
+        unless description.nil?
+          self.description = String(description)
+        end
+        unless brand.nil?
+          self.brand = String(brand)
+        end
+        unless category.nil?
+          self.category = String(category)
+        end
       end
 
       # build the object using the input hash
@@ -66,15 +81,34 @@ module FacebookAds
         if attributes.has_key?(:'item_price')
           self.item_price = attributes[:'item_price']
         end
+
+        if attributes.has_key?(:'title')
+          self.title = attributes[:'title']
+        end
+
+        if attributes.has_key?(:'description')
+          self.description = attributes[:'description']
+        end
+
+        if attributes.has_key?(:'brand')
+          self.brand = attributes[:'brand']
+        end
+
+        if attributes.has_key?(:'category')
+          self.category = attributes[:'category']
+        end
       end
 
       # Checks equality by comparing each attribute.
       def ==(o)
-        return true if self.equal?(o)
-        self.class == o.class &&
+        return self.class == o.class &&
             product_id == o.product_id &&
             quantity == o.quantity &&
-            item_price == o.item_price
+            item_price == o.item_price &&
+            title == o.title &&
+            description == o.description &&
+            brand == o.brand &&
+            category == o.category
       end
 
       # @see the `==` method
@@ -88,7 +122,11 @@ module FacebookAds
         [
             product_id,
             quantity,
-            item_price
+            item_price,
+            title,
+            description,
+            brand,
+            category
         ].hash
       end
 
@@ -106,6 +144,18 @@ module FacebookAds
         unless item_price.nil?
           hash['item_price'] = item_price
         end
+        unless title.nil?
+          hash['title'] = title
+        end
+        unless description.nil?
+          hash['description'] = description
+        end
+        unless brand.nil?
+          hash['brand'] = brand
+        end
+        unless category.nil?
+          hash['category'] = category
+        end
         hash.to_s
       end
 
@@ -121,6 +171,18 @@ module FacebookAds
         unless item_price.nil?
           hash['item_price'] = item_price
         end
+        unless title.nil?
+          hash['title'] = title
+        end
+        unless description.nil?
+          hash['description'] = description
+        end
+        unless brand.nil?
+          hash['brand'] = brand
+        end
+        unless category.nil?
+          hash['category'] = category
+        end
         hash
       end
     end

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

@@ -69,7 +69,15 @@ module FacebookAds
       # Use only with Search events. A search query made by a user.
       # Example: 'lettuce'.
       attr_accessor :search_string
-      
+
+      # Type of delivery for a purchase event
+      # Example: 'home_delivery'.
+      attr_accessor :delivery_category
+
+      # The item number.
+      # Example: 'item1234'.
+      attr_accessor :item_number
+
       # Custom Properties bag for storing other custom fields
       attr_accessor :custom_properties
 
@@ -86,6 +94,8 @@ module FacebookAds
       # @param [Integer] num_items
       # @param [String] status
       # @param [String] search_string
+      # @param [String] delivery_category
+      # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
                      currency: nil,
@@ -99,6 +109,8 @@ module FacebookAds
                      num_items: nil,
                      status: nil,
                      search_string: nil,
+                     delivery_category: nil,
+                     item_number: nil,
                      custom_properties: {})
 
         unless value.nil?
@@ -137,6 +149,12 @@ module FacebookAds
         unless search_string.nil?
           self.search_string = search_string
         end
+        unless delivery_category.nil?
+          self.delivery_category = delivery_category
+        end
+        unless item_number.nil?
+          self.item_number = item_number
+        end
         unless custom_properties.nil?
           self.custom_properties = custom_properties
         end
@@ -203,6 +221,14 @@ module FacebookAds
           self.search_string = attributes[:'search_string']
         end
 
+        if attributes.has_key?(:'delivery_category')
+          self.delivery_category = attributes[:'delivery_category']
+        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 +250,8 @@ module FacebookAds
             num_items == o.num_items &&
             status == o.status &&
             search_string == o.search_string &&
+            delivery_category == o.delivery_category &&
+            item_number == o.item_number &&
             custom_properties == o.custom_properties
       end
 
@@ -248,6 +276,8 @@ module FacebookAds
             num_items,
             status,
             search_string,
+            delivery_category,
+            item_number,
             custom_properties
         ].hash
       end
@@ -292,25 +322,28 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = delivery_category
+        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 +372,12 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = FacebookAds::ServerSide::Util.normalize(delivery_category, 'delivery_category')
+        end
+        unless item_number.nil?
+          hash['item_number'] = item_number
+        end
 
         unless contents.nil?
           content_array = []
@@ -348,7 +387,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/delivery_category.rb

@@ -0,0 +1,33 @@
+# 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
+		DeliveryCategory = Set[
+
+			# Customer needs to enter the store to get the purchased product.
+			'in_store',
+
+			# Customer picks up their order by driving to a store and waiting inside their vehicle.
+			'curbside',
+
+			# Purchase is delivered to the customer's home.
+			'home_delivery'
+		]
+	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,33 @@ 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
+
+      # The HttpServiceInterface client to use for executing the request.
+      attr_accessor :http_service_client
+
       # @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
+      # @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)
         unless pixel_id.nil?
           self.pixel_id = pixel_id
         end
@@ -56,6 +78,21 @@ 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
+        unless http_service_client.nil?
+          self.http_service_client = http_service_client
+        end
       end
 
       # build the object using the input hash
@@ -83,6 +120,26 @@ 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
+
+        if attributes.has_key?(:'http_service_client')
+          self.http_service_client = attributes[:'http_service_client']
+        end
       end
 
       # Execute request
@@ -90,15 +147,14 @@ module FacebookAds
         unless valid?
           raise list_invalid_properties
         end
-        normalized_events = normalize
+
+        if http_service_client
+          return execute_with_client(http_service_client)
+        end
+        params = get_params()
+        params[:data] = normalize
         ads_pixel = FacebookAds::AdsPixel.get(pixel_id)
-        response = ads_pixel.events.create(
-            {
-                data: normalized_events,
-                test_event_code: test_event_code,
-                partner_agent: partner_agent
-            }
-        )
+        response = ads_pixel.events.create(params)
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
         FacebookAds::ServerSide::EventResponse.new(
             events_received: json_response_object.events_received,
@@ -115,6 +171,44 @@ module FacebookAds
         normalized_events
       end
 
+      def get_params
+        params = {}
+        params[:test_event_code] = test_event_code unless test_event_code.nil?
+        params[:partner_agent] = partner_agent unless partner_agent.nil?
+        params[:namespace_id] = namespace_id unless namespace_id.nil?
+        params[:upload_id] = upload_id unless upload_id.nil?
+        params[:upload_tag] = upload_tag unless upload_tag.nil?
+        params[:upload_source] = upload_source unless upload_source.nil?
+        params
+      end
+
+      def execute_with_client http_client
+        url = [
+          "https://#{FacebookAds::DEFAULT_HOST}",
+          FacebookAds::DEFAULT_API_VERSION,
+          pixel_id,
+          'events',
+        ].join('/')
+        headers = {
+          'User-Agent' => "fbbizsdk-ruby-v#{FacebookAds::API_VERSION}"
+        }
+        params = get_params
+        params[:data] = events.map(&:normalize)
+        appsecret = FacebookAds.config.app_secret
+        access_token = FacebookAds.config.access_token
+        params[:access_token] = access_token
+        if appsecret
+          params[:appsecret_proof] = FacebookAds::ServerSide::HttpUtil.appsecret_proof(appsecret, access_token)
+        end
+
+        http_client.execute(
+          url,
+          FacebookAds::ServerSide::HttpMethod::POST,
+          headers,
+          params
+        )
+      end
+
       # Show invalid properties with the reasons. Usually used together with valid?
       # @return Array for valid properties with the reasons
       def list_invalid_properties
@@ -137,9 +231,15 @@ 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 &&
+            http_service_client == o.http_service_client
       end
 
       # @see the `==` method
@@ -150,7 +250,17 @@ 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,
+          http_service_client,
+        ].hash
       end
 
       def to_s
@@ -167,9 +277,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
-