facebookbusiness 0.15.0.2 → 0.16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682be241264d4bfdfe536f57817964f9bf01077e446b85d1240c224036cfc5d4
-  data.tar.gz: 87bfe3812712820d50f68f399210bf11d9056a9ee0cabb96b0eae84da3b7728f
+  metadata.gz: ab556b892927ec0c49fe039c2f5d3583bb8a72d92424b73e431dd7f29ce357c9
+  data.tar.gz: d7a6d7ff350690498302d0e55238c42af4b7b36e6501b6826df20a91e7cac1d6
 SHA512:
-  metadata.gz: ecef88b246cd6eea373b1cdd272a7602a88bc22d133c561c11d628679523ff8e5317b3a26ef4f2b201626085417b7b1f2c00175da3306b7f6fab8ea7f1dfb938
-  data.tar.gz: '091c53d78cae3c71dc806bb87ccbc34cd50769b908a41547ebbfb18e92474fd4f7a97d5b03ee6ba4a136334ca95b82f14d037e5fc3f57aac81d7d98b9b177251'
+  metadata.gz: 0f66afb534cb6ca59e8785249ab986801df965ff845fb925b94173f628766c41a2d5d06259712dcc0035e4e2af5079fead24c49e3f70b492402938cc2ba102a7
+  data.tar.gz: aee3d13a547677556169948b09af6998356ecd51aa280d7d8c7a6e56d9191fd3961428c167ad82aca15a00ffdb3d0bee8db5e056ec3cff0d503d826a6dd015e7

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -137,6 +137,11 @@ module FacebookAds
       "WEBSITE",
     ]
 
+    ACTION_SOURCE = [
+      "PHYSICAL_STORE",
+      "WEBSITE",
+    ]
+
 
     field :account_id, 'string'
     field :account_status, 'int'
@@ -671,6 +676,12 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
     has_edge :campaigns do |edge|
       edge.delete do |api|
         api.has_param :before_date, 'datetime'

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -48,10 +48,12 @@ module FacebookAds
       "FRAGMENTATION",
       "LEARNING_LIMITED",
       "LOW_OUTCOME",
+      "MMT_CAROUSEL_TO_VIDEO",
       "MULTI_TEXT",
       "MUSIC",
       "PREDICTIVE_CREATIVE_LIMITED",
       "REVERT",
+      "SEMANTIC_BASED_AUDIENCE_EXPANSION",
       "SIGNALS_GROWTH_CAPI",
       "SYD_TEST_MODE",
       "TOP_ADSETS_WITH_ADS_UNDER_CAP",

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -194,6 +194,7 @@ module FacebookAds
     field :billing_event, { enum: -> { BILLING_EVENT }}
     field :budget_remaining, 'string'
     field :campaign, 'Campaign'
+    field :campaign_attribution, 'string'
     field :campaign_id, 'string'
     field :configured_status, { enum: -> { CONFIGURED_STATUS }}
     field :created_time, 'datetime'

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -32,6 +32,7 @@ module FacebookAds
       "ADS_AI_GENERATED",
       "AD_BREAK_PREVIEW",
       "AD_DERIVATIVE",
+      "AD_LIBRARY_WATERMARK",
       "AGE_UP",
       "ALBUM_MULTIMEDIA_POST",
       "ALOHA_CALL_VIDEO",
@@ -113,6 +114,7 @@ module FacebookAds
       "LEGACY_CONTAINED_POST_BROADCAST",
       "LIVE_AUDIO_ROOM_BROADCAST",
       "LIVE_CLIP_PREVIEW",
+      "LIVE_CLIP_WORKCHAT",
       "LIVE_CREATIVE_KIT_VIDEO",
       "LIVE_PHOTO",
       "LOOK_NOW_DEPRECATED",

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -69,21 +69,47 @@ module FacebookAds
     field :automatic_matching_fields, { list: 'string' }
     field :can_proxy, 'bool'
     field :code, 'string'
+    field :config, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
     field :data_use_setting, 'string'
+    field :description, 'string'
+    field :duplicate_entries, 'int'
+    field :enable_auto_assign_to_accounts, 'bool'
     field :enable_automatic_matching, 'bool'
+    field :event_stats, 'string'
+    field :event_time_max, 'int'
+    field :event_time_min, 'int'
     field :first_party_cookie_status, 'string'
     field :id, 'string'
+    field :is_consolidated_container, 'bool'
     field :is_created_by_business, 'bool'
     field :is_crm, 'bool'
+    field :is_mta_use, 'bool'
+    field :is_restricted_use, 'bool'
     field :is_unavailable, 'bool'
     field :last_fired_time, 'datetime'
+    field :last_upload_app, 'string'
+    field :last_upload_app_changed_time, 'int'
+    field :match_rate_approx, 'int'
+    field :matched_entries, 'int'
     field :name, 'string'
     field :owner_ad_account, 'AdAccount'
     field :owner_business, 'Business'
+    field :usage, 'OfflineConversionDataSetUsage'
+    field :valid_entries, 'int'
     has_no_delete
 
+    has_edge :adaccounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
+    has_edge :agencies do |edge|
+      edge.get 'Business'
+    end
+
     has_edge :assigned_users do |edge|
       edge.get 'AssignedUser' do |api|
         api.has_param :business, 'string'
@@ -119,6 +145,16 @@ module FacebookAds
       edge.post
     end
 
+    has_edge :offline_event_uploads do |edge|
+      edge.get 'OfflineConversionDataSetUpload' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :order, { enum: -> { OfflineConversionDataSetUpload::ORDER }}
+        api.has_param :sort_by, { enum: -> { OfflineConversionDataSetUpload::SORT_BY }}
+        api.has_param :start_time, 'datetime'
+        api.has_param :upload_tag, 'string'
+      end
+    end
+
     has_edge :shadowtraffichelper do |edge|
       edge.post
     end

data/lib/facebook_ads/ad_objects/business.rb

@@ -120,6 +120,11 @@ module FacebookAds
       "VIEW_MONETIZATION_INSIGHTS",
     ]
 
+    ACTION_SOURCE = [
+      "PHYSICAL_STORE",
+      "WEBSITE",
+    ]
+
 
     field :block_offline_analytics, 'bool'
     field :collaborative_ads_managed_partner_business_info, 'ManagedPartnerBusiness'
@@ -295,6 +300,10 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get
+    end
+
     has_edge :claim_custom_conversions do |edge|
       edge.post 'CustomConversion' do |api|
         api.has_param :custom_conversion_id, 'string'

data/lib/facebook_ads/ad_objects/event.rb

@@ -106,6 +106,7 @@ module FacebookAds
     field :owner, 'object'
     field :parent_group, 'Group'
     field :place, 'Place'
+    field :registration_setting, 'object'
     field :scheduled_publish_time, 'string'
     field :start_time, 'string'
     field :ticket_setting, 'object'

data/lib/facebook_ads/ad_objects/group.rb

@@ -163,14 +163,6 @@ module FacebookAds
       edge.get 'Event'
     end
 
-    has_edge :featured_cards do |edge|
-      edge.get
-      edge.post do |api|
-        api.has_param :description, 'hash'
-        api.has_param :title, 'hash'
-      end
-    end
-
     has_edge :feed do |edge|
       edge.get 'Post' do |api|
         api.has_param :include_hidden, 'bool'

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -117,6 +117,10 @@ module FacebookAds
       end
     end
 
+    has_edge :notification_message_tokens do |edge|
+      edge.get 'UserPageOneTimeOptInTokenSettings'
+    end
+
     has_edge :product_appeal do |edge|
       edge.get do |api|
         api.has_param :product_id, 'string'

data/lib/facebook_ads/ad_objects/lead.rb

@@ -42,6 +42,7 @@ module FacebookAds
     field :is_organic, 'bool'
     field :partner_name, 'string'
     field :platform, 'string'
+    field :post, 'Link'
     field :retailer_item_id, 'string'
     field :vehicle, 'Vehicle'
     has_no_post

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -41,25 +41,35 @@ module FacebookAds
     ]
 
 
+    field :automatic_matching_fields, { list: 'string' }
     field :business, 'Business'
+    field :can_proxy, 'bool'
     field :config, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
+    field :data_use_setting, 'string'
     field :description, 'string'
     field :duplicate_entries, 'int'
     field :enable_auto_assign_to_accounts, 'bool'
+    field :enable_automatic_matching, 'bool'
     field :event_stats, 'string'
     field :event_time_max, 'int'
     field :event_time_min, 'int'
+    field :first_party_cookie_status, 'string'
     field :id, 'string'
+    field :is_consolidated_container, 'bool'
+    field :is_created_by_business, 'bool'
+    field :is_crm, 'bool'
     field :is_mta_use, 'bool'
     field :is_restricted_use, 'bool'
     field :is_unavailable, 'bool'
+    field :last_fired_time, 'datetime'
     field :last_upload_app, 'string'
     field :last_upload_app_changed_time, 'int'
     field :match_rate_approx, 'int'
     field :matched_entries, 'int'
     field :name, 'string'
+    field :owner_ad_account, 'AdAccount'
     field :owner_business, 'Business'
     field :usage, 'OfflineConversionDataSetUsage'
     field :valid_entries, 'int'
@@ -110,6 +120,23 @@ module FacebookAds
       end
     end
 
+    has_edge :server_events_permitted_business do |edge|
+      edge.get 'Business'
+    end
+
+    has_edge :shared_accounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :action_source, { enum: -> { AdAccount::ACTION_SOURCE }}
+        api.has_param :business, 'string'
+      end
+    end
+
+    has_edge :shared_agencies do |edge|
+      edge.get 'Business' do |api|
+        api.has_param :action_source, { enum: -> { Business::ACTION_SOURCE }}
+      end
+    end
+
     has_edge :stats do |edge|
       edge.get do |api|
         api.has_param :aggr_time, { enum: %w{event_time upload_time }}

data/lib/facebook_ads/ad_objects/page.rb

@@ -617,6 +617,12 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
     has_edge :call_to_actions do |edge|
       edge.get 'PageCallToAction'
     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(

data/lib/facebook_ads/ad_objects/user.rb

@@ -99,6 +99,7 @@ module FacebookAds
       edge.delete
       edge.post 'User' do |api|
         api.has_param :business_app, 'int'
+        api.has_param :is_permanent_token, 'bool'
         api.has_param :page_id, 'string'
         api.has_param :scope, { list: 'Permission' }
       end
@@ -474,6 +475,7 @@ module FacebookAds
 
     has_edge :notifications do |edge|
       edge.post 'User' do |api|
+        api.has_param :bot_message_payload_elements, 'string'
         api.has_param :filtering, { list: { enum: -> { User::FILTERING }} }
         api.has_param :href, 'object'
         api.has_param :label, 'string'

data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb

@@ -28,6 +28,7 @@ module FacebookAds
   class UserPageOneTimeOptInTokenSettings < AdObject
 
     field :creation_timestamp, 'int'
+    field :next_eligible_time, 'int'
     field :notification_messages_frequency, 'string'
     field :notification_messages_reoptin, 'string'
     field :notification_messages_timezone, 'string'

data/lib/facebook_ads/ad_objects/vehicle.rb

@@ -137,7 +137,6 @@ module FacebookAds
     field :condition, 'string'
     field :currency, 'string'
     field :custom_label_0, 'string'
-    field :custom_number_0, 'int'
     field :date_first_on_lot, 'string'
     field :dealer_communication_channel, 'string'
     field :dealer_email, 'string'

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -30,17 +30,17 @@ module FacebookAds
       "DEVELOP",
       "FULL_CONTROL",
       "MANAGE",
+      "MANAGE_EXTENSIONS",
       "MANAGE_PHONE",
       "MANAGE_TEMPLATES",
-      "MANAGE_TEMPLATES_AND_PHONE",
       "MESSAGING",
       "VIEW_COST",
     ]
 
     CATEGORY = [
+      "AUTHENTICATION",
       "MARKETING",
-      "OTP",
-      "TRANSACTIONAL",
+      "UTILITY",
     ]
 
 

data/lib/facebook_ads/edge.rb

@@ -70,7 +70,7 @@ module FacebookAds
         end
 
         self.next_page_cursor = response.dig('paging', 'cursors', 'after')
-        self.has_next_page = !(response['data'].length < fetch_options[:limit])
+        self.has_next_page = !!response.dig('paging', 'next')
       end
     end
 

data/lib/facebook_ads/field_types/upload_file.rb

@@ -77,7 +77,7 @@ module FacebookAds
         case value
           when String, File, Tempfile
             if value.is_a?(String)
-              raise InvalidParameterError, "No such file: #{value}" unless File.exists?(value)
+              raise InvalidParameterError, "No such file: #{value}" unless File.exist?(value)
               value = File.new(value)
             end
 
@@ -114,7 +114,7 @@ module FacebookAds
           return true if value.is_a?(type)
         end
 
-        value.is_a?(String) ? File.exists?(value) : false
+        value.is_a?(String) ? File.exist?(value) : false
       end
     end
   end

data/lib/facebook_ads/test/config.rb

@@ -41,7 +41,7 @@ module FacebookAds
 
       def override_from!(filename = nil)
         filename ||= File.expand_path("../../../../tests/test_config.json", __FILE__)
-        if File.exists?(filename)
+        if File.exist?(filename)
           settings = JSON.parse(File.read(filename))
 
           settings.each do |k,v|
@@ -52,4 +52,4 @@ module FacebookAds
       end
     end
   end
-end
+end

data/lib/facebook_ads/version.rb

@@ -19,6 +19,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '0.15.0.2'
-  API_VERSION = '15.0'
+  VERSION = '0.16.0.0'
+  API_VERSION = '16.0'
 end

data/lib/facebook_ads/videos/video_io.rb

@@ -16,6 +16,8 @@
 # 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 'faraday/multipart'
+
 module FacebookAds
   class VideoIO < ::UploadIO
     def is_video?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 0.15.0.2
+  version: 0.16.0.0
 platform: ruby
 authors:
 - Facebook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -26,6 +26,20 @@ dependencies:
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -44,28 +58,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -220,34 +240,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.71'
-- !ruby/object:Gem::Dependency
-  name: countries
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: money
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.13'
 description: |2
     The official Facebook Business API SDK for Ruby.
     https://developers.facebook.com/docs/marketing-api/sdks'
@@ -745,9 +737,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="