facebookbusiness 0.7.0.3 → 0.10.0.0

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

@@ -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/event_request.rb

@@ -51,6 +51,9 @@ module FacebookAds
       # 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
@@ -59,8 +62,10 @@ module FacebookAds
       # @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)
+          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
@@ -85,6 +90,9 @@ module FacebookAds
         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
@@ -128,6 +136,10 @@ module FacebookAds
         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
@@ -135,19 +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,
-                namespace_id: namespace_id,
-                upload_id: upload_id,
-                upload_tag: upload_tag,
-                upload_source: upload_source,
-            }
-        )
+        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,
@@ -164,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::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
@@ -193,7 +238,8 @@ module FacebookAds
             namespace_id == o.namespace_id &&
             upload_id == o.upload_id &&
             upload_tag == o.upload_tag &&
-            upload_source == o.upload_source
+            upload_source == o.upload_source &&
+            http_service_client == o.http_service_client
       end
 
       # @see the `==` method
@@ -213,6 +259,7 @@ module FacebookAds
           upload_id,
           upload_tag,
           upload_source,
+          http_service_client,
         ].hash
       end
 

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

@@ -0,0 +1,43 @@
+# 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.
+
+require 'concurrent'
+
+module FacebookAds
+  module ServerSide
+    class EventRequestAsync < EventRequest
+      def execute
+        Concurrent::Promise.execute do
+          super
+        end
+      end
+
+      def clone_without_events
+        FacebookAds::ServerSide::EventRequestAsync.new(
+          pixel_id: pixel_id,
+          test_event_code: test_event_code,
+          partner_agent: partner_agent,
+          namespace_id: namespace_id,
+          upload_id: upload_id,
+          upload_tag: upload_tag,
+          upload_source: upload_source,
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# 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
+    class HttpMethod
+      POST = 'POST'
+      PUT = 'PUT'
+      GET = 'GET'
+      DELETE = 'DELETE'
+    end
+  end
+end

data/lib/facebook_ads/ad_objects/{page_about_story.rb → server_side/http_service_interface.rb}

@@ -16,24 +16,18 @@
 # 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.
 
-# FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-generated.
-
-  # For any issues or feature requests related to this class, please let us know
-  # on github and we'll fix in our codegen framework. We'll not be able to accept
-  # pull request for this class.
-
-  class PageAboutStory < AdObject
-
-    field :composed_text, { list: 'object' }
-    field :cover_photo, 'Photo'
-    field :entity_map, { list: 'object' }
-    field :id, 'string'
-    field :is_published, 'bool'
-    field :page_id, 'string'
-    field :title, 'string'
+  module ServerSide
+    class HttpServiceInterface
 
+      # String url            | The graph API endpoint that will be requested
+      # String request_method | The HTTP request method
+      # Hash headers          | Contains HTTP request headers including User-Agent and Accept-Encoding
+      # Hash params           | Contains request parameters including access_token, data, test_event_code, etc.
+      def execute(url, request_method, headers, params)
+        raise Exception.new("Method 'execute' not implemented")
+      end
+    end
   end
 end

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

@@ -0,0 +1,31 @@
+# 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
+        class HttpUtil
+            def self.appsecret_proof(app_secret, access_token)
+                OpenSSL::HMAC.hexdigest(
+                    OpenSSL::Digest.new('sha256'),
+                    app_secret,
+                    access_token
+                )
+            end
+        end
+    end
+end

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

@@ -91,6 +91,9 @@ 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 lead ID for the user in this transaction. This ID is associated with a lead generated by Facebook's Lead Ads.
+      attr_accessor :lead_id
+
       # The first 5 letters of the first name.
       attr_accessor :f5first
 
@@ -126,6 +129,7 @@ module FacebookAds
       # @param [String] fbc
       # @param [String] fbp
       # @param [String] subscription_id
+      # @param [String] lead_id
       # @param [String] f5first
       # @param [String] f5last
       # @param [String] fi
@@ -135,7 +139,7 @@ module FacebookAds
       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, lead_id: nil,
                      f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil)
         unless email.nil?
           self.email = email
@@ -185,6 +189,9 @@ module FacebookAds
         unless subscription_id.nil?
           self.subscription_id = subscription_id
         end
+        unless lead_id.nil?
+          self.lead_id = lead_id
+        end
         unless f5first.nil?
           self.f5first = f5first
         end
@@ -273,6 +280,10 @@ module FacebookAds
           self.fbp = attributes[:'fbp']
         end
 
+        if attributes.has_key?(:'lead_id')
+          self.lead_id = attributes[:'lead_id']
+        end
+
         if attributes.has_key?(:'f5first')
           self.f5first = attributes[:'f5first']
         end
@@ -318,6 +329,7 @@ module FacebookAds
             fbc == o.fbc &&
             fbp == o.fbp &&
             subscription_id == o.subscription_id &&
+            lead_id == o.lead_id &&
             f5first == o.f5first &&
             f5last == o.f5last &&
             fi == o.fi &&
@@ -351,6 +363,7 @@ module FacebookAds
             fbc,
             fbp,
             subscription_id,
+            lead_id,
             f5first,
             f5last,
             fi,
@@ -413,6 +426,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = f5first
         end
@@ -486,6 +502,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = FacebookAds::ServerSide::Util.normalize(f5first, 'f5first')
         end