facebookbusiness 0.9.0.0 → 0.10.0.1

data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdCreativePortraitCustomizations < AdObject
 
+    field :carousel_delivery_mode, 'string'
     field :specifications, { list: 'object' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -33,12 +33,16 @@ module FacebookAds
       "AUDIENCE_NETWORK_REWARDED_VIDEO",
       "DESKTOP_FEED_STANDARD",
       "FACEBOOK_STORY_MOBILE",
+      "FACEBOOK_STORY_STICKER_MOBILE",
       "INSTAGRAM_EXPLORE_CONTEXTUAL",
       "INSTAGRAM_EXPLORE_IMMERSIVE",
+      "INSTAGRAM_REELS",
       "INSTAGRAM_STANDARD",
       "INSTAGRAM_STORY",
       "INSTANT_ARTICLE_RECIRCULATION_AD",
       "INSTANT_ARTICLE_STANDARD",
+      "INSTREAM_BANNER_DESKTOP",
+      "INSTREAM_BANNER_MOBILE",
       "INSTREAM_VIDEO_DESKTOP",
       "INSTREAM_VIDEO_IMAGE",
       "INSTREAM_VIDEO_MOBILE",

data/lib/facebook_ads/ad_objects/ad_report_run.rb

@@ -60,6 +60,7 @@ module FacebookAds
     field :time_range, 'object'
     field :time_ranges, { list: 'object' }
     field :use_account_attribution_setting, 'bool'
+    field :use_unified_attribution_setting, 'bool'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb

@@ -35,8 +35,7 @@ module FacebookAds
     field :evaluation_type, { enum: -> { EVALUATION_TYPE }}
     field :filters, { list: 'AdRuleFilters' }
     field :trigger, 'AdRuleTrigger'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb

@@ -45,8 +45,7 @@ module FacebookAds
 
     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

@@ -30,7 +30,6 @@ module FacebookAds
       "COST_CAP",
       "LOWEST_COST_WITHOUT_CAP",
       "LOWEST_COST_WITH_BID_CAP",
-      "TARGET_COST",
     ]
 
     BILLING_EVENT = [
@@ -38,10 +37,12 @@ module FacebookAds
       "CLICKS",
       "IMPRESSIONS",
       "LINK_CLICKS",
+      "LISTING_INTERACTION",
       "NONE",
       "OFFER_CLAIMS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PURCHASE",
       "THRUPLAY",
     ]
 
@@ -81,6 +82,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
       "REPLIES",
@@ -110,7 +112,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "lifetime",
+      "maximum",
       "this_month",
       "this_quarter",
       "this_week_mon_today",
@@ -355,6 +357,7 @@ module FacebookAds
         api.has_param :time_range, 'object'
         api.has_param :time_ranges, { list: 'object' }
         api.has_param :use_account_attribution_setting, 'bool'
+        api.has_param :use_unified_attribution_setting, 'bool'
       end
       edge.post 'AdReportRun' do |api|
         api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
@@ -377,6 +380,7 @@ module FacebookAds
         api.has_param :time_range, 'object'
         api.has_param :time_ranges, { list: 'object' }
         api.has_param :use_account_attribution_setting, 'bool'
+        api.has_param :use_unified_attribution_setting, 'bool'
       end
     end
 

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -40,6 +40,7 @@ module FacebookAds
     field :cooldown_start_time, 'datetime'
     field :created_by, 'User'
     field :created_time, 'datetime'
+    field :datasets_information, { list: 'string' }
     field :description, 'string'
     field :end_time, 'datetime'
     field :id, 'string'
@@ -60,19 +61,15 @@ 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'
-      edge.post 'AdStudyObjective' do |api|
-        api.has_param :adspixels, { list: 'object' }
-        api.has_param :applications, { list: 'object' }
-        api.has_param :customconversions, { list: 'object' }
-        api.has_param :is_primary, 'bool'
-        api.has_param :name, 'string'
-        api.has_param :offline_conversion_data_sets, { list: 'object' }
-        api.has_param :product_catalogs, { list: 'object' }
-        api.has_param :product_sets, { list: 'object' }
-        api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}
-      end
     end
 
   end

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -27,11 +27,13 @@ module FacebookAds
 
   class AdStudyObjective < AdObject
     TYPE = [
+      "AEP_CONVERSION",
       "BRAND",
       "BRANDLIFT",
       "FTL",
       "MAE",
       "MAI",
+      "MPC_CONVERSION",
       "NONSALES",
       "PARTNER",
       "SALES",
@@ -45,6 +47,7 @@ module FacebookAds
     field :name, 'string'
     field :results, { list: 'string' }
     field :type, 'string'
+    has_no_delete
 
     has_edge :ad_place_page_sets do |edge|
       edge.get 'AdPlacePageSet'

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdVideo < AdObject
     CONTAINER_TYPE = [
+      "ACO_AUTOEXTRACTED_VIDEO",
       "ACO_VIDEO_VARIATION",
       "AD_BREAK_PREVIEW",
       "AD_DERIVATIVE",
@@ -37,8 +38,6 @@ module FacebookAds
       "APP_REVIEW_SCREENCAST",
       "ATLAS_VIDEO",
       "AUDIO_BROADCAST",
-      "BELL_POLL",
-      "BRAND_EQUITY_POLL_VIDEO",
       "BROADCAST",
       "CANDIDATE_VIDEOS",
       "CANVAS",
@@ -47,6 +46,7 @@ module FacebookAds
       "CONTAINED_POST_ATTACHMENT",
       "CONTAINED_POST_AUDIO_BROADCAST",
       "CONTAINED_POST_BROADCAST",
+      "CONTAINED_POST_COPYRIGHT_REFERENCE_BROADCAST",
       "COPYRIGHT_REFERENCE_BROADCAST",
       "COPYRIGHT_REFERENCE_VIDEO",
       "CULTURAL_MOMENT_DEPRECATED",
@@ -64,9 +64,10 @@ module FacebookAds
       "EVENT_TOUR",
       "FACECAST_DVR",
       "FB_SHORTS",
+      "FB_SHORTS_GROUP_POST",
+      "FB_SHORTS_POST",
       "FUNDRAISER_COVER_VIDEO",
       "GAME_CLIP",
-      "GAMING_UPDATE_VIDEO",
       "GEMSTONE",
       "GOODWILL_ANNIVERSARY_DEPRECATED",
       "GOODWILL_ANNIVERSARY_PROMOTION_DEPRECATED",
@@ -75,9 +76,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",
@@ -86,6 +89,7 @@ module FacebookAds
       "INSTANT_ARTICLE",
       "INSTANT_GAME_CLIP",
       "ISSUE_MODULE",
+      "JOBS_VISUAL_INTRO_ENTRY",
       "JOB_APPLICATION_VIDEO",
       "JOB_OPENING_VIDEO",
       "KOTOTORO",
@@ -97,7 +101,6 @@ module FacebookAds
       "LOOK_NOW_DEPRECATED",
       "MARKETPLACE_LISTING_VIDEO",
       "MARKETPLACE_PRE_RECORDED_VIDEO",
-      "MOMENTS_VIDEO",
       "NEO_ASYNC_GAME_VIDEO",
       "NO_STORY",
       "NO_STORY_WITH_ENTPOST",
@@ -107,13 +110,17 @@ module FacebookAds
       "PAGES_COVER_VIDEO",
       "PAGE_REVIEW_SCREENCAST",
       "PAGE_SLIDESHOW_VIDEO",
+      "PARTNER_DIRECTORY_BRAND_MEDIA",
       "PIXELCLOUD",
+      "PODCAST_RSS",
+      "PODCAST_VOICES",
       "PREMIERE_SOURCE",
+      "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",
@@ -125,7 +132,9 @@ module FacebookAds
       "SLIDESHOW_SHAKR",
       "SLIDESHOW_VARIATION_VIDEO",
       "SOTTO_CONTENT",
+      "SOUNDBITES_VIDEO",
       "SOUND_PLATFORM_STREAM",
+      "SRT_ATTACHMENT",
       "STORIES_VIDEO",
       "STORYLINE",
       "STORYLINE_WITH_EXTERNAL_MUSIC",
@@ -135,7 +144,10 @@ module FacebookAds
       "TAROT_DIGEST",
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
+      "UNLISTED_HACK_TV",
+      "UNLISTED_OCULUS",
       "VIDEO_COMMENT",
+      "VIDEO_COMPOSITION_VARIATION",
       "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "VIDEO_SUPERRES",
       "VU_GENERATED_VIDEO",
@@ -239,7 +251,7 @@ 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 :premiere_living_room_status, 'string'
@@ -256,7 +268,6 @@ module FacebookAds
     field :animated_effect_id, 'int'
     field :application_id, 'string'
     field :asked_fun_fact_prompt_id, 'int'
-    field :attribution_app_id, 'string'
     field :audio_story_wave_animation_handle, 'string'
     field :chunk_session_id, 'string'
     field :composer_entry_picker, 'string'
@@ -385,16 +396,6 @@ module FacebookAds
       end
     end
 
-    has_edge :reactions do |edge|
-      edge.get 'Profile' do |api|
-        api.has_param :type, { enum: -> { Profile::TYPE }}
-      end
-    end
-
-    has_edge :sharedposts do |edge|
-      edge.get 'Post'
-    end
-
     has_edge :sponsor_tags do |edge|
       edge.get 'Page'
     end

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

@@ -44,6 +44,7 @@ module FacebookAds
     field :facebook_pages_live_shopping, 'hash'
     field :instagram, 'hash'
     field :instagram_shop, 'hash'
+    field :job_search, 'hash'
     field :lead_gen_honeypot, 'hash'
     field :marketplace, 'hash'
     field :marketplace_home_rentals, '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'
@@ -58,5 +68,13 @@ module FacebookAds
     has_no_post
     has_no_delete
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ads_action_stats.rb

@@ -33,10 +33,12 @@ module FacebookAds
     field :_28d_view, 'string'
     field :_7d_click, 'string'
     field :_7d_view, 'string'
+    field :action_brand, 'string'
     field :action_canvas_component_id, 'string'
     field :action_canvas_component_name, 'string'
     field :action_carousel_card_id, 'string'
     field :action_carousel_card_name, 'string'
+    field :action_category, 'string'
     field :action_converted_product_id, 'string'
     field :action_destination, 'string'
     field :action_device, 'string'

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -93,7 +93,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "lifetime",
+      "maximum",
       "this_month",
       "this_quarter",
       "this_week_mon_today",
@@ -146,6 +146,7 @@ module FacebookAds
     field :adset_name, 'string'
     field :adset_start, 'string'
     field :age_targeting, 'string'
+    field :attribution_setting, 'string'
     field :auction_bid, 'string'
     field :auction_competitiveness, 'string'
     field :auction_max_competitor_bid, 'string'
@@ -214,6 +215,7 @@ module FacebookAds
     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'

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -73,6 +73,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'
@@ -110,6 +111,10 @@ module FacebookAds
       end
     end
 
+    has_edge :shadowtraffichelper do |edge|
+      edge.post
+    end
+
     has_edge :shared_accounts do |edge|
       edge.delete do |api|
         api.has_param :account_id, 'string'

data/lib/facebook_ads/ad_objects/album.rb

@@ -152,15 +152,5 @@ module FacebookAds
       end
     end
 
-    has_edge :reactions do |edge|
-      edge.get 'Profile' do |api|
-        api.has_param :type, { enum: -> { Profile::TYPE }}
-      end
-    end
-
-    has_edge :sharedposts do |edge|
-      edge.get 'Post'
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/application.rb

@@ -36,6 +36,7 @@ module FacebookAds
       "IPHONE",
       "MOBILE_WEB",
       "OCULUS",
+      "SAMSUNG",
       "SUPPLEMENTARY_IMAGES",
       "WEB",
       "WINDOWS",
@@ -47,6 +48,7 @@ module FacebookAds
       "INSTANT_ARTICLES",
       "IOS",
       "MOBILE_WEB",
+      "OCULUS",
       "UNKNOWN",
     ]
 
@@ -287,6 +289,18 @@ module FacebookAds
       end
     end
 
+    has_edge :aem_conversion_configs do |edge|
+      edge.get do |api|
+        api.has_param :advertiser_ids, { list: 'string' }
+      end
+    end
+
+    has_edge :aem_conversions do |edge|
+      edge.post do |api|
+        api.has_param :aem_conversions, { list: 'hash' }
+      end
+    end
+
     has_edge :agencies do |edge|
       edge.get 'Business'
     end
@@ -296,6 +310,7 @@ module FacebookAds
         api.has_param :ecpms, { list: 'string' }
         api.has_param :query_ids, { list: 'string' }
         api.has_param :request_id, 'string'
+        api.has_param :sync_api, 'bool'
       end
     end
 
@@ -471,12 +486,6 @@ module FacebookAds
       end
     end
 
-    has_edge :live_videos do |edge|
-      edge.get 'LiveVideo' do |api|
-        api.has_param :broadcast_status, { enum: -> { LiveVideo::BROADCAST_STATUS }}
-      end
-    end
-
     has_edge :mmp_auditing do |edge|
       edge.post do |api|
         api.has_param :advertiser_id, 'string'
@@ -513,10 +522,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ozone_release do |edge|
-      edge.get
-    end
-
     has_edge :page_activities do |edge|
       edge.post 'Application' do |api|
         api.has_param :advertiser_tracking_enabled, 'bool'
@@ -560,6 +565,13 @@ module FacebookAds
       end
     end
 
+    has_edge :push_token_register do |edge|
+      edge.post do |api|
+        api.has_param :device_id, 'string'
+        api.has_param :push_token, 'string'
+      end
+    end
+
     has_edge :roles do |edge|
       edge.get
     end