facebookbusiness 0.10.0.0 → 0.12.0.1

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -31,11 +31,17 @@ module FacebookAds
       "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
       "AUDIENCE_NETWORK_OUTSTREAM_VIDEO",
       "AUDIENCE_NETWORK_REWARDED_VIDEO",
+      "BIZ_DISCO_FEED_MOBILE",
       "DESKTOP_FEED_STANDARD",
+      "FACEBOOK_REELS_BANNER",
+      "FACEBOOK_REELS_MOBILE",
+      "FACEBOOK_REELS_STICKER",
       "FACEBOOK_STORY_MOBILE",
+      "FACEBOOK_STORY_STICKER_MOBILE",
       "INSTAGRAM_EXPLORE_CONTEXTUAL",
       "INSTAGRAM_EXPLORE_IMMERSIVE",
       "INSTAGRAM_REELS",
+      "INSTAGRAM_SHOP",
       "INSTAGRAM_STANDARD",
       "INSTAGRAM_STORY",
       "INSTANT_ARTICLE_RECIRCULATION_AD",

data/lib/facebook_ads/ad_objects/ad_rule.rb

@@ -30,6 +30,33 @@ module FacebookAds
       "DELETED",
       "DISABLED",
       "ENABLED",
+      "HAS_ISSUES",
+    ]
+
+    UI_CREATION_SOURCE = [
+      "AM_ACCOUNT_OVERVIEW_RECOMMENDATIONS",
+      "AM_ACTIVITY_HISTORY_TABLE",
+      "AM_AD_OBJECT_NAME_CARD",
+      "AM_AMFE_L3_RECOMMENDATION",
+      "AM_EDITOR_CARD",
+      "AM_INFO_CARD",
+      "AM_MID_FLIGHT_RESOLUTION_CARD",
+      "AM_NAME_CELL_DROPDOWN",
+      "AM_PERFORMANCE_SUMMARY",
+      "AM_RULE_LANDING_PAGE_BANNER",
+      "AM_TOOLBAR_CREATE_RULE_DROPDOWN",
+      "PE_CAMPAIGN_STRUCTURE_MENU",
+      "PE_EDITOR_CARD",
+      "PE_INFO_CARD",
+      "PE_TOOLBAR_CREATE_RULE_DROPDOWN",
+      "RULES_MANAGEMENT_PAGE_ACTION_DROPDOWN",
+      "RULES_MANAGEMENT_PAGE_RULE_GROUP",
+      "RULES_MANAGEMENT_PAGE_RULE_NAME",
+      "RULES_MANAGEMENT_PAGE_TOP_NAV",
+      "RULES_VIEW_ACTIVE_RULES_DIALOG",
+      "RULE_CREATION_SUCCESS_DIALOG",
+      "RULE_SYD_REDIRECT",
+      "RULE_TEMPLATES_DIALOG",
     ]
 
 
@@ -43,6 +70,7 @@ module FacebookAds
     field :schedule_spec, 'AdRuleScheduleSpec'
     field :status, 'string'
     field :updated_time, 'datetime'
+    field :ui_creation_source, { enum: -> { UI_CREATION_SOURCE }}
 
     has_edge :execute do |edge|
       edge.post

data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb

@@ -29,6 +29,7 @@ module FacebookAds
     EXECUTION_TYPE = [
       "ADD_INTEREST_RELAXATION",
       "ADD_QUESTIONNAIRE_INTERESTS",
+      "AUDIENCE_CONSOLIDATION",
       "CHANGE_BID",
       "CHANGE_BUDGET",
       "CHANGE_CAMPAIGN_BUDGET",
@@ -40,13 +41,14 @@ module FacebookAds
       "ROTATE",
       "UNPAUSE",
       "UPDATE_CREATIVE",
+      "UPDATE_LAX_BUDGET",
+      "UPDATE_LAX_DURATION",
     ]
 
 
     field :execution_options, { list: 'AdRuleExecutionOptions' }
     field :execution_type, { enum: -> { EXECUTION_TYPE }}
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -65,10 +65,9 @@ module FacebookAds
 
     OPTIMIZATION_GOAL = [
       "AD_RECALL_LIFT",
-      "APP_DOWNLOADS",
       "APP_INSTALLS",
-      "BRAND_AWARENESS",
-      "CLICKS",
+      "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
+      "CONVERSATIONS",
       "DERIVED_EVENTS",
       "ENGAGED_USERS",
       "EVENT_RESPONSES",
@@ -77,18 +76,13 @@ module FacebookAds
       "LEAD_GENERATION",
       "LINK_CLICKS",
       "NONE",
-      "OFFER_CLAIMS",
       "OFFSITE_CONVERSIONS",
-      "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
       "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
-      "REPLIES",
-      "SOCIAL_IMPRESSIONS",
       "THRUPLAY",
-      "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
       "VISIT_INSTAGRAM_PROFILE",
     ]
@@ -168,6 +162,7 @@ module FacebookAds
       "HOUSING",
       "ISSUES_ELECTIONS_POLITICS",
       "NONE",
+      "ONLINE_GAMBLING_AND_GAMING",
     ]
 
     OPERATOR = [
@@ -205,6 +200,7 @@ module FacebookAds
     field :destination_type, 'string'
     field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
     field :end_time, 'datetime'
+    field :existing_customer_budget_percentage, 'int'
     field :frequency_control_specs, { list: 'AdCampaignFrequencyControlSpecs' }
     field :full_funnel_exploration_mode, 'string'
     field :id, 'string'
@@ -231,6 +227,7 @@ module FacebookAds
     field :start_time, 'datetime'
     field :status, { enum: -> { STATUS }}
     field :targeting, 'Targeting'
+    field :targeting_optimization_types, 'hash'
     field :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
     field :time_based_ad_rotation_intervals, { list: 'int' }
     field :updated_time, 'datetime'

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -30,7 +30,6 @@ module FacebookAds
       "CONTINUOUS_LIFT_CONFIG",
       "GEO_LIFT",
       "LIFT",
-      "PRIVATE_LIFT",
       "SPLIT_TEST",
     ]
 
@@ -60,6 +59,13 @@ module FacebookAds
       edge.get 'AdStudyCell'
     end
 
+    has_edge :instances do |edge|
+      edge.get 'PrivateLiftStudyInstance'
+      edge.post 'PrivateLiftStudyInstance' do |api|
+        api.has_param :breakdown_key, 'hash'
+      end
+    end
+
     has_edge :objectives do |edge|
       edge.get 'AdStudyObjective'
     end

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -29,9 +29,11 @@ module FacebookAds
     TYPE = [
       "BRAND",
       "BRANDLIFT",
+      "CONVERSIONS",
       "FTL",
       "MAE",
       "MAI",
+      "MPC_CONVERSION",
       "NONSALES",
       "PARTNER",
       "SALES",
@@ -47,10 +49,6 @@ module FacebookAds
     field :type, 'string'
     has_no_delete
 
-    has_edge :ad_place_page_sets do |edge|
-      edge.get 'AdPlacePageSet'
-    end
-
     has_edge :adspixels do |edge|
       edge.get 'AdsPixel'
     end

data/lib/facebook_ads/ad_objects/{playable_content.rb → ad_study_objective_offsite_datasets.rb}

@@ -25,16 +25,11 @@ 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 PlayableContent < AdObject
+  class AdStudyObjectiveOffsiteDatasets < AdObject
 
+    field :event_names, { list: 'string' }
     field :id, 'string'
-    field :name, 'string'
-    field :owner, 'Profile'
-    field :app_id, 'string'
-    field :session_id, 'string'
-    field :source, 'file'
-    field :source_url, 'string'
-    field :source_zip, 'file'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -35,19 +35,19 @@ module FacebookAds
       "ALBUM_MULTIMEDIA_POST",
       "ALOHA_CALL_VIDEO",
       "ALOHA_SUPERFRAME",
+      "APP_REREVIEW_SCREENCAST",
       "APP_REVIEW_SCREENCAST",
+      "ASSET_MANAGER",
       "ATLAS_VIDEO",
       "AUDIO_BROADCAST",
-      "BELL_POLL",
-      "BRAND_EQUITY_POLL_VIDEO",
       "BROADCAST",
-      "CANDIDATE_VIDEOS",
       "CANVAS",
       "CFC_VIDEO",
       "CMS_MEDIA_MANAGER",
       "CONTAINED_POST_ATTACHMENT",
       "CONTAINED_POST_AUDIO_BROADCAST",
       "CONTAINED_POST_BROADCAST",
+      "CONTAINED_POST_COPYRIGHT_REFERENCE_BROADCAST",
       "COPYRIGHT_REFERENCE_BROADCAST",
       "COPYRIGHT_REFERENCE_VIDEO",
       "CULTURAL_MOMENT_DEPRECATED",
@@ -67,6 +67,7 @@ module FacebookAds
       "FB_SHORTS",
       "FB_SHORTS_GROUP_POST",
       "FB_SHORTS_POST",
+      "FB_SHORTS_REMIX_POST",
       "FUNDRAISER_COVER_VIDEO",
       "GAME_CLIP",
       "GEMSTONE",
@@ -77,9 +78,11 @@ module FacebookAds
       "GOODWILL_VIDEO_SHARE",
       "GOODWILL_VIDEO_TOKEN_REQUIRED",
       "GROUP_POST",
+      "HACK_TV",
       "HEURISTIC_CLUSTER_VIDEO",
       "HEURISTIC_PREVIEW",
       "HIGHLIGHT_CLIP_VIDEO",
+      "HUDDLE_BROADCAST",
       "IG_REELS_XPV",
       "IG_STORIES_READER",
       "INSPIRATION_VIDEO",
@@ -88,6 +91,8 @@ module FacebookAds
       "INSTANT_ARTICLE",
       "INSTANT_GAME_CLIP",
       "ISSUE_MODULE",
+      "JOBS_CAREERS",
+      "JOBS_VISUAL_INTRO_ENTRY",
       "JOB_APPLICATION_VIDEO",
       "JOB_OPENING_VIDEO",
       "KOTOTORO",
@@ -99,23 +104,38 @@ module FacebookAds
       "LOOK_NOW_DEPRECATED",
       "MARKETPLACE_LISTING_VIDEO",
       "MARKETPLACE_PRE_RECORDED_VIDEO",
+      "MESSENGER_WATCH_TOGETHER",
       "MOMENTS_VIDEO",
+      "MUSIC_CLIP",
+      "MUSIC_CLIP_IN_COMMENT",
+      "MUSIC_CLIP_IN_POLL_OPTION",
       "NEO_ASYNC_GAME_VIDEO",
       "NO_STORY",
       "NO_STORY_WITH_ENTPOST",
+      "NPE_COLLAB_COPYRIGHT_CHECK",
       "OCULUS_CREATOR_PORTAL",
       "OCULUS_VENUES_BROADCAST",
       "OFFERS_VIDEO",
       "PAGES_COVER_VIDEO",
       "PAGE_REVIEW_SCREENCAST",
       "PAGE_SLIDESHOW_VIDEO",
+      "PAID_CONTENT_PREVIEW",
+      "PARTNER_DIRECTORY_BRAND_MEDIA",
       "PIXELCLOUD",
+      "PODCAST_HIGHLIGHT",
+      "PODCAST_RSS",
+      "PODCAST_RSS_EPHEMERAL",
+      "PODCAST_RSS_NO_NEWSFEED_STORY",
+      "PODCAST_VOICES",
+      "PODCAST_VOICES_NO_NEWSFEED_STORY",
       "PREMIERE_SOURCE",
+      "PREMIUM_MUSIC_VIDEO_CLIP",
+      "PREMIUM_MUSIC_VIDEO_NO_NEWSFEED_STORY",
+      "PREMIUM_MUSIC_VIDEO_WITH_NEWSFEED_STORY",
       "PRIVATE_GALLERY_VIDEO",
       "PRODUCT_VIDEO",
       "PROFILE_COVER_VIDEO",
       "PROFILE_INTRO_CARD",
-      "PROFILE_TO_PAGE_UPLOADED_VIDEO",
       "PROFILE_VIDEO",
       "PROTON",
       "QUICK_PROMOTION",
@@ -127,7 +147,10 @@ module FacebookAds
       "SLIDESHOW_SHAKR",
       "SLIDESHOW_VARIATION_VIDEO",
       "SOTTO_CONTENT",
+      "SOUNDBITES_VIDEO",
       "SOUND_PLATFORM_STREAM",
+      "SRT_ATTACHMENT",
+      "STAGES_BROADCAST",
       "STORIES_VIDEO",
       "STORYLINE",
       "STORYLINE_WITH_EXTERNAL_MUSIC",
@@ -135,11 +158,16 @@ module FacebookAds
       "STORY_CARD_TEMPLATE",
       "STREAM_HIGHLIGHTS_VIDEO",
       "TAROT_DIGEST",
+      "TEMPORARY_UNLISTED",
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
+      "UNLISTED_HACK_TV",
+      "UNLISTED_OCULUS",
       "VIDEO_COMMENT",
+      "VIDEO_COMPOSITION_VARIATION",
       "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "VIDEO_SUPERRES",
+      "VOICES_ARTICLE_VIDEO",
       "VU_GENERATED_VIDEO",
       "WOODHENGE",
       "WORK_KNOWLEDGE_VIDEO",
@@ -224,7 +252,7 @@ module FacebookAds
     field :created_time, 'datetime'
     field :custom_labels, { list: 'string' }
     field :description, 'string'
-    field :embed_html, 'string'
+    field :embed_html, 'object'
     field :embeddable, 'bool'
     field :event, 'Event'
     field :expiration, 'object'
@@ -241,9 +269,10 @@ module FacebookAds
     field :live_audience_count, 'int'
     field :live_status, 'string'
     field :music_video_copyright, 'MusicVideoCopyright'
-    field :permalink_url, 'string'
+    field :permalink_url, 'object'
     field :picture, 'string'
     field :place, 'Place'
+    field :post_views, 'int'
     field :premiere_living_room_status, 'string'
     field :privacy, 'Privacy'
     field :published, 'bool'
@@ -254,6 +283,7 @@ module FacebookAds
     field :title, 'string'
     field :universal_video_id, 'string'
     field :updated_time, 'datetime'
+    field :views, 'int'
     field :adaptive_type, 'string'
     field :animated_effect_id, 'int'
     field :application_id, 'string'
@@ -359,6 +389,12 @@ module FacebookAds
       edge.get 'Page'
     end
 
+    has_edge :gaming_clip_create do |edge|
+      edge.post 'AdVideo' do |api|
+        api.has_param :duration_seconds, 'double'
+      end
+    end
+
     has_edge :likes do |edge|
       edge.get 'Profile'
       edge.post 'AdVideo' do |api|

data/lib/facebook_ads/ad_objects/adgroup_activity.rb

@@ -115,8 +115,6 @@ module FacebookAds
     field :target_spec_id_old, 'string'
     field :targets_spec_new, 'object'
     field :targets_spec_old, 'object'
-    field :tracking_pixel_ids_new, { list: 'string' }
-    field :tracking_pixel_ids_old, { list: 'string' }
     field :tracking_specs_new, { list: 'object' }
     field :tracking_specs_old, { list: 'object' }
     field :update_time_new, 'datetime'

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -42,6 +42,7 @@ module FacebookAds
     field :dri_counterfeit, 'hash'
     field :facebook, 'hash'
     field :facebook_pages_live_shopping, 'hash'
+    field :independent_work, 'hash'
     field :instagram, 'hash'
     field :instagram_shop, 'hash'
     field :job_search, 'hash'
@@ -52,6 +53,7 @@ module FacebookAds
     field :marketplace_motors, 'hash'
     field :marketplace_shops, 'hash'
     field :max_review_placements, 'hash'
+    field :neighborhoods, 'hash'
     field :page_admin, 'hash'
     field :product, 'hash'
     field :product_service, 'hash'

data/lib/facebook_ads/ad_objects/adoptable_pet.rb

@@ -26,6 +26,15 @@ module FacebookAds
   # pull request for this class.
 
   class AdoptablePet < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
 
     field :address, 'object'
     field :adoptable_pet_id, 'string'
@@ -43,6 +52,7 @@ module FacebookAds
     field :features, { list: 'string' }
     field :gender, 'string'
     field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :images, { list: 'string' }
     field :name, 'string'
     field :price, 'string'
@@ -54,9 +64,22 @@ module FacebookAds
     field :shelter_phone, 'string'
     field :size, 'string'
     field :tertiary_color, 'string'
+    field :unit_price, 'object'
     field :url, 'string'
     has_no_post
     has_no_delete
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ads_action_stats.rb

@@ -55,6 +55,8 @@ module FacebookAds
     field :inline, 'string'
     field :interactive_component_sticker_id, 'string'
     field :interactive_component_sticker_response, 'string'
+    field :skan_click, 'string'
+    field :skan_view, 'string'
     field :value, 'string'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -59,6 +59,7 @@ module FacebookAds
     BREAKDOWNS = [
       "ad_format_asset",
       "age",
+      "app_id",
       "body_asset",
       "call_to_action_asset",
       "country",
@@ -77,6 +78,7 @@ module FacebookAds
       "product_id",
       "publisher_platform",
       "region",
+      "skan_conversion_id",
       "title_asset",
       "video_asset",
     ]
@@ -129,18 +131,12 @@ module FacebookAds
     field :account_name, 'string'
     field :action_values, { list: 'AdsActionStats' }
     field :actions, { list: 'AdsActionStats' }
-    field :ad_bid_type, 'string'
     field :ad_bid_value, 'string'
     field :ad_click_actions, { list: 'AdsActionStats' }
-    field :ad_delivery, 'string'
     field :ad_id, 'string'
     field :ad_impression_actions, { list: 'AdsActionStats' }
     field :ad_name, 'string'
-    field :adset_bid_type, 'string'
     field :adset_bid_value, 'string'
-    field :adset_budget_type, 'string'
-    field :adset_budget_value, 'string'
-    field :adset_delivery, 'string'
     field :adset_end, 'string'
     field :adset_id, 'string'
     field :adset_name, 'string'
@@ -177,7 +173,6 @@ module FacebookAds
     field :cost_per_inline_post_engagement, 'string'
     field :cost_per_one_thousand_ad_impression, { list: 'AdsActionStats' }
     field :cost_per_outbound_click, { list: 'AdsActionStats' }
-    field :cost_per_store_visit_action, { list: 'AdsActionStats' }
     field :cost_per_thruplay, { list: 'AdsActionStats' }
     field :cost_per_unique_action_type, { list: 'AdsActionStats' }
     field :cost_per_unique_click, 'string'
@@ -192,6 +187,7 @@ module FacebookAds
     field :date_start, 'string'
     field :date_stop, 'string'
     field :dda_countby_convs, 'string'
+    field :dda_results, { list: 'object' }
     field :engagement_rate_ranking, 'string'
     field :estimated_ad_recall_rate, 'string'
     field :estimated_ad_recall_rate_lower_bound, 'string'
@@ -209,12 +205,13 @@ module FacebookAds
     field :inline_post_engagement, 'string'
     field :instant_experience_clicks_to_open, 'string'
     field :instant_experience_clicks_to_start, 'string'
-    field :instant_experience_outbound_clicks, 'string'
+    field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
     field :interactive_component_tap, { list: 'AdsActionStats' }
     field :labels, 'string'
     field :location, 'string'
     field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
     field :objective, 'string'
+    field :optimization_goal, 'string'
     field :outbound_clicks, { list: 'AdsActionStats' }
     field :outbound_clicks_ctr, { list: 'AdsActionStats' }
     field :place_page_name, 'string'
@@ -227,7 +224,7 @@ module FacebookAds
     field :reach, 'string'
     field :social_spend, 'string'
     field :spend, 'string'
-    field :store_visit_actions, { list: 'AdsActionStats' }
+    field :total_postbacks, 'string'
     field :unique_actions, { list: 'AdsActionStats' }
     field :unique_clicks, 'string'
     field :unique_conversions, { list: 'AdsActionStats' }

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -58,8 +58,11 @@ module FacebookAds
     ]
 
     TASKS = [
+      "AA_ANALYZE",
+      "ADVERTISE",
       "ANALYZE",
       "EDIT",
+      "UPLOAD",
     ]
 
 
@@ -73,6 +76,7 @@ module FacebookAds
     field :first_party_cookie_status, 'string'
     field :id, 'string'
     field :is_created_by_business, 'bool'
+    field :is_crm, 'bool'
     field :is_unavailable, 'bool'
     field :last_fired_time, 'datetime'
     field :name, 'string'
@@ -142,5 +146,9 @@ module FacebookAds
       end
     end
 
+    has_edge :telemetry do |edge|
+      edge.post
+    end
+
   end
 end