facebookbusiness 0.9.0.1 → 0.11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ca4f8749f72bc1cd7eba12b4bcd07c4d4621e95efd3f028e21982037c378e7
-  data.tar.gz: e532f62cf2f842d6a18bc3916aa07bd3799fa4ca2979df9ea3e8362168893cb9
+  metadata.gz: fec74f5f72f11c85476ecc7dc8839ea82aefb6524a40ae818ada89a8c9167bd6
+  data.tar.gz: 03c440a7286c6eb07ab1a649bcd9e2ca872fa802e15e18ef073a96e462823d97
 SHA512:
-  metadata.gz: 7fb8c27d58ddd9e18a5304adb7ce70031e3e5d1c8c0c3c0d8f09dbf1cd84a6e8a33ea45e2d9c8bc5191bc2fe4b389ecaab36b090855252cbe3e2b95bc66256ac
-  data.tar.gz: 3985f549327ac4d822b6614f6555815f0586ebfae93d2657c42919bf4a04ccd11d5eed5040491b436bee186cf279d76af96f87b2e3618349ecf0ba39ec5c7210
+  metadata.gz: 3f3c81b7c765098c65a0e43b4b5d9f26956edc94e35661e476bef94e77d7fbda03a8178b00fde5df24b7f9dfbc27638026eca2dbc0b36fbea155f7240350dd0e
+  data.tar.gz: 1552eaa602c200a8626b51f6acc2f3faf550030a4247d15b0479fe41ae7603075c782cfd69536cc1caccff2d4224fd532c6e56db270a4b170fabfc692dce8b9b

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

@@ -84,15 +84,10 @@ module FacebookAds
       "ZAR",
     ]
 
-    PERMITTED_TASKS = [
-      "ADVERTISE",
-      "ANALYZE",
-      "MANAGE",
-    ]
-
     TASKS = [
       "ADVERTISE",
       "ANALYZE",
+      "DRAFT",
       "MANAGE",
     ]
 
@@ -143,7 +138,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'
@@ -241,10 +235,20 @@ module FacebookAds
       end
     end
 
+    has_edge :ad_saved_keywords do |edge|
+      edge.get do |api|
+        api.has_param :fields, { list: 'string' }
+      end
+    end
+
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
     end
 
+    has_edge :adcloudplayables do |edge|
+      edge.get
+    end
+
     has_edge :adcreatives do |edge|
       edge.get 'AdCreative'
       edge.post 'AdCreative' do |api|
@@ -281,6 +285,7 @@ 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'
@@ -375,6 +380,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'
@@ -506,7 +512,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'
@@ -589,10 +594,6 @@ module FacebookAds
         api.has_param :business, 'string'
       end
       edge.get 'Business'
-      edge.post 'AdAccount' do |api|
-        api.has_param :business, 'string'
-        api.has_param :permitted_tasks, { list: { enum: -> { AdAccount::PERMITTED_TASKS }} }
-      end
     end
 
     has_edge :applications do |edge|
@@ -638,13 +639,6 @@ module FacebookAds
       end
     end
 
-    has_edge :audiencereplace do |edge|
-      edge.post do |api|
-        api.has_param :payload, 'object'
-        api.has_param :session, 'object'
-      end
-    end
-
     has_edge :block_list_drafts do |edge|
       edge.post 'AdAccount' do |api|
         api.has_param :publisher_urls_file, 'file'
@@ -676,6 +670,7 @@ 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'
@@ -687,7 +682,9 @@ module FacebookAds
         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 }} }
         api.has_param :spend_cap, 'int'
+        api.has_param :start_time, 'datetime'
         api.has_param :status, { enum: -> { Campaign::STATUS }}
+        api.has_param :stop_time, 'datetime'
         api.has_param :topline_id, 'string'
         api.has_param :upstream_events, 'hash'
       end
@@ -731,8 +728,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 }}
@@ -742,28 +737,19 @@ 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'
@@ -773,10 +759,7 @@ module FacebookAds
         api.has_param :rev_share_policy_id, 'int'
         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' }
       end
     end
@@ -861,6 +844,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 }} }
@@ -883,6 +867,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
 
@@ -890,12 +875,20 @@ module FacebookAds
       edge.get 'InstagramUser'
     end
 
+    has_edge :ios_fourteen_campaign_limits do |edge|
+      edge.get 'AdAccountIosFourteenCampaignLimits' do |api|
+        api.has_param :app_id, 'string'
+      end
+    end
+
     has_edge :matched_search_applications do |edge|
       edge.get 'AdAccountMatchedSearchApplicationsEdgeData' do |api|
         api.has_param :allow_incomplete_app, 'bool'
         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
@@ -933,8 +926,6 @@ module FacebookAds
         api.has_param :event_sources, { list: 'hash' }
         api.has_param :exclusions, { list: 'object' }
         api.has_param :inclusions, { list: 'object' }
-        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 :name, 'string'
@@ -942,9 +933,7 @@ module FacebookAds
         api.has_param :parent_audience_id, 'int'
         api.has_param :product_set_id, 'string'
         api.has_param :rev_share_policy_id, 'int'
-        api.has_param :seed_audience, 'int'
         api.has_param :subtype, { enum: -> { AdAccount::SUBTYPE }}
-        api.has_param :tags, { list: 'string' }
       end
     end
 
@@ -1015,15 +1004,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'
@@ -1032,15 +1012,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'

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/{user_payment_modules_options.rb → ad_account_ios_fourteen_campaign_limits.rb}

@@ -25,12 +25,11 @@ 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 UserPaymentModulesOptions < AdObject
+  class AdAccountIosFourteenCampaignLimits < AdObject
 
-    field :account_id, 'string'
-    field :available_payment_options, { list: 'object' }
-    field :country, 'string'
-    field :currency, 'string'
+    field :campaign_group_limit, 'int'
+    field :campaign_group_limits_details, { list: 'object' }
+    field :campaign_limit, 'int'
     has_no_id
     has_no_get
     has_no_post

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

@@ -95,6 +95,7 @@ module FacebookAds
       "effective_facebook_positions",
       "effective_instagram_positions",
       "effective_messenger_positions",
+      "effective_oculus_positions",
       "effective_publisher_platforms",
       "effective_whatsapp_positions",
       "engagement_specs",
@@ -153,6 +154,7 @@ module FacebookAds
       "mobile_device_model",
       "moms",
       "net_worth",
+      "oculus_positions",
       "office_type",
       "page_types",
       "place_page_set_ids",
@@ -191,6 +193,7 @@ module FacebookAds
       "fb_android_store",
       "fb_canvas",
       "fb_gameroom",
+      "galaxy_store",
       "google_play",
       "instant_game",
       "itunes",
@@ -211,7 +214,6 @@ module FacebookAds
       "LOCAL_AWARENESS",
       "MESSAGES",
       "OFFER_CLAIMS",
-      "OUTCOME_LEADS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
       "PRODUCT_CATALOG_SALES",

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -73,6 +73,7 @@ module FacebookAds
       "SEE_MORE",
       "SELL_NOW",
       "SEND_A_GIFT",
+      "SEND_GIFT_MONEY",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",
@@ -85,6 +86,7 @@ module FacebookAds
       "USE_APP",
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
+      "VIDEO_CALL",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -106,6 +108,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_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",

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

@@ -26,12 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class AdCreative < AdObject
-    APPLINK_TREATMENT = [
-      "deeplink_with_appstore_fallback",
-      "deeplink_with_web_fallback",
-      "web_only",
-    ]
-
     CALL_TO_ACTION_TYPE = [
       "ADD_TO_CART",
       "APPLY_NOW",
@@ -79,6 +73,7 @@ module FacebookAds
       "SEE_MORE",
       "SELL_NOW",
       "SEND_A_GIFT",
+      "SEND_GIFT_MONEY",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",
@@ -91,6 +86,7 @@ module FacebookAds
       "USE_APP",
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
+      "VIDEO_CALL",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -121,6 +117,12 @@ module FacebookAds
       "WITH_ISSUES",
     ]
 
+    APPLINK_TREATMENT = [
+      "deeplink_with_appstore_fallback",
+      "deeplink_with_web_fallback",
+      "web_only",
+    ]
+
     AUTHORIZATION_CATEGORY = [
       "NONE",
       "POLITICAL",
@@ -158,7 +160,7 @@ module FacebookAds
     field :account_id, 'string'
     field :actor_id, 'string'
     field :adlabels, { list: 'AdLabel' }
-    field :applink_treatment, { enum: -> { APPLINK_TREATMENT }}
+    field :applink_treatment, 'string'
     field :asset_feed_spec, 'AdAssetFeedSpec'
     field :authorization_category, 'string'
     field :auto_update, 'bool'