facebookbusiness 21.0.0 → 22.0.0

data/lib/facebook_ads/ad_objects/fb_image_copyright_match.rb

@@ -20,6 +20,7 @@ module FacebookAds
     field :audit_log, { list: 'object' }
     field :available_ui_actions, { list: 'string' }
     field :expiration_days, 'int'
+    field :generic_match_data, { list: 'object' }
     field :id, 'string'
     field :is_business_page_match, 'bool'
     field :last_modified_time, 'datetime'

data/lib/facebook_ads/ad_objects/flight.rb

@@ -32,6 +32,16 @@ module FacebookAds
     field :applinks, 'CatalogItemAppLinks'
     field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
+    field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :custom_number_0, 'int'
+    field :custom_number_1, 'int'
+    field :custom_number_2, 'int'
+    field :custom_number_3, 'int'
+    field :custom_number_4, 'int'
     field :description, 'string'
     field :destination_airport, 'string'
     field :destination_city, 'string'
@@ -44,6 +54,11 @@ module FacebookAds
     field :origin_airport, 'string'
     field :origin_city, 'string'
     field :price, 'string'
+    field :product_priority_0, 'double'
+    field :product_priority_1, 'double'
+    field :product_priority_2, 'double'
+    field :product_priority_3, 'double'
+    field :product_priority_4, 'double'
     field :sanitized_images, { list: 'string' }
     field :tags, { list: 'string' }
     field :unit_price, 'object'

data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb

@@ -18,11 +18,13 @@ module FacebookAds
     field :amount, 'int'
     field :campaign_ids, { list: 'int' }
     field :coupon_id, 'string'
+    field :coupon_tiering, 'FundingSourceDetailsCouponTiering'
     field :currency, 'string'
     field :display_amount, 'string'
     field :expiration, 'datetime'
     field :original_amount, 'int'
     field :original_display_amount, 'string'
+    field :start_date, 'datetime'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/{analytics_cohort_query_result.rb → funding_source_details_coupon_tiering.rb}

@@ -13,12 +13,10 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class AnalyticsCohortQueryResult < AdObject
+  class FundingSourceDetailsCouponTiering < AdObject
 
-    field :data, 'object'
-    field :error, 'object'
-    field :query_id, 'string'
-    field :status, 'string'
+    field :coupon_tiering_new, 'object'
+    field :coupon_tiering_reactivation, 'object'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/group.rb

@@ -237,7 +237,6 @@ module FacebookAds
         api.has_param :text_format_metadata, 'string'
         api.has_param :text_format_preset_id, 'string'
         api.has_param :text_only_place, 'string'
-        api.has_param :throwback_camera_roll_media, 'string'
         api.has_param :thumbnail, 'file'
         api.has_param :time_since_original_post, 'int'
         api.has_param :title, 'string'
@@ -355,6 +354,7 @@ module FacebookAds
         api.has_param :place, 'object'
         api.has_param :privacy, 'string'
         api.has_param :profile_id, 'int'
+        api.has_param :provenance_info, 'hash'
         api.has_param :proxied_app_id, 'string'
         api.has_param :published, 'bool'
         api.has_param :qn, 'string'
@@ -442,7 +442,6 @@ module FacebookAds
         api.has_param :start_offset, 'int'
         api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
         api.has_param :text_format_metadata, 'string'
-        api.has_param :throwback_camera_roll_media, 'string'
         api.has_param :thumb, 'file'
         api.has_param :time_since_original_post, 'int'
         api.has_param :title, 'string'

data/lib/facebook_ads/ad_objects/home_listing.rb

@@ -44,6 +44,16 @@ module FacebookAds
     field :category_specific_fields, 'CatalogSubVerticalList'
     field :co_2_emission_rating_eu, 'object'
     field :currency, 'string'
+    field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :custom_number_0, 'int'
+    field :custom_number_1, 'int'
+    field :custom_number_2, 'int'
+    field :custom_number_3, 'int'
+    field :custom_number_4, 'int'
     field :days_on_market, 'int'
     field :description, 'string'
     field :energy_rating_eu, 'object'

data/lib/facebook_ads/ad_objects/hotel.rb

@@ -35,6 +35,16 @@ module FacebookAds
     field :category, 'string'
     field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
+    field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :custom_number_0, 'int'
+    field :custom_number_1, 'int'
+    field :custom_number_2, 'int'
+    field :custom_number_3, 'int'
+    field :custom_number_4, 'int'
     field :description, 'string'
     field :guest_ratings, 'string'
     field :hotel_id, 'string'

data/lib/facebook_ads/ad_objects/ig_comment.rb

@@ -18,6 +18,7 @@ module FacebookAds
     field :from, 'IgCommentFromUser'
     field :hidden, 'bool'
     field :id, 'string'
+    field :legacy_instagram_comment_id, 'string'
     field :like_count, 'int'
     field :media, 'IgMedia'
     field :parent_id, 'string'

data/lib/facebook_ads/ad_objects/ig_media.rb

@@ -23,6 +23,7 @@ module FacebookAds
     field :ig_id, 'string'
     field :is_comment_enabled, 'bool'
     field :is_shared_to_feed, 'bool'
+    field :legacy_instagram_media_id, 'string'
     field :like_count, 'int'
     field :media_product_type, 'string'
     field :media_type, 'string'

data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb

@@ -15,6 +15,7 @@ module FacebookAds
 
   class IgMediaForIgOnlyApi < AdObject
 
+    field :alt_text, 'string'
     field :caption, 'string'
     field :comments_count, 'int'
     field :id, 'string'

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -19,8 +19,11 @@ module FacebookAds
     field :business_discovery, 'IgUser'
     field :followers_count, 'int'
     field :follows_count, 'int'
+    field :has_profile_pic, 'bool'
     field :id, 'string'
     field :ig_id, 'int'
+    field :is_published, 'bool'
+    field :legacy_instagram_user_id, 'string'
     field :media_count, 'int'
     field :mentioned_comment, 'IgComment'
     field :mentioned_media, 'IgMedia'
@@ -34,6 +37,20 @@ module FacebookAds
     has_no_post
     has_no_delete
 
+    has_edge :agencies do |edge|
+      edge.get 'Business'
+    end
+
+    has_edge :authorized_adaccounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :business, 'string'
+      end
+      edge.post 'IgUser' do |api|
+        api.has_param :account_id, 'string'
+        api.has_param :business, 'string'
+      end
+    end
+
     has_edge :available_catalogs do |edge|
       edge.get 'UserAvailableCatalogs'
     end
@@ -113,6 +130,7 @@ module FacebookAds
         api.has_param :until, 'datetime'
       end
       edge.post 'IgMedia' do |api|
+        api.has_param :alt_text, 'string'
         api.has_param :audio_name, 'string'
         api.has_param :caption, 'string'
         api.has_param :children, { list: 'string' }
@@ -171,5 +189,15 @@ module FacebookAds
       edge.get 'IgMedia'
     end
 
+    has_edge :upcoming_events do |edge|
+      edge.get 'IgUpcomingEvent'
+      edge.post do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :notification_subtypes, { list: { enum: %w{AFTER_EVENT_1DAY AFTER_EVENT_2DAY AFTER_EVENT_3DAY AFTER_EVENT_4DAY AFTER_EVENT_5DAY AFTER_EVENT_6DAY AFTER_EVENT_7DAY BEFORE_EVENT_15MIN BEFORE_EVENT_1DAY BEFORE_EVENT_1HOUR BEFORE_EVENT_2DAY EVENT_START RESCHEDULED }} }
+        api.has_param :start_time, 'datetime'
+        api.has_param :title, 'string'
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb

@@ -44,6 +44,18 @@ module FacebookAds
       end
     end
 
+    has_edge :insights do |edge|
+      edge.get 'InsightsResult' do |api|
+        api.has_param :breakdown, { list: { enum: -> { InsightsResult::BREAKDOWN }} }
+        api.has_param :metric, { list: { enum: -> { InsightsResult::METRIC }} }
+        api.has_param :metric_type, { enum: -> { InsightsResult::METRIC_TYPE }}
+        api.has_param :period, { list: { enum: -> { InsightsResult::PERIOD }} }
+        api.has_param :since, 'datetime'
+        api.has_param :timeframe, { enum: -> { InsightsResult::TIMEFRAME }}
+        api.has_param :until, 'datetime'
+      end
+    end
+
     has_edge :live_media do |edge|
       edge.get
     end
@@ -54,6 +66,7 @@ module FacebookAds
         api.has_param :until, 'datetime'
       end
       edge.post do |api|
+        api.has_param :alt_text, 'string'
         api.has_param :audio_name, 'string'
         api.has_param :caption, 'string'
         api.has_param :children, { list: 'string' }
@@ -123,7 +136,7 @@ module FacebookAds
       edge.delete
       edge.get
       edge.post do |api|
-        api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights }} }
+        api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights story_reactions }} }
       end
     end
 

data/lib/facebook_ads/ad_objects/{instagram_video_metadata.rb → ig_user_subscribed_apps_data.rb}

@@ -13,11 +13,10 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class InstagramVideoMetadata < AdObject
+  class IgUserSubscribedAppsData < AdObject
 
-    field :duration, 'double'
-    field :height, 'double'
-    field :width, 'double'
+    field :app_id, 'string'
+    field :subscribed_fields, { list: 'string' }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/insights_result.rb

@@ -24,6 +24,7 @@ module FacebookAds
     METRIC = [
       "clips_replays_count",
       "comments",
+      "content_views",
       "follows",
       "ig_reels_aggregated_all_plays_count",
       "ig_reels_avg_watch_time",
@@ -43,6 +44,7 @@ module FacebookAds
       "shares",
       "thread_replies",
       "thread_shares",
+      "threads_views",
       "total_interactions",
       "video_views",
       "views",
@@ -80,6 +82,21 @@ module FacebookAds
       "yesterday",
     ]
 
+    METRIC_TYPE = [
+      "default",
+      "time_series",
+      "total_value",
+    ]
+
+    TIMEFRAME = [
+      "last_14_days",
+      "last_30_days",
+      "last_90_days",
+      "prev_month",
+      "this_month",
+      "this_week",
+    ]
+
 
     field :description, 'string'
     field :description_from_api_doc, 'string'

data/lib/facebook_ads/ad_objects/insights_value.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class InsightsValue < AdObject
 
     field :campaign_id, 'string'
+    field :earning_source, 'string'
     field :end_time, 'datetime'
     field :engagement_source, 'string'
     field :message_type, 'string'

data/lib/facebook_ads/ad_objects/instagram_carousel.rb

@@ -20,6 +20,7 @@ module FacebookAds
     field :content_type, 'int'
     field :display_url, 'string'
     field :id, 'string'
+    field :ig_media_id, 'string'
     field :like_count, 'int'
     field :owner_instagram_user, 'InstagramUser'
     field :permalink, 'string'
@@ -28,13 +29,5 @@ module FacebookAds
     has_no_post
     has_no_delete
 
-    has_edge :comments do |edge|
-      edge.get 'InstagramComment'
-      edge.post 'InstagramComment' do |api|
-        api.has_param :ad_id, 'string'
-        api.has_param :message, 'string'
-      end
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/instagram_comment.rb

@@ -18,19 +18,13 @@ module FacebookAds
     field :comment_type, 'string'
     field :created_at, 'datetime'
     field :id, 'string'
+    field :ig_comment_id, 'string'
     field :instagram_comment_id, 'string'
     field :instagram_user, 'InstagramUser'
     field :mentioned_instagram_users, { list: 'InstagramUser' }
     field :message, 'string'
     field :username, 'string'
-
-    has_edge :replies do |edge|
-      edge.get 'InstagramComment'
-      edge.post 'InstagramComment' do |api|
-        api.has_param :ad_id, 'string'
-        api.has_param :message, 'string'
-      end
-    end
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/instagram_insights_result.rb

@@ -31,18 +31,13 @@ module FacebookAds
       "impressions",
       "likes",
       "navigation",
-      "peak_concurrent_viewers",
       "plays",
       "profile_activity",
       "profile_visits",
-      "quotes",
       "reach",
       "replies",
-      "reposts",
       "saved",
       "shares",
-      "thread_replies",
-      "thread_shares",
       "total_interactions",
       "video_views",
       "views",

data/lib/facebook_ads/ad_objects/instagram_media.rb

@@ -21,6 +21,7 @@ module FacebookAds
     field :display_url, 'string'
     field :filter_name, 'string'
     field :id, 'string'
+    field :ig_media_id, 'string'
     field :latitude, 'double'
     field :like_count, 'int'
     field :location, 'Location'
@@ -33,13 +34,5 @@ module FacebookAds
     has_no_post
     has_no_delete
 
-    has_edge :comments do |edge|
-      edge.get 'InstagramComment'
-      edge.post 'InstagramComment' do |api|
-        api.has_param :ad_id, 'string'
-        api.has_param :message, 'string'
-      end
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/instagram_user.rb

@@ -19,6 +19,7 @@ module FacebookAds
     field :followed_by_count, 'int'
     field :has_profile_picture, 'bool'
     field :id, 'string'
+    field :ig_user_id, 'string'
     field :is_private, 'bool'
     field :is_published, 'bool'
     field :media_count, 'int'

data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb

@@ -17,6 +17,8 @@ module FacebookAds
 
     field :call_business_text, 'string'
     field :call_to_action_title, 'string'
+    field :chat_on_messenger_text, 'string'
+    field :chat_on_whatsapp_text, 'string'
     field :contact_information_text, 'string'
     field :creatives_overview_default_text, 'string'
     field :data_privacy_policy_setting_description, 'string'
@@ -46,6 +48,7 @@ module FacebookAds
     field :products_section_headers, { list: 'hash' }
     field :qualified_thank_you_card_transparency_info_text, 'string'
     field :redeem_promo_code_text, 'string'
+    field :return_to_facebook_text, 'string'
     field :review_your_info_text, 'string'
     field :secure_sharing_text, 'string'
     field :slide_to_submit_text, 'string'

data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → live_video_ad_campaign_config.rb}

@@ -13,11 +13,10 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class AdsDataPartner < AdObject
+  class LiveVideoAdCampaignConfig < AdObject
 
     field :id, 'string'
-    field :name, 'string'
-    field :rev_share_policies, { list: 'RevSharePolicy' }
+    field :live_video_ad_type, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/messenger_business_template.rb

@@ -14,6 +14,19 @@ module FacebookAds
   # pull request for this class.
 
   class MessengerBusinessTemplate < AdObject
+    STATUS = [
+      "APPROVED",
+      "ARCHIVED",
+      "DELETED",
+      "DISABLED",
+      "IN_APPEAL",
+      "LIMIT_EXCEEDED",
+      "PAUSED",
+      "PENDING",
+      "PENDING_DELETION",
+      "REJECTED",
+    ]
+
 
     field :category, 'string'
     field :components, { list: 'object' }
@@ -25,8 +38,9 @@ module FacebookAds
     field :library_template_name, 'string'
     field :name, 'string'
     field :rejected_reason, 'string'
+    field :rejection_reasons, 'object'
+    field :specific_rejection_reasons, 'object'
     field :status, 'string'
-    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/messenger_call_settings.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class MessengerCallSettings < AdObject
 
     field :audio_enabled, 'bool'
+    field :icon_enabled, 'bool'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/music_work_copyright.rb

@@ -21,7 +21,9 @@ module FacebookAds
     field :displayed_fb_matches_count, 'int'
     field :displayed_ig_matches_count, 'int'
     field :displayed_matches_count, 'int'
+    field :has_rev_share_eligible_isrcs, 'bool'
     field :id, 'string'
+    field :is_linking_required_to_monetize_for_manual_claim, 'bool'
     field :match_rule, 'VideoCopyrightRule'
     field :status, 'string'
     field :tags, { list: 'string' }

data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb

@@ -16,13 +16,18 @@ module FacebookAds
   class OpenBridgeConfiguration < AdObject
 
     field :active, 'bool'
+    field :cloud_provider, 'string'
+    field :cloud_region, 'string'
+    field :destination_id, 'string'
     field :endpoint, 'string'
     field :fallback_domain, 'string'
-    field :fallback_domain_enabled, 'bool'
+    field :first_party_domain, 'string'
     field :host_business_id, 'string'
-    field :host_external_id, 'string'
     field :id, 'string'
     field :instance_id, 'string'
+    field :instance_version, 'string'
+    field :is_sgw_instance, 'bool'
+    field :partner_name, 'string'
     field :pixel_id, 'string'
 
   end