facebookbusiness 0.6.0.1 → 0.7.0.1

data/lib/facebook_ads/ad_objects/ad_customization_rule_spec.rb

@@ -30,11 +30,13 @@ module FacebookAds
     field :caption, 'string'
     field :customization_spec, 'object'
     field :description, 'string'
+    field :image_hash, 'string'
     field :link, 'string'
     field :message, 'string'
     field :name, 'string'
     field :priority, 'int'
     field :template_url_spec, 'AdCreativeTemplateUrlSpec'
+    field :video_id, 'int'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb

@@ -32,6 +32,7 @@ module FacebookAds
     ]
 
     BREAKDOWNS = [
+      "AD_SERVER_CAMPAIGN_ID",
       "AD_SPACE",
       "AGE",
       "APP",
@@ -44,6 +45,8 @@ module FacebookAds
       "DISPLAY_FORMAT",
       "FAIL_REASON",
       "GENDER",
+      "INSTANT_ARTICLE_ID",
+      "INSTANT_ARTICLE_PAGE_ID",
       "PLACEMENT",
       "PLACEMENT_NAME",
       "PLATFORM",

data/lib/facebook_ads/ad_objects/ad_place_page_set.rb

@@ -45,6 +45,7 @@ module FacebookAds
     field :pages_count, 'int'
     field :parent_page, 'Page'
     field :targeted_area_type, 'adaccountad_place_page_sets_targeted_area_type_enum_param'
+    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -40,6 +40,7 @@ module FacebookAds
       "INSTANT_ARTICLE_RECIRCULATION_AD",
       "INSTANT_ARTICLE_STANDARD",
       "INSTREAM_VIDEO_DESKTOP",
+      "INSTREAM_VIDEO_IMAGE",
       "INSTREAM_VIDEO_MOBILE",
       "JOB_BROWSER_DESKTOP",
       "JOB_BROWSER_MOBILE",
@@ -56,6 +57,7 @@ module FacebookAds
       "RIGHT_COLUMN_STANDARD",
       "SUGGESTED_VIDEO_DESKTOP",
       "SUGGESTED_VIDEO_MOBILE",
+      "WATCH_FEED_HOME",
       "WATCH_FEED_MOBILE",
     ]
 

data/lib/facebook_ads/ad_objects/ad_report_run.rb

@@ -60,6 +60,8 @@ module FacebookAds
     field :time_range, 'object'
     field :time_ranges, { list: 'object' }
     field :use_account_attribution_setting, 'bool'
+    has_no_post
+    has_no_delete
 
     has_edge :insights do |edge|
       edge.get 'AdsInsights'

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdSet < AdObject
     BID_STRATEGY = [
+      "COST_CAP",
       "LOWEST_COST_WITHOUT_CAP",
       "LOWEST_COST_WITH_BID_CAP",
       "TARGET_COST",
@@ -86,6 +87,7 @@ module FacebookAds
       "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
     ]
 
     STATUS = [
@@ -137,6 +139,13 @@ module FacebookAds
       "NONE_EXPLORATION",
     ]
 
+    MULTI_OPTIMIZATION_GOAL_WEIGHT = [
+      "BALANCED",
+      "PREFER_EVENT",
+      "PREFER_INSTALL",
+      "UNDEFINED",
+    ]
+
     OPTIMIZATION_SUB_EVENT = [
       "NONE",
       "TRAVEL_INTENT",
@@ -203,6 +212,7 @@ module FacebookAds
     field :lifetime_imps, 'int'
     field :lifetime_min_spend_target, 'string'
     field :lifetime_spend_cap, 'string'
+    field :multi_optimization_goal_weight, 'string'
     field :name, 'string'
     field :optimization_goal, { enum: -> { OPTIMIZATION_GOAL }}
     field :optimization_sub_event, 'string'
@@ -272,10 +282,8 @@ module FacebookAds
 
     has_edge :ads do |edge|
       edge.get 'Ad' do |api|
-        api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
         api.has_param :effective_status, { list: 'string' }
-        api.has_param :include_drafts, 'bool'
         api.has_param :time_range, 'object'
         api.has_param :updated_since, 'int'
       end

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -93,6 +93,7 @@ module FacebookAds
       "LIVE_PHOTO",
       "LOOK_NOW_DEPRECATED",
       "MARKETPLACE_LISTING_VIDEO",
+      "MARKETPLACE_PRE_RECORDED_VIDEO",
       "MOMENTS_VIDEO",
       "NEO_ASYNC_GAME_VIDEO",
       "NO_STORY",
@@ -120,6 +121,7 @@ module FacebookAds
       "SLIDESHOW_SHAKR",
       "SLIDESHOW_VARIATION_VIDEO",
       "SOTTO_CONTENT",
+      "SOUND_PLATFORM_STREAM",
       "STORIES_VIDEO",
       "STORYLINE",
       "STORYLINE_WITH_EXTERNAL_MUSIC",
@@ -199,6 +201,7 @@ module FacebookAds
       "INSTAGRAM_STORY",
       "INSTANT_ARTICLE_STANDARD",
       "INSTREAM_VIDEO_DESKTOP",
+      "INSTREAM_VIDEO_IMAGE",
       "INSTREAM_VIDEO_MOBILE",
       "MESSENGER_MOBILE_INBOX_MEDIA",
       "MESSENGER_MOBILE_STORY_MEDIA",
@@ -225,13 +228,6 @@ module FacebookAds
       "year",
     ]
 
-    VIDEO_POLL_WWW_PLACEMENT = [
-      "BOTTOM_LEFT",
-      "BOTTOM_RIGHT",
-      "TOP_LEFT",
-      "TOP_RIGHT",
-    ]
-
 
     field :ad_breaks, { list: 'int' }
     field :backdated_time, 'datetime'
@@ -391,10 +387,6 @@ module FacebookAds
 
     has_edge :poll_settings do |edge|
       edge.get
-      edge.post 'AdVideo' do |api|
-        api.has_param :enable_was_live_voting, 'bool'
-        api.has_param :video_poll_www_placement, { enum: -> { AdVideo::VIDEO_POLL_WWW_PLACEMENT }}
-      end
     end
 
     has_edge :polls do |edge|

data/lib/facebook_ads/ad_objects/adgroup_activity.rb

@@ -69,8 +69,8 @@ module FacebookAds
     ]
 
 
-    field :ad_creative_id_new, 'string'
-    field :ad_creative_id_old, 'string'
+    field :ad_creative_id_new, 'AdCreative'
+    field :ad_creative_id_old, 'AdCreative'
     field :asset_feed_id_new, 'string'
     field :asset_feed_id_old, 'string'
     field :bid_amount_new, 'int'
@@ -105,8 +105,8 @@ module FacebookAds
     field :reason_old, 'string'
     field :run_status_new, 'string'
     field :run_status_old, 'string'
-    field :source_adgroup_id_new, 'string'
-    field :source_adgroup_id_old, 'string'
+    field :source_adgroup_id_new, 'Ad'
+    field :source_adgroup_id_old, 'Ad'
     field :start_time_new, 'datetime'
     field :start_time_old, 'datetime'
     field :stop_time_new, 'datetime'

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -35,7 +35,9 @@ module FacebookAds
     field :daily_deals, 'hash'
     field :daily_deals_legacy, 'hash'
     field :dpa, 'hash'
+    field :dri_counterfeit, 'hash'
     field :facebook, 'hash'
+    field :facebook_pages_live_shopping, 'hash'
     field :instagram, 'hash'
     field :instagram_shop, 'hash'
     field :lead_gen_honeypot, 'hash'

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -33,6 +33,7 @@ module FacebookAds
       "28d_view",
       "7d_click",
       "7d_view",
+      "dda",
       "default",
     ]
 
@@ -127,14 +128,10 @@ module FacebookAds
     field :account_name, 'string'
     field :action_values, { list: 'AdsActionStats' }
     field :actions, { list: 'AdsActionStats' }
-    field :actions_per_impression, 'string'
-    field :actions_results, 'AdsActionStats'
-    field :activity_recency, 'string'
     field :ad_bid_type, 'string'
     field :ad_bid_value, 'string'
     field :ad_click_actions, { list: 'AdsActionStats' }
     field :ad_delivery, 'string'
-    field :ad_format_asset, 'string'
     field :ad_id, 'string'
     field :ad_impression_actions, { list: 'AdsActionStats' }
     field :ad_name, 'string'
@@ -147,103 +144,49 @@ module FacebookAds
     field :adset_id, 'string'
     field :adset_name, 'string'
     field :adset_start, 'string'
-    field :age, 'string'
     field :age_targeting, 'string'
-    field :amount_in_catalog_currency, { list: 'AdsActionStats' }
-    field :app_store_clicks, 'string'
-    field :attention_events_per_impression, 'string'
-    field :attention_events_unq_per_reach, 'string'
     field :auction_bid, 'string'
     field :auction_competitiveness, 'string'
     field :auction_max_competitor_bid, 'string'
-    field :body_asset, 'object'
     field :buying_type, 'string'
-    field :call_to_action_asset, 'object'
-    field :call_to_action_clicks, 'string'
-    field :campaign_delivery, 'string'
-    field :campaign_end, 'string'
     field :campaign_id, 'string'
     field :campaign_name, 'string'
-    field :campaign_start, 'string'
-    field :cancel_subscription_actions, { list: 'AdsActionStats' }
     field :canvas_avg_view_percent, 'string'
     field :canvas_avg_view_time, 'string'
-    field :card_views, 'string'
-    field :catalog_segment_actions, { list: 'AdsActionStats' }
-    field :catalog_segment_value_in_catalog_currency, { list: 'AdsActionStats' }
+    field :catalog_segment_value, { list: 'AdsActionStats' }
     field :catalog_segment_value_mobile_purchase_roas, { list: 'AdsActionStats' }
+    field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
     field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
     field :clicks, 'string'
-    field :conditional_time_spent_ms_over_10s_actions, { list: 'AdsActionStats' }
-    field :conditional_time_spent_ms_over_15s_actions, { list: 'AdsActionStats' }
-    field :conditional_time_spent_ms_over_2s_actions, { list: 'AdsActionStats' }
-    field :conditional_time_spent_ms_over_3s_actions, { list: 'AdsActionStats' }
-    field :conditional_time_spent_ms_over_6s_actions, { list: 'AdsActionStats' }
-    field :contact_actions, { list: 'AdsActionStats' }
-    field :contact_value, { list: 'AdsActionStats' }
     field :conversion_rate_ranking, 'string'
     field :conversion_values, { list: 'AdsActionStats' }
     field :conversions, { list: 'AdsActionStats' }
     field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
     field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
-    field :cost_per_action_result, 'AdsActionStats'
     field :cost_per_action_type, { list: 'AdsActionStats' }
     field :cost_per_ad_click, { list: 'AdsActionStats' }
-    field :cost_per_completed_video_view, { list: 'AdsActionStats' }
-    field :cost_per_contact, { list: 'AdsActionStats' }
     field :cost_per_conversion, { list: 'AdsActionStats' }
-    field :cost_per_customize_product, { list: 'AdsActionStats' }
     field :cost_per_dda_countby_convs, 'string'
-    field :cost_per_donate, { list: 'AdsActionStats' }
-    field :cost_per_dwell, 'string'
-    field :cost_per_dwell_3_sec, 'string'
-    field :cost_per_dwell_5_sec, 'string'
-    field :cost_per_dwell_7_sec, 'string'
     field :cost_per_estimated_ad_recallers, 'string'
-    field :cost_per_find_location, { list: 'AdsActionStats' }
     field :cost_per_inline_link_click, 'string'
     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_schedule, { list: 'AdsActionStats' }
-    field :cost_per_start_trial, { list: 'AdsActionStats' }
     field :cost_per_store_visit_action, { list: 'AdsActionStats' }
-    field :cost_per_submit_application, { list: 'AdsActionStats' }
-    field :cost_per_subscribe, { list: 'AdsActionStats' }
     field :cost_per_thruplay, { list: 'AdsActionStats' }
-    field :cost_per_total_action, 'string'
     field :cost_per_unique_action_type, { list: 'AdsActionStats' }
     field :cost_per_unique_click, 'string'
     field :cost_per_unique_conversion, { list: 'AdsActionStats' }
     field :cost_per_unique_inline_link_click, 'string'
     field :cost_per_unique_outbound_click, { list: 'AdsActionStats' }
-    field :country, 'string'
     field :cpc, 'string'
     field :cpm, 'string'
     field :cpp, 'string'
     field :created_time, 'string'
-    field :creative_fingerprint, 'string'
     field :ctr, 'string'
-    field :customize_product_actions, { list: 'AdsActionStats' }
-    field :customize_product_value, { list: 'AdsActionStats' }
     field :date_start, 'string'
     field :date_stop, 'string'
     field :dda_countby_convs, 'string'
-    field :deduping_1st_source_ratio, 'string'
-    field :deduping_2nd_source_ratio, 'string'
-    field :deduping_3rd_source_ratio, 'string'
-    field :deduping_ratio, 'string'
-    field :deeplink_clicks, 'string'
-    field :description_asset, 'object'
-    field :device_platform, 'string'
-    field :dma, 'string'
-    field :donate_actions, { list: 'AdsActionStats' }
-    field :donate_value, { list: 'AdsActionStats' }
-    field :dwell_3_sec, 'string'
-    field :dwell_5_sec, 'string'
-    field :dwell_7_sec, 'string'
-    field :dwell_rate, 'string'
-    field :earned_impression, 'string'
     field :engagement_rate_ranking, 'string'
     field :estimated_ad_recall_rate, 'string'
     field :estimated_ad_recall_rate_lower_bound, 'string'
@@ -251,78 +194,38 @@ module FacebookAds
     field :estimated_ad_recallers, 'string'
     field :estimated_ad_recallers_lower_bound, 'string'
     field :estimated_ad_recallers_upper_bound, 'string'
-    field :find_location_actions, { list: 'AdsActionStats' }
-    field :find_location_value, { list: 'AdsActionStats' }
     field :frequency, 'string'
-    field :frequency_value, 'string'
     field :full_view_impressions, 'string'
     field :full_view_reach, 'string'
-    field :gender, 'string'
     field :gender_targeting, 'string'
-    field :hourly_stats_aggregated_by_advertiser_time_zone, 'string'
-    field :hourly_stats_aggregated_by_audience_time_zone, 'string'
-    field :image_asset, 'object'
-    field :impression_device, 'string'
     field :impressions, 'string'
-    field :impressions_auto_refresh, 'string'
-    field :impressions_gross, 'string'
     field :inline_link_click_ctr, 'string'
     field :inline_link_clicks, 'string'
     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 :interactive_component_tap, { list: 'AdsActionStats' }
     field :labels, 'string'
-    field :link_url_asset, 'object'
     field :location, 'string'
-    field :media_asset, 'object'
     field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
-    field :newsfeed_avg_position, 'string'
-    field :newsfeed_clicks, 'string'
-    field :newsfeed_impressions, 'string'
     field :objective, 'string'
-    field :optimization_goal, 'string'
     field :outbound_clicks, { list: 'AdsActionStats' }
     field :outbound_clicks_ctr, { list: 'AdsActionStats' }
-    field :performance_indicator, 'string'
-    field :place_page_id, 'string'
     field :place_page_name, 'string'
-    field :placement, 'string'
-    field :platform_position, 'string'
-    field :product_id, 'string'
-    field :publisher_platform, 'string'
     field :purchase_roas, { list: 'AdsActionStats' }
+    field :qualifying_question_qualify_answer_rate, 'string'
     field :quality_ranking, 'string'
     field :quality_score_ectr, 'string'
     field :quality_score_ecvr, 'string'
     field :quality_score_organic, 'string'
     field :reach, 'string'
-    field :recurring_subscription_payment_actions, { list: 'AdsActionStats' }
-    field :region, 'string'
-    field :rule_asset, 'object'
-    field :schedule_actions, { list: 'AdsActionStats' }
-    field :schedule_value, { list: 'AdsActionStats' }
     field :social_spend, 'string'
     field :spend, 'string'
-    field :start_trial_actions, { list: 'AdsActionStats' }
-    field :start_trial_value, { list: 'AdsActionStats' }
     field :store_visit_actions, { list: 'AdsActionStats' }
-    field :submit_application_actions, { list: 'AdsActionStats' }
-    field :submit_application_value, { list: 'AdsActionStats' }
-    field :subscribe_actions, { list: 'AdsActionStats' }
-    field :subscribe_value, { list: 'AdsActionStats' }
-    field :thumb_stops, 'string'
-    field :title_asset, 'object'
-    field :today_spend, 'string'
-    field :total_action_value, 'string'
-    field :total_actions, 'string'
-    field :total_unique_actions, 'string'
     field :unique_actions, { list: 'AdsActionStats' }
     field :unique_clicks, 'string'
     field :unique_conversions, { list: 'AdsActionStats' }
     field :unique_ctr, 'string'
-    field :unique_impressions, 'string'
     field :unique_inline_link_click_ctr, 'string'
     field :unique_inline_link_clicks, 'string'
     field :unique_link_clicks_ctr, 'string'
@@ -333,10 +236,7 @@ module FacebookAds
     field :updated_time, 'string'
     field :video_15_sec_watched_actions, { list: 'AdsActionStats' }
     field :video_30_sec_watched_actions, { list: 'AdsActionStats' }
-    field :video_asset, 'object'
     field :video_avg_time_watched_actions, { list: 'AdsActionStats' }
-    field :video_complete_watched_actions, { list: 'AdsActionStats' }
-    field :video_completed_view_or_15s_passed_actions, { list: 'AdsActionStats' }
     field :video_continuous_2_sec_watched_actions, { list: 'AdsActionStats' }
     field :video_p100_watched_actions, { list: 'AdsActionStats' }
     field :video_p25_watched_actions, { list: 'AdsActionStats' }
@@ -350,7 +250,6 @@ module FacebookAds
     field :video_play_retention_graph_actions, { list: 'object' }
     field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
     field :video_time_watched_actions, { list: 'AdsActionStats' }
-    field :website_clicks, 'string'
     field :website_ctr, { list: 'AdsActionStats' }
     field :website_purchase_roas, { list: 'AdsActionStats' }
     field :wish_bid, 'string'

data/lib/facebook_ads/ad_objects/{dynamic_item_display_bundle.rb → ads_interest.rb}

@@ -25,19 +25,17 @@ 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 DynamicItemDisplayBundle < AdObject
+  class AdsInterest < AdObject
 
-    field :additional_urls, 'hash'
+    field :audience_size, 'int'
     field :description, 'string'
+    field :disambiguation_category, 'string'
     field :id, 'string'
     field :name, 'string'
-    field :product_set, 'ProductSet'
-    field :text_tokens, 'hash'
-    field :url, 'string'
-
-    has_edge :bundle_folders do |edge|
-      edge.get 'DynamicItemDisplayBundleFolder'
-    end
+    field :path, { list: 'string' }
+    field :topic, 'string'
+    has_no_post
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -78,9 +78,6 @@ module FacebookAds
     has_no_delete
 
     has_edge :assigned_users do |edge|
-      edge.delete do |api|
-        api.has_param :user, 'int'
-      end
       edge.get 'AssignedUser' do |api|
         api.has_param :business, 'string'
       end