facebookbusiness 0.12.0.1 → 0.15.0.0

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -36,21 +36,23 @@ module FacebookAds
 
     field :business, 'Business'
     field :canceled_time, 'datetime'
+    field :client_business, 'Business'
     field :cooldown_start_time, 'datetime'
     field :created_by, 'User'
     field :created_time, 'datetime'
     field :description, 'string'
     field :end_time, 'datetime'
     field :id, 'string'
+    field :measurement_contact, 'User'
     field :name, 'string'
     field :observation_end_time, 'datetime'
     field :results_first_available_date, 'string'
+    field :sales_contact, 'User'
     field :start_time, 'datetime'
     field :type, 'string'
     field :updated_by, 'User'
     field :updated_time, 'datetime'
     field :cells, { list: 'object' }
-    field :client_business, 'string'
     field :confidence_level, 'double'
     field :objectives, { list: 'object' }
     field :viewers, { list: 'int' }
@@ -59,10 +61,21 @@ module FacebookAds
       edge.get 'AdStudyCell'
     end
 
+    has_edge :checkpoint do |edge|
+      edge.post 'AdStudy' do |api|
+        api.has_param :checkpoint_data, 'string'
+        api.has_param :checkpoint_name, 'string'
+        api.has_param :component, 'string'
+        api.has_param :instance_id, 'string'
+        api.has_param :run_id, 'string'
+      end
+    end
+
     has_edge :instances do |edge|
       edge.get 'PrivateLiftStudyInstance'
       edge.post 'PrivateLiftStudyInstance' do |api|
         api.has_param :breakdown_key, 'hash'
+        api.has_param :run_id, 'string'
       end
     end
 

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -29,6 +29,7 @@ module FacebookAds
     CONTAINER_TYPE = [
       "ACO_AUTOEXTRACTED_VIDEO",
       "ACO_VIDEO_VARIATION",
+      "ADS_AI_GENERATED",
       "AD_BREAK_PREVIEW",
       "AD_DERIVATIVE",
       "AGE_UP",
@@ -39,18 +40,21 @@ module FacebookAds
       "APP_REVIEW_SCREENCAST",
       "ASSET_MANAGER",
       "ATLAS_VIDEO",
+      "AUDIO_BRIEF",
       "AUDIO_BROADCAST",
+      "AUDIO_COMMENT",
       "BROADCAST",
+      "BULLETIN_ARTICLE_AUDIO",
+      "CANDIDATE_VIDEOS_DELETED",
       "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",
+      "CREATION_ML_PRECREATION",
       "DCO_AD_ASSET_FEED",
       "DCO_AUTOGEN_VIDEO",
       "DCO_TRIMMED_VIDEO",
@@ -58,19 +62,26 @@ module FacebookAds
       "DIRECTED_POST_ATTACHMENT",
       "DIRECT_INBOX",
       "DIRECT_INBOX_REACTION",
+      "DROPS_SHOPPING_EVENT_PAGE",
       "DYNAMIC_ITEM_DISPLAY_BUNDLE",
       "DYNAMIC_ITEM_VIDEO",
       "DYNAMIC_TEMPLATE_VIDEO",
       "EVENT_COVER_VIDEO",
       "EVENT_TOUR",
       "FACECAST_DVR",
+      "FB_COLLECTIBLE_VIDEO",
       "FB_SHORTS",
+      "FB_SHORTS_CONTENT_REMIXABLE",
+      "FB_SHORTS_CROSS_META_POST",
       "FB_SHORTS_GROUP_POST",
+      "FB_SHORTS_PMV_POST",
+      "FB_SHORTS_PMV_POST_NO_NEWSFEED_NOR_TIMELINE",
       "FB_SHORTS_POST",
       "FB_SHORTS_REMIX_POST",
       "FUNDRAISER_COVER_VIDEO",
       "GAME_CLIP",
       "GEMSTONE",
+      "GIF_TO_VIDEO",
       "GOODWILL_ANNIVERSARY_DEPRECATED",
       "GOODWILL_ANNIVERSARY_PROMOTION_DEPRECATED",
       "GOODWILL_VIDEO_CONTAINED_SHARE",
@@ -85,6 +96,7 @@ module FacebookAds
       "HUDDLE_BROADCAST",
       "IG_REELS_XPV",
       "IG_STORIES_READER",
+      "INJECTABLE",
       "INSPIRATION_VIDEO",
       "INSTAGRAM_VIDEO_COPY",
       "INSTANT_APPLICATION_PREVIEW",
@@ -98,8 +110,10 @@ module FacebookAds
       "KOTOTORO",
       "LEARN",
       "LEGACY",
+      "LEGACY_CONTAINED_POST_BROADCAST",
+      "LIVE_AUDIO_ROOM_BROADCAST",
+      "LIVE_CLIP_PREVIEW",
       "LIVE_CREATIVE_KIT_VIDEO",
-      "LIVE_LINEAR_VIDEO_CHANNEL_INTERNAL_BROADCAST",
       "LIVE_PHOTO",
       "LOOK_NOW_DEPRECATED",
       "MARKETPLACE_LISTING_VIDEO",
@@ -107,9 +121,13 @@ module FacebookAds
       "MESSENGER_WATCH_TOGETHER",
       "MOMENTS_VIDEO",
       "MUSIC_CLIP",
+      "MUSIC_CLIP_IN_AUDIO_DIGEST",
       "MUSIC_CLIP_IN_COMMENT",
+      "MUSIC_CLIP_IN_LIGHTWEIGHT_STATUS",
       "MUSIC_CLIP_IN_POLL_OPTION",
+      "MUSIC_CLIP_ON_DATING_PROFILE",
       "NEO_ASYNC_GAME_VIDEO",
+      "NEW_CONTAINED_POST_BROADCAST",
       "NO_STORY",
       "NO_STORY_WITH_ENTPOST",
       "NPE_COLLAB_COPYRIGHT_CHECK",
@@ -120,9 +138,14 @@ module FacebookAds
       "PAGE_REVIEW_SCREENCAST",
       "PAGE_SLIDESHOW_VIDEO",
       "PAID_CONTENT_PREVIEW",
-      "PARTNER_DIRECTORY_BRAND_MEDIA",
+      "PAID_CONTENT_VIDEO",
+      "PAID_CONTENT_VIDEO__POST",
+      "PAPER_DOCUMENT_AUDIO",
+      "PAPER_DOCUMENT_VIDEO",
       "PIXELCLOUD",
       "PODCAST_HIGHLIGHT",
+      "PODCAST_ML_PREVIEW",
+      "PODCAST_ML_PREVIEW_NO_NEWSFEED_STORY",
       "PODCAST_RSS",
       "PODCAST_RSS_EPHEMERAL",
       "PODCAST_RSS_NO_NEWSFEED_STORY",
@@ -130,6 +153,7 @@ module FacebookAds
       "PODCAST_VOICES_NO_NEWSFEED_STORY",
       "PREMIERE_SOURCE",
       "PREMIUM_MUSIC_VIDEO_CLIP",
+      "PREMIUM_MUSIC_VIDEO_CROPPED_CLIP",
       "PREMIUM_MUSIC_VIDEO_NO_NEWSFEED_STORY",
       "PREMIUM_MUSIC_VIDEO_WITH_NEWSFEED_STORY",
       "PRIVATE_GALLERY_VIDEO",
@@ -152,6 +176,7 @@ module FacebookAds
       "SRT_ATTACHMENT",
       "STAGES_BROADCAST",
       "STORIES_VIDEO",
+      "STORIES_WEARABLE",
       "STORYLINE",
       "STORYLINE_WITH_EXTERNAL_MUSIC",
       "STORY_ARCHIVE_VIDEO",
@@ -162,6 +187,7 @@ module FacebookAds
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
       "UNLISTED_HACK_TV",
+      "UNLISTED_HORIZON",
       "UNLISTED_OCULUS",
       "VIDEO_COMMENT",
       "VIDEO_COMPOSITION_VARIATION",
@@ -232,6 +258,12 @@ module FacebookAds
       "uploaded",
     ]
 
+    VIDEO_STATE = [
+      "DRAFT",
+      "PUBLISHED",
+      "SCHEDULED",
+    ]
+
     BACKDATED_TIME_GRANULARITY = [
       "day",
       "hour",
@@ -243,6 +275,8 @@ module FacebookAds
 
 
     field :ad_breaks, { list: 'int' }
+    field :admin_creator, 'User'
+    field :audio_isrc, 'object'
     field :backdated_time, 'datetime'
     field :backdated_time_granularity, 'string'
     field :content_category, 'string'
@@ -333,7 +367,6 @@ module FacebookAds
     field :react_mode_metadata, 'string'
     field :referenced_sticker_id, 'string'
     field :replace_video_id, 'string'
-    field :sales_promo_id, 'int'
     field :slideshow_spec, 'hash'
     field :source_instagram_media_id, 'string'
     field :start_offset, 'int'

data/lib/facebook_ads/ad_objects/adgroup_metadata.rb

@@ -0,0 +1,41 @@
+# 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.
+
+# 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 AdgroupMetadata < AdObject
+
+    field :ad_standard_enhancements_edit_source, 'int'
+    field :adgroup_creation_source, 'string'
+    field :adgroup_edit_source, 'string'
+    field :carousel_style, 'string'
+    field :carousel_with_static_card_style, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -61,6 +61,7 @@ module FacebookAds
     field :seller, 'hash'
     field :shops, 'hash'
     field :traffic_quality, 'hash'
+    field :unified_commerce_content, 'hash'
     field :whatsapp, 'hash'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -35,6 +35,8 @@ module FacebookAds
       "7d_view",
       "dda",
       "default",
+      "skan_click",
+      "skan_view",
     ]
 
     ACTION_BREAKDOWNS = [
@@ -72,18 +74,22 @@ module FacebookAds
       "hourly_stats_aggregated_by_audience_time_zone",
       "image_asset",
       "impression_device",
+      "is_conversion_id_modeled",
       "link_url_asset",
+      "mmm",
       "place_page_id",
       "platform_position",
       "product_id",
       "publisher_platform",
       "region",
+      "skan_campaign_id",
       "skan_conversion_id",
       "title_asset",
       "video_asset",
     ]
 
     DATE_PRESET = [
+      "data_maximum",
       "last_14d",
       "last_28d",
       "last_30d",
@@ -225,6 +231,7 @@ module FacebookAds
     field :social_spend, 'string'
     field :spend, 'string'
     field :total_postbacks, 'string'
+    field :total_postbacks_detailed, { list: 'AdsActionStats' }
     field :unique_actions, { list: 'AdsActionStats' }
     field :unique_clicks, 'string'
     field :unique_conversions, { list: 'AdsActionStats' }

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -102,10 +102,11 @@ module FacebookAds
     end
 
     has_edge :events do |edge|
-      edge.post 'AdsPixel' do |api|
+      edge.post do |api|
         api.has_param :data, { list: 'string' }
         api.has_param :namespace_id, 'string'
         api.has_param :partner_agent, 'string'
+        api.has_param :platforms, { list: 'hash' }
         api.has_param :test_event_code, 'string'
         api.has_param :trace, 'int'
         api.has_param :upload_id, 'string'
@@ -114,6 +115,10 @@ module FacebookAds
       end
     end
 
+    has_edge :meapitocapiconsolidationhelper do |edge|
+      edge.post
+    end
+
     has_edge :shadowtraffichelper do |edge|
       edge.post
     end

data/lib/facebook_ads/ad_objects/album.rb

@@ -111,7 +111,6 @@ module FacebookAds
         api.has_param :ios_bundle_id, 'string'
         api.has_param :is_explicit_location, 'bool'
         api.has_param :is_explicit_place, 'bool'
-        api.has_param :is_visual_search, 'bool'
         api.has_param :manual_privacy, 'bool'
         api.has_param :message, 'string'
         api.has_param :name, 'string'

data/lib/facebook_ads/ad_objects/application.rb

@@ -124,6 +124,7 @@ module FacebookAds
     field :auto_event_mapping_android, { list: 'object' }
     field :auto_event_mapping_ios, { list: 'object' }
     field :auto_event_setup_enabled, 'bool'
+    field :business, 'Business'
     field :canvas_fluid_height, 'bool'
     field :canvas_fluid_width, 'int'
     field :canvas_url, 'string'
@@ -169,6 +170,7 @@ module FacebookAds
     field :name, 'string'
     field :namespace, 'string'
     field :object_store_urls, 'object'
+    field :owner_business, 'Business'
     field :page_tab_default_name, 'string'
     field :page_tab_url, 'string'
     field :photo_url, 'string'
@@ -233,6 +235,7 @@ module FacebookAds
         api.has_param :bundle_id, 'string'
         api.has_param :bundle_short_version, 'string'
         api.has_param :bundle_version, 'string'
+        api.has_param :campaign_ids, 'string'
         api.has_param :click_id, 'string'
         api.has_param :consider_views, 'bool'
         api.has_param :custom_events, { list: 'object' }
@@ -261,6 +264,10 @@ module FacebookAds
       end
     end
 
+    has_edge :ad_placement_groups do |edge|
+      edge.get
+    end
+
     has_edge :adnetwork_placements do |edge|
       edge.get 'AdPlacement' do |api|
         api.has_param :request_id, 'string'
@@ -304,12 +311,28 @@ module FacebookAds
       end
     end
 
+    has_edge :aem_conversion_filter do |edge|
+      edge.get do |api|
+        api.has_param :catalog_id, 'string'
+        api.has_param :fb_content_ids, 'string'
+      end
+    end
+
     has_edge :aem_conversions do |edge|
       edge.post do |api|
         api.has_param :aem_conversions, { list: 'hash' }
       end
     end
 
+    has_edge :aem_skan_readiness do |edge|
+      edge.post do |api|
+        api.has_param :app_id, 'int'
+        api.has_param :is_aem_ready, 'bool'
+        api.has_param :is_aem_v2_ready, 'bool'
+        api.has_param :is_skan_ready, 'bool'
+      end
+    end
+
     has_edge :agencies do |edge|
       edge.get 'Business'
     end
@@ -327,6 +350,10 @@ module FacebookAds
       edge.get
     end
 
+    has_edge :app_event_types do |edge|
+      edge.get
+    end
+
     has_edge :app_indexing do |edge|
       edge.post 'Application' do |api|
         api.has_param :app_version, 'string'
@@ -389,6 +416,10 @@ module FacebookAds
       end
     end
 
+    has_edge :cloudbridge_settings do |edge|
+      edge.get
+    end
+
     has_edge :codeless_event_mappings do |edge|
       edge.post 'Application' do |api|
         api.has_param :mappings, { list: 'hash' }
@@ -452,13 +483,6 @@ module FacebookAds
       end
     end
 
-    has_edge :leaderboards_reset do |edge|
-      edge.post 'Application' do |api|
-        api.has_param :name, 'string'
-        api.has_param :reset_time, 'datetime'
-      end
-    end
-
     has_edge :mmp_auditing do |edge|
       edge.post do |api|
         api.has_param :advertiser_id, 'string'
@@ -474,6 +498,7 @@ module FacebookAds
         api.has_param :fb_click_time, 'int'
         api.has_param :fb_view_time, 'int'
         api.has_param :is_fb, 'bool'
+        api.has_param :used_install_referrer, 'bool'
         api.has_param :view_attr_window, 'int'
       end
     end
@@ -488,6 +513,18 @@ module FacebookAds
       end
     end
 
+    has_edge :monetized_digital_store_objects do |edge|
+      edge.get
+      edge.post do |api|
+        api.has_param :content_id, 'string'
+        api.has_param :store, 'string'
+      end
+    end
+
+    has_edge :object_types do |edge|
+      edge.get 'NullNode'
+    end
+
     has_edge :occludespopups do |edge|
       edge.post do |api|
         api.has_param :flash, 'bool'
@@ -530,29 +567,13 @@ module FacebookAds
     end
 
     has_edge :purchases do |edge|
-      edge.get do |api|
-        api.has_param :is_premium, 'bool'
-      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
+      edge.get
     end
 
     has_edge :roles do |edge|
       edge.get
     end
 
-    has_edge :send_notification do |edge|
-      edge.post do |api|
-        api.has_param :payload, 'string'
-        api.has_param :token_id, 'string'
-      end
-    end
-
     has_edge :subscribed_domains do |edge|
       edge.get
       edge.post 'Application' do |api|

data/lib/facebook_ads/ad_objects/automotive_model.rb

@@ -35,31 +35,6 @@ module FacebookAds
       "PARTIAL_FETCH",
     ]
 
-    BODY_STYLE = [
-      "CONVERTIBLE",
-      "COUPE",
-      "CROSSOVER",
-      "ESTATE",
-      "GRANDTOURER",
-      "HATCHBACK",
-      "MINIBUS",
-      "MINIVAN",
-      "MPV",
-      "NONE",
-      "OTHER",
-      "PICKUP",
-      "ROADSTER",
-      "SALOON",
-      "SEDAN",
-      "SPORTSCAR",
-      "SUPERCAR",
-      "SUPERMINI",
-      "SUV",
-      "TRUCK",
-      "VAN",
-      "WAGON",
-    ]
-
 
     field :applinks, 'CatalogItemAppLinks'
     field :automotive_model_id, 'string'

data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb

@@ -32,7 +32,6 @@ module FacebookAds
     field :name, 'string'
     field :parent_category, 'string'
     field :path, { list: 'string' }
-    field :size, 'int'
     field :size_lower_bound, 'int'
     field :size_upper_bound, 'int'
     field :source, 'string'