facebookbusiness 0.8.0.3 → 0.9.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a33ca32c8748ade89d079a80d94c8b4e6c02a547db4bff11c03e1a2a7979dbc
-  data.tar.gz: 6414909aacd097b547c3ed836eddff3ae622ef2f6d31a5822d35f4d27201101d
+  metadata.gz: 9c36f6e242fd4cec146381dac5e228ef01fd737b460928f7e69cccbd82910796
+  data.tar.gz: 65295aa5a6e1fca467c42f8b98f01849c694bac3beee5f4cbcac1afbeef967e8
 SHA512:
-  metadata.gz: 1d1164b46627d07f5cd9ad5e70815a4617e31fcd5eea8cf80d54f655557ec9ce976550779f63f305f8d148e60cf179610ebe07cc7d2ff214f6dbb85755ebaa01
-  data.tar.gz: ee85a21d581897a5eb06001f0d654242d7b019ffef05870800ca750dcc730c4d3b4b4c075f7eac3a63a00c6f6d87aba9ea2286d9b1dd99be4d7cfe0d16212803
+  metadata.gz: 2db7210fc2d9a10f1820442275ff59ffd1660ac7725e23c2b69257d2770a789acdf182315af7ff984ca7e18dfebe5a3eb956465c674eeac420dc7536bceda6ce
+  data.tar.gz: 97defd9e92df6e08dfd6187f8c38a1b36695037512c86476a061dbc22304017ce15f4bc03061ff71b02c65613347e72ecd40ea03c006e24fc9de13ad3b411187

data/lib/facebook_ads/ad_objects/ad.rb

@@ -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'
@@ -268,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'
@@ -280,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'
@@ -332,6 +336,7 @@ 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'
@@ -372,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'
@@ -503,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'
@@ -555,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 }}
@@ -672,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 }} }
@@ -695,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'
@@ -852,6 +864,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 }} }
@@ -874,6 +887,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
 
@@ -887,6 +901,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
@@ -1006,15 +1022,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'
@@ -1023,15 +1030,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'
@@ -1056,9 +1054,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'
@@ -1078,6 +1079,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 }}
@@ -1100,9 +1102,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

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdAccountAdVolume < AdObject
     RECOMMENDATION_TYPE = [
+      "ACO_TOGGLE",
       "AGGREGATED_BID_LIMITED",
       "AGGREGATED_BUDGET_LIMITED",
       "AGGREGATED_COST_LIMITED",

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,6 +67,7 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
@@ -76,11 +77,15 @@ module FacebookAds
       "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,6 +107,7 @@ 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' }

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

@@ -30,14 +30,12 @@ module FacebookAds
       "COST_CAP",
       "LOWEST_COST_WITHOUT_CAP",
       "LOWEST_COST_WITH_BID_CAP",
-      "TARGET_COST",
     ]
 
     BID_STRATEGY_OLD = [
       "COST_CAP",
       "LOWEST_COST_WITHOUT_CAP",
       "LOWEST_COST_WITH_BID_CAP",
-      "TARGET_COST",
     ]
 
     BILLING_EVENT_NEW = [
@@ -45,10 +43,12 @@ module FacebookAds
       "CLICKS",
       "IMPRESSIONS",
       "LINK_CLICKS",
+      "LISTING_INTERACTION",
       "NONE",
       "OFFER_CLAIMS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PURCHASE",
       "THRUPLAY",
     ]
 
@@ -57,10 +57,12 @@ module FacebookAds
       "CLICKS",
       "IMPRESSIONS",
       "LINK_CLICKS",
+      "LISTING_INTERACTION",
       "NONE",
       "OFFER_CLAIMS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PURCHASE",
       "THRUPLAY",
     ]
 
@@ -83,6 +85,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
       "REPLIES",
@@ -112,6 +115,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
       "REPLIES",
@@ -163,6 +167,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 +181,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_campaign_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_creative.rb

@@ -73,6 +73,7 @@ module FacebookAds
       "PLAY_GAME",
       "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REFER_FRIENDS",
       "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
@@ -82,11 +83,15 @@ module FacebookAds
       "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",
@@ -179,6 +184,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 +204,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'