facebookbusiness 0.3.3.3 → 0.3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1235152cf3411a27f1680a83d12d8d8b911240d1540156bfdfc53ea2f1596909
-  data.tar.gz: 7eae3dde8fb347531132d0e6fe9a5df8f4f92b45e983e7653c07e1d409549aa7
+  metadata.gz: f47f1ea66dbf133a355ec03cf486014ac76ecbd867866e26f220d3756fc7bfd7
+  data.tar.gz: b9136a0fc33ed013528bcd6c563806c0d3e4c103753de51f212bfdddb71835be
 SHA512:
-  metadata.gz: 05100fdd628eccf186497086156fa0c4ad25e9f459e3625191da15c0f98a637a50276c585e6f494e15178f22b789a9ebdc2a7887c73b316993ce7c11bf6a3815
-  data.tar.gz: 18f40ccf9400ebfa9a29b441291371c5eba34590004f6cfbfa600dcd9844603d3af198061c4fe15010ec9be04f39a0aa5e585597a70091ca8bd17d3d4f2f782a
+  metadata.gz: e6f929bcc03a9b08a3108d29353db2dac5f26332527e8fe4cffa0014e6d87db35d13869443b02bafdacf2d6b3902865fea18ad108e40da29a1db28ab430d0975
+  data.tar.gz: 951a90cfa8f60544d2f2259812f202f740d7c55589e857125b33b45ade93995fd8a08b73439fd019f9f9a0199b3249e0e8f65672e6ae13a293a1350e6dbc547a

data/lib/facebook_ads/ad_objects/ad.rb

@@ -122,9 +122,11 @@ module FacebookAds
     field :engagement_audience, 'bool'
     field :failed_delivery_checks, { list: 'DeliveryCheck' }
     field :id, 'string'
+    field :is_autobid, 'bool'
     field :issues_info, { list: 'AdgroupIssuesInfo' }
     field :last_updated_by_app_id, 'string'
     field :name, 'string'
+    field :preview_shareable_link, 'string'
     field :priority, 'int'
     field :recommendations, { list: 'AdRecommendation' }
     field :source_ad, 'Ad'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -86,12 +86,16 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "ANALYZE",
+      "CREATIVE",
+      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 
     TASKS = [
       "ADVERTISE",
       "ANALYZE",
+      "CREATIVE",
+      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 
@@ -161,6 +165,7 @@ module FacebookAds
     field :disable_reason, 'int'
     field :end_advertiser, 'string'
     field :end_advertiser_name, 'string'
+    field :extended_credit_invoice_group, 'ExtendedCreditInvoiceGroup'
     field :failed_delivery_checks, { list: 'DeliveryCheck' }
     field :fb_entity, 'int'
     field :funding_source, 'string'
@@ -225,8 +230,13 @@ module FacebookAds
     end
 
     has_edge :ad_sets do |edge|
+      edge.delete do |api|
+        api.has_param :before_date, 'datetime'
+        api.has_param :delete_offset, 'int'
+        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
+        api.has_param :object_count, 'int'
+      end
       edge.post 'AdSet' do |api|
-        api.has_param :ad_keywords, 'object'
         api.has_param :adlabels, { list: 'object' }
         api.has_param :adset_schedule, { list: 'object' }
         api.has_param :attribution_spec, { list: 'hash' }
@@ -505,12 +515,6 @@ module FacebookAds
     end
 
     has_edge :adsets do |edge|
-      edge.delete do |api|
-        api.has_param :before_date, 'datetime'
-        api.has_param :delete_offset, 'int'
-        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
-        api.has_param :object_count, 'int'
-      end
       edge.get 'AdSet' do |api|
         api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
@@ -723,15 +727,6 @@ module FacebookAds
       end
     end
 
-    has_edge :brand_audiences do |edge|
-      edge.post do |api|
-        api.has_param :description, 'string'
-        api.has_param :name, 'string'
-        api.has_param :target_size, 'int'
-        api.has_param :targeting, 'object'
-      end
-    end
-
     has_edge :broadtargetingcategories do |edge|
       edge.get 'BroadTargetingCategories' do |api|
         api.has_param :custom_categories_only, 'bool'
@@ -996,14 +991,6 @@ module FacebookAds
       end
     end
 
-    has_edge :partnerrequests do |edge|
-      edge.post do |api|
-        api.has_param :account_ids, { list: 'int' }
-        api.has_param :category_ids, { list: 'string' }
-        api.has_param :type, { enum: %w{SHARE_PC }}
-      end
-    end
-
     has_edge :product_audiences do |edge|
       edge.post 'CustomAudience' do |api|
         api.has_param :allowed_domains, { list: 'string' }
@@ -1044,7 +1031,7 @@ module FacebookAds
     end
 
     has_edge :reachestimate do |edge|
-      edge.get 'ReachEstimate' do |api|
+      edge.get 'AdAccountReachEstimate' do |api|
         api.has_param :adgroup_ids, { list: 'string' }
         api.has_param :caller_id, 'string'
         api.has_param :concepts, 'string'
@@ -1193,15 +1180,7 @@ module FacebookAds
     end
 
     has_edge :users do |edge|
-      edge.delete do |api|
-        api.has_param :uid, 'int'
-        api.has_param :uids, { list: 'string' }
-      end
       edge.get 'AdAccountUser'
-      edge.post 'AdAccount' do |api|
-        api.has_param :tasks, { list: { enum: -> { AdAccount::TASKS }} }
-        api.has_param :uid, 'int'
-      end
     end
 
     has_edge :usersofanyaudience do |edge|

data/lib/facebook_ads/ad_objects/{reach_estimate.rb → ad_account_reach_estimate.rb}

@@ -25,10 +25,9 @@ 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 ReachEstimate < AdObject
+  class AdAccountReachEstimate < AdObject
 
     field :estimate_ready, 'bool'
-    field :unsupported, 'bool'
     field :users, 'int'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -99,6 +99,7 @@ module FacebookAds
       "ethnic_affinity",
       "exclude_previous_days",
       "exclude_reached_since",
+      "excluded_brand_safety_content_types",
       "excluded_connections",
       "excluded_custom_audiences",
       "excluded_dynamic_audience_ids",

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -48,6 +48,7 @@ module FacebookAds
       "billing_event",
       "campaign_ended",
       "campaign_spending_limit_reached",
+      "conversion_event_updated",
       "create_ad",
       "create_ad_set",
       "create_audience",

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "FACEBOOK_STORY_MOBILE",
       "INSTAGRAM_STANDARD",
       "INSTAGRAM_STORY",
+      "INSTANT_ARTICLE_RECIRCULATION_AD",
       "INSTANT_ARTICLE_STANDARD",
       "INSTREAM_VIDEO_DESKTOP",
       "INSTREAM_VIDEO_MOBILE",

data/lib/facebook_ads/ad_objects/ad_report_run.rb

@@ -65,9 +65,5 @@ module FacebookAds
       edge.get 'AdsInsights'
     end
 
-    has_edge :retry do |edge|
-      edge.post 'AdReportRun'
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -161,7 +161,6 @@ module FacebookAds
 
 
     field :account_id, 'string'
-    field :ad_keywords, 'AdKeywords'
     field :adlabels, { list: 'AdLabel' }
     field :adset_schedule, { list: 'DayPart' }
     field :asset_feed_id, 'string'
@@ -244,17 +243,6 @@ module FacebookAds
       edge.get 'AdCreative'
     end
 
-    has_edge :adlabels do |edge|
-      edge.delete do |api|
-        api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
-      end
-      edge.post 'AdSet' do |api|
-        api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
-      end
-    end
-
     has_edge :adrules_governed do |edge|
       edge.get 'AdRule' do |api|
         api.has_param :pass_evaluation, 'bool'
@@ -274,6 +262,12 @@ module FacebookAds
     end
 
     has_edge :copies do |edge|
+      edge.get 'AdSet' do |api|
+        api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
+        api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
+        api.has_param :is_completed, 'bool'
+        api.has_param :time_range, 'object'
+      end
       edge.post 'AdSet' do |api|
         api.has_param :campaign_id, 'string'
         api.has_param :create_dco_adset, 'bool'
@@ -340,6 +334,17 @@ module FacebookAds
       end
     end
 
+    has_edge :labels do |edge|
+      edge.delete do |api|
+        api.has_param :adlabels, { list: 'object' }
+        api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
+      end
+      edge.post 'AdSet' do |api|
+        api.has_param :adlabels, { list: 'object' }
+        api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
+      end
+    end
+
     has_edge :targetingsentencelines do |edge|
       edge.get 'TargetingSentenceLine'
     end

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -71,5 +71,9 @@ module FacebookAds
       edge.get 'OffsitePixel'
     end
 
+    has_edge :partnerstudies do |edge|
+      edge.get 'PartnerStudy'
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -72,6 +72,7 @@ module FacebookAds
       "GROUP_POST",
       "HEURISTIC_CLUSTER_VIDEO",
       "HEURISTIC_PREVIEW",
+      "HIGHLIGHT_CLIP_VIDEO",
       "INSPIRATION_VIDEO",
       "INSTAGRAM_VIDEO_COPY",
       "INSTANT_APPLICATION_PREVIEW",
@@ -299,6 +300,7 @@ module FacebookAds
     field :video_file_chunk, 'string'
     field :video_start_time_ms, 'int'
     field :waterfall_id, 'string'
+    field :creative_folder_id, 'string'
 
     has_edge :auto_trims do |edge|
       edge.post 'AdVideo' do |api|

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

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

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -40,6 +40,7 @@ module FacebookAds
       "action_canvas_component_name",
       "action_carousel_card_id",
       "action_carousel_card_name",
+      "action_converted_product_id",
       "action_destination",
       "action_device",
       "action_reaction",
@@ -112,6 +113,7 @@ module FacebookAds
       "action_canvas_component_name",
       "action_carousel_card_id",
       "action_carousel_card_name",
+      "action_converted_product_id",
       "action_destination",
       "action_device",
       "action_reaction",
@@ -127,42 +129,90 @@ 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'
+    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'
+    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_mobile_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_values, { list: 'AdsActionStats' }
     field :conversions, { list: 'AdsActionStats' }
     field :cost_per_10_sec_video_view, { 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_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' }
@@ -175,20 +225,37 @@ module FacebookAds
     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 :estimated_ad_recall_rate, 'string'
     field :estimated_ad_recall_rate_lower_bound, 'string'
     field :estimated_ad_recall_rate_upper_bound, 'string'
     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'
@@ -196,18 +263,29 @@ module FacebookAds
     field :image_asset, 'object'
     field :impression_device, 'string'
     field :impressions, 'string'
+    field :impressions_auto_refresh, 'string'
     field :impressions_dummy, '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'
@@ -215,17 +293,36 @@ module FacebookAds
     field :product_id, 'string'
     field :publisher_platform, 'string'
     field :purchase_roas, { list: 'AdsActionStats' }
+    field :quality_score_ectr, 'string'
+    field :quality_score_ecvr, 'string'
+    field :quality_score_enfbr, 'string'
+    field :quality_score_organic, 'string'
     field :reach, 'string'
+    field :recurring_subscription_payment_actions, { list: 'AdsActionStats' }
     field :region, 'string'
     field :relevance_score, 'AdgroupRelevanceScore'
     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 :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'
@@ -241,6 +338,8 @@ module FacebookAds
     field :video_asset, 'object'
     field :video_avg_percent_watched_actions, { list: 'AdsActionStats' }
     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' }
@@ -254,6 +353,7 @@ 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'