facebookbusiness 0.7.0.3 → 0.10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21427a72a89e5b69fcd40fcf556030df9c45494dd4256e7182b654ba4953771e
-  data.tar.gz: d031189ae8b805d79df679a06dfd9dbb418cd523143f0617998934bdce4ea5e7
+  metadata.gz: 68cfe1dc173576ff183892c6ffc86265a7a882750d9c44ad5be8a203945ed19f
+  data.tar.gz: 0fbea84a3e75c500ecebe55432565aee34ae845410c5c61b62f63f3b6fd75172
 SHA512:
-  metadata.gz: ba42f3cf881a1c1546b115389c241dc085b32877ec7b8259602d25fa6087cd1bec4afe2d546c982b87fc65f74c4a0ee62f4d634eb79d010c88d9698ccb9e6f07
-  data.tar.gz: 0dba0ce20bf17ef53da7214d0a9452ee7273321de7553d9b7c37cc35546c08caa245bad54542068a8003a2dbd8d316e552263d4220e3a1f9794aa8f444dec89f
+  metadata.gz: 72a893fb5b63c3d214b2dbf198bac16e38ac30678c0219d8dc4cbe5637840c69c73d5f3f1a421cf8cb86426f06f40f568342c99583561fa9a6a3235d6324dbbd
+  data.tar.gz: 56c7329c6b851a395287cb12764db16f79b3d9beacec0292184381a61386bd975f3813ff1e5832a0e8cde2fd571550ae696e6ed6d3409d29828e31bdd0ffc81c

data/lib/facebook_ads/ad_objects/ad.rb

@@ -75,7 +75,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "lifetime",
+      "maximum",
       "this_month",
       "this_quarter",
       "this_week_mon_today",
@@ -114,6 +114,7 @@ module FacebookAds
     field :campaign, 'Campaign'
     field :campaign_id, 'string'
     field :configured_status, { enum: -> { CONFIGURED_STATUS }}
+    field :conversion_domain, 'string'
     field :conversion_specs, { list: 'ConversionActionQuery' }
     field :created_time, 'datetime'
     field :creative, 'AdCreative'
@@ -196,6 +197,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 }} }
@@ -218,6 +220,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_account.rb

@@ -87,12 +87,14 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "ANALYZE",
+      "DRAFT",
       "MANAGE",
     ]
 
     TASKS = [
       "ADVERTISE",
       "ANALYZE",
+      "DRAFT",
       "MANAGE",
     ]
 
@@ -143,7 +145,6 @@ module FacebookAds
 
     field :account_id, 'string'
     field :account_status, 'int'
-    field :ad_account_creation_request, 'AdAccountCreationRequest'
     field :ad_account_promotable_objects, 'AdAccountPromotableObjects'
     field :age, 'double'
     field :agency_client_declaration, 'AgencyClientDeclaration'
@@ -223,6 +224,7 @@ module FacebookAds
     has_edge :ad_place_page_sets do |edge|
       edge.get 'AdPlacePageSet'
       edge.post 'AdPlacePageSet' do |api|
+        api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
         api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
         api.has_param :name, 'string'
         api.has_param :parent_page, 'string'
@@ -232,6 +234,7 @@ module FacebookAds
 
     has_edge :ad_place_page_sets_async do |edge|
       edge.post 'AdPlacePageSet' do |api|
+        api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
         api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
         api.has_param :name, 'string'
         api.has_param :parent_page, 'string'
@@ -239,15 +242,6 @@ module FacebookAds
       end
     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
-    end
-
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
     end
@@ -275,6 +269,7 @@ module FacebookAds
         api.has_param :image_url, 'string'
         api.has_param :instagram_actor_id, 'string'
         api.has_param :instagram_permalink_url, 'string'
+        api.has_param :instagram_user_id, 'string'
         api.has_param :instant_checkout_setting, { enum: -> { AdCreative::INSTANT_CHECKOUT_SETTING }}
         api.has_param :interactive_components_spec, 'hash'
         api.has_param :is_dco_internal, 'bool'
@@ -287,11 +282,13 @@ module FacebookAds
         api.has_param :object_story_spec, 'AdCreativeObjectStorySpec'
         api.has_param :object_type, 'string'
         api.has_param :object_url, 'string'
+        api.has_param :place_page_set_id, 'string'
         api.has_param :platform_customizations, 'object'
         api.has_param :playable_asset_id, 'string'
         api.has_param :portrait_customizations, 'hash'
         api.has_param :product_set_id, 'string'
         api.has_param :recommender_settings, 'hash'
+        api.has_param :source_instagram_media_id, 'string'
         api.has_param :template_url, 'string'
         api.has_param :template_url_spec, 'object'
         api.has_param :thumbnail_url, 'string'
@@ -339,16 +336,13 @@ module FacebookAds
       edge.post 'PlayableContent' do |api|
         api.has_param :app_id, 'string'
         api.has_param :name, 'string'
+        api.has_param :session_id, 'string'
         api.has_param :source, 'file'
         api.has_param :source_url, 'string'
         api.has_param :source_zip, 'file'
       end
     end
 
-    has_edge :adreportschedules do |edge|
-      edge.get
-    end
-
     has_edge :adrules_history do |edge|
       edge.get 'AdAccountAdRulesHistory' do |api|
         api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
@@ -383,6 +377,7 @@ module FacebookAds
         api.has_param :adset_spec, 'AdSet'
         api.has_param :audience_id, 'string'
         api.has_param :bid_amount, 'int'
+        api.has_param :conversion_domain, 'string'
         api.has_param :creative, 'AdCreative'
         api.has_param :date_format, 'string'
         api.has_param :display_sequence, 'int'
@@ -402,6 +397,7 @@ module FacebookAds
     has_edge :ads_volume do |edge|
       edge.get 'AdAccountAdVolume' do |api|
         api.has_param :page_id, 'int'
+        api.has_param :recommendation_type, { enum: -> { AdAccountAdVolume::RECOMMENDATION_TYPE }}
         api.has_param :show_breakdown_by_actor, 'bool'
       end
     end
@@ -513,7 +509,6 @@ module FacebookAds
         api.has_param :animated_effect_id, 'int'
         api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
-        api.has_param :attribution_app_id, 'string'
         api.has_param :audio_story_wave_animation_handle, 'string'
         api.has_param :chunk_session_id, 'string'
         api.has_param :composer_entry_picker, 'string'
@@ -565,6 +560,7 @@ module FacebookAds
         api.has_param :sales_promo_id, 'int'
         api.has_param :slideshow_spec, 'hash'
         api.has_param :source, 'file'
+        api.has_param :source_instagram_media_id, 'string'
         api.has_param :spherical, 'bool'
         api.has_param :start_offset, 'int'
         api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
@@ -682,12 +678,14 @@ module FacebookAds
         api.has_param :buying_type, 'string'
         api.has_param :daily_budget, 'int'
         api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
+        api.has_param :is_skadnetwork_attribution, 'bool'
         api.has_param :iterative_split_test_configs, { list: 'object' }
         api.has_param :lifetime_budget, 'int'
         api.has_param :name, 'string'
         api.has_param :objective, { enum: -> { Campaign::OBJECTIVE }}
         api.has_param :pacing_type, { list: 'string' }
         api.has_param :promoted_object, 'object'
+        api.has_param :smart_promotion_type, { enum: -> { Campaign::SMART_PROMOTION_TYPE }}
         api.has_param :source_campaign_id, 'string'
         api.has_param :special_ad_categories, { list: { enum: -> { Campaign::SPECIAL_AD_CATEGORIES }} }
         api.has_param :special_ad_category_country, { list: { enum: -> { Campaign::SPECIAL_AD_CATEGORY_COUNTRY }} }
@@ -705,6 +703,10 @@ module FacebookAds
       end
     end
 
+    has_edge :connected_instagram_accounts do |edge|
+      edge.get 'IgUser'
+    end
+
     has_edge :content_delivery_report do |edge|
       edge.get 'ContentDeliveryReport' do |api|
         api.has_param :end_date, 'datetime'
@@ -716,6 +718,14 @@ module FacebookAds
       end
     end
 
+    has_edge :create_and_apply_publisher_block_list do |edge|
+      edge.post do |api|
+        api.has_param :is_auto_blocking_on, 'bool'
+        api.has_param :name, 'string'
+        api.has_param :publisher_urls, { list: 'string' }
+      end
+    end
+
     has_edge :customaudiences do |edge|
       edge.get 'CustomAudience' do |api|
         api.has_param :business_id, 'string'
@@ -724,8 +734,6 @@ module FacebookAds
         api.has_param :pixel_id, 'string'
       end
       edge.post 'CustomAudience' do |api|
-        api.has_param :accountid, 'string'
-        api.has_param :additionalmetadata, 'string'
         api.has_param :allowed_domains, { list: 'string' }
         api.has_param :associated_audience_id, 'int'
         api.has_param :claim_objective, { enum: -> { CustomAudience::CLAIM_OBJECTIVE }}
@@ -735,28 +743,21 @@ module FacebookAds
         api.has_param :customer_file_source, { enum: -> { CustomAudience::CUSTOMER_FILE_SOURCE }}
         api.has_param :dataset_id, 'string'
         api.has_param :description, 'string'
-        api.has_param :details, 'string'
         api.has_param :enable_fetch_or_create, 'bool'
         api.has_param :event_source_group, 'string'
         api.has_param :event_sources, { list: 'hash' }
         api.has_param :exclusions, { list: 'object' }
-        api.has_param :expectedsize, 'int'
-        api.has_param :gender, 'string'
         api.has_param :inclusions, { list: 'object' }
-        api.has_param :isprivate, 'bool'
         api.has_param :is_household, 'bool'
         api.has_param :is_household_exclusion, 'bool'
         api.has_param :is_snapshot, 'bool'
         api.has_param :is_value_based, 'bool'
         api.has_param :list_of_accounts, { list: 'int' }
         api.has_param :lookalike_spec, 'string'
-        api.has_param :maxage, 'int'
-        api.has_param :minage, 'int'
         api.has_param :name, 'string'
         api.has_param :opt_out_link, 'string'
         api.has_param :origin_audience_id, 'string'
         api.has_param :parent_audience_id, 'int'
-        api.has_param :partnerid, 'string'
         api.has_param :partner_reference_key, 'string'
         api.has_param :pixel_id, 'string'
         api.has_param :prefill, 'bool'
@@ -767,7 +768,6 @@ module FacebookAds
         api.has_param :rule, 'string'
         api.has_param :rule_aggregation, 'string'
         api.has_param :seed_audience, 'int'
-        api.has_param :source, 'string'
         api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
         api.has_param :tags, { list: 'string' }
         api.has_param :video_group_ids, { list: 'string' }
@@ -854,6 +854,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 }} }
@@ -876,6 +877,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
 
@@ -889,6 +891,8 @@ module FacebookAds
         api.has_param :app_store, { enum: -> { AdAccountMatchedSearchApplicationsEdgeData::APP_STORE }}
         api.has_param :app_store_country, 'string'
         api.has_param :business_id, 'string'
+        api.has_param :is_skadnetwork_search, 'bool'
+        api.has_param :only_apps_with_permission, 'bool'
         api.has_param :query_term, 'string'
       end
     end
@@ -1008,15 +1012,6 @@ module FacebookAds
       end
     end
 
-    has_edge :roas do |edge|
-      edge.get 'AdAccountRoas' do |api|
-        api.has_param :fields, { list: 'string' }
-        api.has_param :filtering, { list: 'object' }
-        api.has_param :time_increment, 'string'
-        api.has_param :time_range, 'object'
-      end
-    end
-
     has_edge :saved_audiences do |edge|
       edge.get 'SavedAudience' do |api|
         api.has_param :business_id, 'string'
@@ -1025,15 +1020,6 @@ module FacebookAds
       end
     end
 
-    has_edge :sponsored_message_ads do |edge|
-      edge.post do |api|
-        api.has_param :bid_amount, 'int'
-        api.has_param :daily_budget, 'int'
-        api.has_param :message_creative_id, 'string'
-        api.has_param :targeting, 'Targeting'
-      end
-    end
-
     has_edge :subscribed_apps do |edge|
       edge.delete do |api|
         api.has_param :app_id, 'string'
@@ -1058,9 +1044,12 @@ module FacebookAds
     has_edge :targetingsearch do |edge|
       edge.get 'AdAccountTargetingUnified' do |api|
         api.has_param :allow_only_fat_head_interests, 'bool'
+        api.has_param :app_store, { enum: -> { AdAccountTargetingUnified::APP_STORE }}
         api.has_param :countries, { list: 'string' }
         api.has_param :is_exclusion, 'bool'
         api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
+        api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
+        api.has_param :promoted_object, 'object'
         api.has_param :q, 'string'
         api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
         api.has_param :session_id, 'int'
@@ -1080,6 +1069,7 @@ module FacebookAds
 
     has_edge :targetingsuggestions do |edge|
       edge.get 'AdAccountTargetingUnified' do |api|
+        api.has_param :app_store, { enum: -> { AdAccountTargetingUnified::APP_STORE }}
         api.has_param :countries, { list: 'string' }
         api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
         api.has_param :mode, { enum: -> { AdAccountTargetingUnified::MODE }}
@@ -1102,9 +1092,6 @@ module FacebookAds
     end
 
     has_edge :tracking do |edge|
-      edge.delete do |api|
-        api.has_param :tracking_specs, 'object'
-      end
       edge.get 'AdAccountTrackingData'
       edge.post 'AdAccount' do |api|
         api.has_param :tracking_specs, 'object'

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -26,10 +26,34 @@ module FacebookAds
   # pull request for this class.
 
   class AdAccountAdVolume < AdObject
+    RECOMMENDATION_TYPE = [
+      "ACO_TOGGLE",
+      "AGGREGATED_BID_LIMITED",
+      "AGGREGATED_BUDGET_LIMITED",
+      "AGGREGATED_COST_LIMITED",
+      "AUCTION_OVERLAP",
+      "CREATIVE_FATIGUE",
+      "FRAGMENTATION",
+      "LEARNING_LIMITED",
+      "TOP_ADSETS_WITH_ADS_UNDER_CAP",
+      "TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
+      "UNECONOMICAL_ADS_THROTTLING",
+      "ZERO_IMPRESSION",
+    ]
+
 
     field :actor_id, 'string'
+    field :actor_name, 'string'
+    field :ad_limit_scope_business, 'Business'
+    field :ad_limit_scope_business_manager_id, 'string'
+    field :ad_limit_set_by_page_admin, 'int'
     field :ads_running_or_in_review_count, 'int'
+    field :ads_running_or_in_review_count_subject_to_limit_set_by_page, 'int'
     field :current_account_ads_running_or_in_review_count, 'int'
+    field :future_limit_activation_date, 'string'
+    field :future_limit_on_ads_running_or_in_review, 'int'
+    field :limit_on_ads_running_or_in_review, 'int'
+    field :recommendations, { list: 'object' }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -45,6 +45,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
       "REPLIES",

data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb

@@ -32,6 +32,7 @@ module FacebookAds
       "FB_ANDROID_STORE",
       "FB_CANVAS",
       "FB_GAMEROOM",
+      "GALAXY_STORE",
       "GOOGLE_PLAY",
       "INSTANT_GAME",
       "ITUNES",

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -185,11 +185,21 @@ module FacebookAds
       "zips",
     ]
 
-    MODE = [
-      "best_performing",
-      "recently_used",
-      "related",
-      "suggestions",
+    APP_STORE = [
+      "amazon_app_store",
+      "does_not_exist",
+      "fb_android_store",
+      "fb_canvas",
+      "fb_gameroom",
+      "galaxy_store",
+      "google_play",
+      "instant_game",
+      "itunes",
+      "itunes_ipad",
+      "oculus_app_store",
+      "roku_channel_store",
+      "windows_10_store",
+      "windows_store",
     ]
 
     OBJECTIVE = [
@@ -210,6 +220,13 @@ module FacebookAds
       "VIDEO_VIEWS",
     ]
 
+    MODE = [
+      "best_performing",
+      "recently_used",
+      "related",
+      "suggestions",
+    ]
+
 
     field :audience_size, 'int'
     field :conversion_lift, 'double'

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -96,7 +96,6 @@ module FacebookAds
       "update_campaign_budget",
       "update_campaign_budget_optimization_toggling_status",
       "update_campaign_delivery_type",
-      "update_campaign_duration",
       "update_campaign_group_ad_scheduling",
       "update_campaign_group_delivery_type",
       "update_campaign_group_spend_cap",

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -67,20 +67,26 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
       "SEND_A_GIFT",
+      "SEND_GIFT_MONEY",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",
       "SOTTO_SUBSCRIBE",
+      "START_ORDER",
       "SUBSCRIBE",
+      "SWIPE_UP_PRODUCT",
+      "SWIPE_UP_SHOP",
       "UPDATE_APP",
       "USE_APP",
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
+      "VIDEO_CALL",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -102,7 +108,9 @@ module FacebookAds
     field :groups, { list: 'AdAssetFeedSpecGroupRule' }
     field :images, { list: 'AdAssetFeedSpecImage' }
     field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
+    field :onsite_destinations, { list: 'object' }
     field :optimization_type, 'string'
+    field :posts, { list: 'object' }
     field :titles, { list: 'AdAssetFeedSpecTitle' }
     field :videos, { list: 'AdAssetFeedSpecVideo' }
     has_no_id