facebookbusiness 0.7.0.3 → 0.9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21427a72a89e5b69fcd40fcf556030df9c45494dd4256e7182b654ba4953771e
-  data.tar.gz: d031189ae8b805d79df679a06dfd9dbb418cd523143f0617998934bdce4ea5e7
+  metadata.gz: b65eb9667af0fc7eb2f9c86e67515d083b436660bfea5b637e5cebc22fc5ab7e
+  data.tar.gz: 295bb79900331447bac7cc4f555203e0dd8660b4f22360b74c1f9dafec4390de
 SHA512:
-  metadata.gz: ba42f3cf881a1c1546b115389c241dc085b32877ec7b8259602d25fa6087cd1bec4afe2d546c982b87fc65f74c4a0ee62f4d634eb79d010c88d9698ccb9e6f07
-  data.tar.gz: 0dba0ce20bf17ef53da7214d0a9452ee7273321de7553d9b7c37cc35546c08caa245bad54542068a8003a2dbd8d316e552263d4220e3a1f9794aa8f444dec89f
+  metadata.gz: cb658bda72e696aab26910d5d7a8ec2bae62c0bc0f7d9a0c1c9c4991b53cdc66dd5026b6e5301d46409a2d2edba7eefe30dbb32433adf4925a7131bb988db580
+  data.tar.gz: 9f4f715f3162cb914650677fe17b661717b66393e3804d0fb89a233bf4451e65aa09109086e28fa1bd0b0c158525d1452fb7ebdb3e73f069e41f91aa7e4078e6

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -223,6 +223,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 +233,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 +241,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 +268,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'
@@ -292,6 +286,7 @@ module FacebookAds
         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 +334,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 }}
@@ -402,6 +394,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
@@ -565,6 +558,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 }}
@@ -688,6 +682,7 @@ module FacebookAds
         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 +700,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 +715,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'
@@ -1058,9 +1065,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 +1090,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 +1113,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_targeting_unified.rb

@@ -185,11 +185,20 @@ 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",
+      "google_play",
+      "instant_game",
+      "itunes",
+      "itunes_ipad",
+      "oculus_app_store",
+      "roku_channel_store",
+      "windows_10_store",
+      "windows_store",
     ]
 
     OBJECTIVE = [
@@ -202,6 +211,7 @@ module FacebookAds
       "LOCAL_AWARENESS",
       "MESSAGES",
       "OFFER_CLAIMS",
+      "OUTCOME_LEADS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
       "PRODUCT_CATALOG_SALES",
@@ -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,6 +67,7 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
@@ -76,7 +77,10 @@ module FacebookAds
       "SHOP_NOW",
       "SIGN_UP",
       "SOTTO_SUBSCRIBE",
+      "START_ORDER",
       "SUBSCRIBE",
+      "SWIPE_UP_PRODUCT",
+      "SWIPE_UP_SHOP",
       "UPDATE_APP",
       "USE_APP",
       "USE_MOBILE_APP",
@@ -103,6 +107,7 @@ module FacebookAds
     field :images, { list: 'AdAssetFeedSpecImage' }
     field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
     field :optimization_type, 'string'
+    field :posts, { list: 'object' }
     field :titles, { list: 'AdAssetFeedSpecTitle' }
     field :videos, { list: 'AdAssetFeedSpecVideo' }
     has_no_id

data/lib/facebook_ads/ad_objects/ad_async_request.rb

@@ -35,6 +35,8 @@ module FacebookAds
       "INITIAL",
       "IN_PROGRESS",
       "PENDING_DEPENDENCY",
+      "PROCESS_BY_AD_ASYNC_ENGINE",
+      "PROCESS_BY_EVENT_PROCESSOR",
       "SUCCESS",
       "USER_CANCELED",
       "USER_CANCELED_DEPENDENCY",

data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb

@@ -163,6 +163,8 @@ module FacebookAds
     field :optimization_goal_old, { enum: -> { OPTIMIZATION_GOAL_OLD }}
     field :pacing_type_new, 'int'
     field :pacing_type_old, 'int'
+    field :promoted_object_id_new, 'string'
+    field :promoted_object_id_old, 'string'
     field :run_status_new, 'string'
     field :run_status_old, 'string'
     field :schedule_new, { list: 'object' }
@@ -175,6 +177,8 @@ module FacebookAds
     field :stop_time_old, 'datetime'
     field :targeting_expansion_new, 'object'
     field :targeting_expansion_old, 'object'
+    field :targeting_new, 'object'
+    field :targeting_old, 'object'
     field :updated_time_new, 'datetime'
     field :updated_time_old, 'datetime'
     has_no_post

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -73,6 +73,7 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
@@ -82,7 +83,10 @@ module FacebookAds
       "SHOP_NOW",
       "SIGN_UP",
       "SOTTO_SUBSCRIBE",
+      "START_ORDER",
       "SUBSCRIBE",
+      "SWIPE_UP_PRODUCT",
+      "SWIPE_UP_SHOP",
       "UPDATE_APP",
       "USE_APP",
       "USE_MOBILE_APP",
@@ -179,6 +183,7 @@ module FacebookAds
     field :instagram_actor_id, 'string'
     field :instagram_permalink_url, 'string'
     field :instagram_story_id, 'string'
+    field :instagram_user_id, 'string'
     field :interactive_components_spec, 'AdCreativeInteractiveComponentsSpec'
     field :link_deep_link_url, 'string'
     field :link_destination_display_url, 'string'
@@ -198,6 +203,7 @@ module FacebookAds
     field :portrait_customizations, 'AdCreativePortraitCustomizations'
     field :product_set_id, 'string'
     field :recommender_settings, 'AdCreativeRecommenderSettings'
+    field :source_instagram_media_id, 'string'
     field :status, { enum: -> { STATUS }}
     field :template_url, 'string'
     field :template_url_spec, 'AdCreativeTemplateUrlSpec'

data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdCreativeInteractiveComponentsSpec < AdObject
 
+    field :child_attachments, { list: 'object' }
     field :components, { list: 'object' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb

@@ -67,6 +67,7 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
@@ -76,7 +77,10 @@ module FacebookAds
       "SHOP_NOW",
       "SIGN_UP",
       "SOTTO_SUBSCRIBE",
+      "START_ORDER",
       "SUBSCRIBE",
+      "SWIPE_UP_PRODUCT",
+      "SWIPE_UP_SHOP",
       "UPDATE_APP",
       "USE_APP",
       "USE_MOBILE_APP",

data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb

@@ -47,6 +47,7 @@ module FacebookAds
       "GENDER",
       "INSTANT_ARTICLE_ID",
       "INSTANT_ARTICLE_PAGE_ID",
+      "IS_DEAL_BACKFILL",
       "PLACEMENT",
       "PLACEMENT_NAME",
       "PLATFORM",

data/lib/facebook_ads/ad_objects/ad_place_page_set.rb

@@ -26,6 +26,11 @@ module FacebookAds
   # pull request for this class.
 
   class AdPlacePageSet < AdObject
+    CATEGORY = [
+      "BOPUS",
+      "GENERAL",
+    ]
+
     LOCATION_TYPES = [
       "home",
       "recent",
@@ -44,6 +49,7 @@ module FacebookAds
     field :name, 'string'
     field :pages_count, 'int'
     field :parent_page, 'Page'
+    field :category, 'adaccountad_place_page_sets_category_enum_param'
     field :targeted_area_type, 'adaccountad_place_page_sets_targeted_area_type_enum_param'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -57,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_spec.rb

@@ -38,7 +38,6 @@ module FacebookAds
     field :id, 'string'
     field :insights_section, 'object'
     field :name, 'string'
-    field :report_schedule, 'object'
     field :report_schedule_id, 'string'
     field :sort_by, 'string'
     field :sort_dir, 'string'

data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb

@@ -27,15 +27,19 @@ module FacebookAds
 
   class AdRuleExecutionSpec < AdObject
     EXECUTION_TYPE = [
+      "ADD_INTEREST_RELAXATION",
+      "ADD_QUESTIONNAIRE_INTERESTS",
       "CHANGE_BID",
       "CHANGE_BUDGET",
       "CHANGE_CAMPAIGN_BUDGET",
+      "INCREASE_RADIUS",
       "NOTIFICATION",
       "PAUSE",
       "PING_ENDPOINT",
       "REBALANCE_BUDGET",
       "ROTATE",
       "UNPAUSE",
+      "UPDATE_CREATIVE",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -30,6 +30,7 @@ module FacebookAds
       "CONTINUOUS_LIFT_CONFIG",
       "GEO_LIFT",
       "LIFT",
+      "PRIVATE_LIFT",
       "SPLIT_TEST",
     ]
 
@@ -68,7 +69,6 @@ module FacebookAds
         api.has_param :is_primary, 'bool'
         api.has_param :name, 'string'
         api.has_param :offline_conversion_data_sets, { list: 'object' }
-        api.has_param :offsitepixels, { list: 'object' }
         api.has_param :product_catalogs, { list: 'object' }
         api.has_param :product_sets, { list: 'object' }
         api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -66,10 +66,6 @@ module FacebookAds
       edge.get 'OfflineConversionDataSet'
     end
 
-    has_edge :offsitepixels do |edge|
-      edge.get 'OffsitePixel'
-    end
-
     has_edge :partnerstudies do |edge|
       edge.get 'PartnerStudy'
     end