facebookbusiness 16.0.2 → 17.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc233d0ef6c81bb2c9ded5635030dd7735c9b66271828cfab0e0f939358fd71
-  data.tar.gz: c621b2fa80cd4f81d43941cab420ce2d6ca08f0398725198a585a090bfc9f2d9
+  metadata.gz: ea0e8d070321c91fb8b1fec0c476fbecd5fc1da115d3a2d319ce41477d1fac09
+  data.tar.gz: aeabd1ac2204722d7b085770d4cbd9c344cb90f043b52484d3d2f8a08a903294
 SHA512:
-  metadata.gz: 6eda74074e39c3c80caca0b0041946636b63bc5e8c38701007cbe2428ff1d73c3c795c9401f52354bb0bac34214514b43082582fb801b4d006aa27b263cbe0c0
-  data.tar.gz: ecb32522538fbb5bb0ea299ef8e3f3d7f58fa781cde917fd33bd1975235bce17cef5eeed52db4f9b077579990fcbe71f1453fa8a9c4f3fe4d48424cb606775c8
+  metadata.gz: c6ab2202da52dc9005c470250691cf371b474e79323c2020cf80baae31a02de88802d99bf2cba5e12d87732a6af2074fb80abf234f48c64ad1535e6ff0ff126e
+  data.tar.gz: 0d23d40e35c05226cf2d907e5d5aa123af0345a7f521df3eae20d7029eb412f265cbd03c75da55d42f407034cd10d2833b586c58bee2ef29fcd60e0496efd87b

data/lib/facebook_ads/ad_objects/ad.rb

@@ -92,6 +92,11 @@ module FacebookAds
       "validate_only",
     ]
 
+    META_REWARD_ADGROUP_STATUS = [
+      "ACTIVE",
+      "INACTIVE",
+    ]
+
     OPERATOR = [
       "ALL",
       "ANY",
@@ -127,6 +132,7 @@ module FacebookAds
     field :id, 'string'
     field :issues_info, { list: 'AdgroupIssuesInfo' }
     field :last_updated_by_app_id, 'string'
+    field :meta_reward_adgroup_status, 'string'
     field :name, 'string'
     field :preview_shareable_link, 'string'
     field :priority, 'int'
@@ -232,6 +238,7 @@ module FacebookAds
     has_edge :previews do |edge|
       edge.get 'AdPreview' do |api|
         api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
+        api.has_param :creative_feature, { enum: -> { AdPreview::CREATIVE_FEATURE }}
         api.has_param :dynamic_asset_label, 'string'
         api.has_param :dynamic_creative_spec, 'object'
         api.has_param :dynamic_customization, 'object'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -122,6 +122,7 @@ module FacebookAds
     SUBTYPE = [
       "APP",
       "BAG_OF_ACCOUNTS",
+      "BIDDING",
       "CLAIM",
       "CUSTOM",
       "ENGAGEMENT",
@@ -131,6 +132,7 @@ module FacebookAds
       "MEASUREMENT",
       "OFFLINE_CONVERSION",
       "PARTNER",
+      "PRIMARY",
       "REGULATED_CATEGORIES_AUDIENCE",
       "STUDY_RULE_AUDIENCE",
       "VIDEO",
@@ -163,7 +165,7 @@ module FacebookAds
     field :capabilities, { list: 'string' }
     field :created_time, 'datetime'
     field :currency, 'string'
-    field :custom_audience_info, 'AdAccountCustomAudience'
+    field :custom_audience_info, 'CustomAudienceGroup'
     field :disable_reason, 'int'
     field :end_advertiser, 'string'
     field :end_advertiser_name, 'string'
@@ -173,7 +175,6 @@ module FacebookAds
     field :fb_entity, 'int'
     field :funding_source, 'string'
     field :funding_source_details, 'FundingSourceDetails'
-    field :has_advertiser_opted_in_odax, 'bool'
     field :has_migrated_permissions, 'bool'
     field :has_page_authorized_adaccount, 'bool'
     field :id, 'string'
@@ -212,6 +213,13 @@ module FacebookAds
     field :viewable_business, 'Business'
     has_no_delete
 
+    has_edge :account_controls do |edge|
+      edge.get 'AdAccountBusinessConstraints'
+      edge.post 'AdAccountBusinessConstraints' do |api|
+        api.has_param :audience_controls, 'object'
+      end
+    end
+
     has_edge :activities do |edge|
       edge.get 'AdActivity' do |api|
         api.has_param :add_children, 'bool'
@@ -270,6 +278,7 @@ module FacebookAds
         api.has_param :asset_feed_spec, 'object'
         api.has_param :authorization_category, { enum: -> { AdCreative::AUTHORIZATION_CATEGORY }}
         api.has_param :body, 'string'
+        api.has_param :branded_content, 'hash'
         api.has_param :branded_content_sponsor_page_id, 'string'
         api.has_param :bundle_folder_id, 'string'
         api.has_param :call_to_action, 'object'
@@ -279,11 +288,13 @@ module FacebookAds
         api.has_param :destination_set_id, 'string'
         api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
         api.has_param :enable_launch_instant_app, 'bool'
+        api.has_param :facebook_branded_content, 'hash'
         api.has_param :image_crops, 'hash'
         api.has_param :image_file, 'string'
         api.has_param :image_hash, 'string'
         api.has_param :image_url, 'string'
         api.has_param :instagram_actor_id, 'string'
+        api.has_param :instagram_branded_content, 'hash'
         api.has_param :instagram_permalink_url, 'string'
         api.has_param :instagram_user_id, 'string'
         api.has_param :interactive_components_spec, 'hash'
@@ -403,6 +414,7 @@ module FacebookAds
         api.has_param :engagement_audience, 'bool'
         api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
         api.has_param :include_demolink_hashes, 'bool'
+        api.has_param :meta_reward_adgroup_status, { enum: -> { Ad::META_REWARD_ADGROUP_STATUS }}
         api.has_param :name, 'string'
         api.has_param :priority, 'int'
         api.has_param :source_ad_id, 'string'
@@ -412,6 +424,14 @@ module FacebookAds
       end
     end
 
+    has_edge :ads_conversion_goal do |edge|
+      edge.post do |api|
+        api.has_param :description, 'string'
+        api.has_param :goal_name, 'string'
+        api.has_param :single_channel_conversion_events, { list: 'hash' }
+      end
+    end
+
     has_edge :ads_reporting_mmm_reports do |edge|
       edge.get do |api|
         api.has_param :filtering, { list: 'hash' }
@@ -443,6 +463,7 @@ module FacebookAds
         api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
         api.has_param :is_completed, 'bool'
         api.has_param :time_range, 'object'
+        api.has_param :updated_since, 'int'
       end
       edge.post 'AdSet' do |api|
         api.has_param :adlabels, { list: 'object' }
@@ -462,6 +483,8 @@ module FacebookAds
         api.has_param :daily_spend_cap, 'int'
         api.has_param :date_format, 'string'
         api.has_param :destination_type, { enum: -> { AdSet::DESTINATION_TYPE }}
+        api.has_param :dsa_beneficiary, 'string'
+        api.has_param :dsa_payor, 'string'
         api.has_param :end_time, 'datetime'
         api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
         api.has_param :existing_customer_budget_percentage, 'int'
@@ -491,7 +514,6 @@ module FacebookAds
         api.has_param :time_stop, 'datetime'
         api.has_param :topline_id, 'string'
         api.has_param :tune_for_category, { enum: -> { AdSet::TUNE_FOR_CATEGORY }}
-        api.has_param :upstream_events, 'hash'
       end
     end
 
@@ -717,7 +739,6 @@ module FacebookAds
         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
     end
 
@@ -732,9 +753,14 @@ module FacebookAds
       edge.get 'IgUser'
     end
 
+    has_edge :conversion_goals do |edge|
+      edge.get
+    end
+
     has_edge :customaudiences do |edge|
       edge.get 'CustomAudience' do |api|
         api.has_param :business_id, 'string'
+        api.has_param :fetch_primary_audience, 'bool'
         api.has_param :fields, { list: 'string' }
         api.has_param :filtering, { list: 'object' }
         api.has_param :pixel_id, 'string'
@@ -772,6 +798,7 @@ module FacebookAds
         api.has_param :rule, 'string'
         api.has_param :rule_aggregation, 'string'
         api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
+        api.has_param :use_in_campaigns, 'bool'
         api.has_param :video_group_ids, { list: 'string' }
       end
     end
@@ -815,6 +842,7 @@ module FacebookAds
       edge.get 'AdPreview' do |api|
         api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
         api.has_param :creative, 'AdCreative'
+        api.has_param :creative_feature, { enum: -> { AdPreview::CREATIVE_FEATURE }}
         api.has_param :dynamic_asset_label, 'string'
         api.has_param :dynamic_creative_spec, 'object'
         api.has_param :dynamic_customization, 'object'
@@ -1059,6 +1087,7 @@ module FacebookAds
         api.has_param :is_exclusion, 'bool'
         api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
         api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
+        api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
         api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
       end
     end
@@ -1074,6 +1103,7 @@ module FacebookAds
         api.has_param :promoted_object, 'object'
         api.has_param :q, 'string'
         api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
+        api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
         api.has_param :session_id, 'int'
         api.has_param :targeting_list, { list: 'object' }
         api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
@@ -1098,6 +1128,7 @@ module FacebookAds
         api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
         api.has_param :objects, 'object'
         api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
+        api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
         api.has_param :session_id, 'int'
         api.has_param :targeting_list, { list: 'object' }
         api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -27,7 +27,12 @@ module FacebookAds
 
   class AdAccountAdVolume < AdObject
     RECOMMENDATION_TYPE = [
+      "AB_TEST",
       "ACO_TOGGLE",
+      "ADS_REPORTING",
+      "ADVANTAGE_PLUS_CREATIVE",
+      "AD_OBJECTIVE",
+      "AEM_V2_INELIGIBLE",
       "AGGREGATED_BID_LIMITED",
       "AGGREGATED_BUDGET_LIMITED",
       "AGGREGATED_COST_LIMITED",
@@ -36,25 +41,42 @@ module FacebookAds
       "AUDIENCE_EXPANSION",
       "AUTOFLOW_OPT_IN",
       "AUTOMATIC_PLACEMENTS",
+      "AUTO_BID",
+      "BROAD_TARGETING",
       "CAPI",
+      "CONNECT_FACEBOOK_PAGE_TO_INSTAGRAM",
+      "CONNECT_FACEBOOK_PAGE_TO_WHATSAPP",
       "COST_GOAL",
       "COST_GOAL_BUDGET_LIMITED",
       "COST_GOAL_CPA_LIMITED",
       "CREATIVE_BADGE",
       "CREATIVE_FATIGUE",
+      "CREATIVE_FATIGUE_HOURLY",
       "CREATIVE_LIMITED",
+      "CREATIVE_LIMITED_HOURLY",
       "DEAD_LINK",
       "ECOSYSTEM_BID_REDUCE_L1_CARDINALITY",
       "FRAGMENTATION",
+      "GES_TEST",
       "LEARNING_LIMITED",
       "LOW_OUTCOME",
       "MMT_CAROUSEL_TO_VIDEO",
+      "MOBILE_FIRST_VIDEO",
       "MULTI_TEXT",
       "MUSIC",
+      "OPTIMAL_SPEND",
+      "PAYMENT_METHOD",
+      "PFR_L1_INLINE_MMT",
       "PREDICTIVE_CREATIVE_LIMITED",
+      "PREDICTIVE_CREATIVE_LIMITED_HOURLY",
       "REVERT",
+      "SCALE_GOOD_CAMPAIGN",
       "SEMANTIC_BASED_AUDIENCE_EXPANSION",
+      "SETUP_PIXEL",
+      "SHOPS_ADS",
       "SIGNALS_GROWTH_CAPI",
+      "SIX_PLUS_MANUAL_PLACEMENTS",
+      "SPEND_LIMIT",
       "SYD_TEST_MODE",
       "TOP_ADSETS_WITH_ADS_UNDER_CAP",
       "TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",

data/lib/facebook_ads/ad_objects/{instant_article_insights_query_result.rb → ad_account_business_constraints.rb}

@@ -25,33 +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 InstantArticleInsightsQueryResult < AdObject
-    BREAKDOWN = [
-      "age",
-      "country",
-      "gender",
-      "gender_and_age",
-      "is_organic",
-      "is_shared_by_ia_owner",
-      "no_breakdown",
-      "platform",
-      "region",
-    ]
+  class AdAccountBusinessConstraints < AdObject
 
-    PERIOD = [
-      "day",
-      "days_28",
-      "lifetime",
-      "month",
-      "total_over_range",
-      "week",
-    ]
-
-
-    field :breakdowns, 'hash'
-    field :name, 'string'
-    field :time, 'datetime'
-    field :value, 'string'
+    field :audience_controls, 'object'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -48,6 +48,7 @@ module FacebookAds
       "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
+      "SUBSCRIBERS",
       "THRUPLAY",
       "VALUE",
       "VISIT_INSTAGRAM_PROFILE",
@@ -59,7 +60,7 @@ module FacebookAds
     field :estimate_mau_lower_bound, 'int'
     field :estimate_mau_upper_bound, 'int'
     field :estimate_ready, 'bool'
-    field :targeting_optimization_types, 'hash'
+    field :targeting_optimization_types, { list: 'hash' }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb

@@ -42,6 +42,8 @@ module FacebookAds
       "INSTANT_GAME",
       "ITUNES",
       "ITUNES_IPAD",
+      "NEON_ANDROID_STORE",
+      "NONE",
       "OCULUS_APP_STORE",
       "OPPO",
       "ROKU_STORE",

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -64,16 +64,273 @@ module FacebookAds
       "ONLINE_GAMBLING_AND_GAMING",
     ]
 
+    REGULATED_COUNTRIES = [
+      "AD",
+      "AE",
+      "AF",
+      "AG",
+      "AI",
+      "AL",
+      "AM",
+      "AN",
+      "AO",
+      "AQ",
+      "AR",
+      "AS",
+      "AT",
+      "AU",
+      "AW",
+      "AX",
+      "AZ",
+      "BA",
+      "BB",
+      "BD",
+      "BE",
+      "BF",
+      "BG",
+      "BH",
+      "BI",
+      "BJ",
+      "BL",
+      "BM",
+      "BN",
+      "BO",
+      "BQ",
+      "BR",
+      "BS",
+      "BT",
+      "BV",
+      "BW",
+      "BY",
+      "BZ",
+      "CA",
+      "CC",
+      "CD",
+      "CF",
+      "CG",
+      "CH",
+      "CI",
+      "CK",
+      "CL",
+      "CM",
+      "CN",
+      "CO",
+      "CR",
+      "CU",
+      "CV",
+      "CW",
+      "CX",
+      "CY",
+      "CZ",
+      "DE",
+      "DJ",
+      "DK",
+      "DM",
+      "DO",
+      "DZ",
+      "EC",
+      "EE",
+      "EG",
+      "EH",
+      "ER",
+      "ES",
+      "ET",
+      "FI",
+      "FJ",
+      "FK",
+      "FM",
+      "FO",
+      "FR",
+      "GA",
+      "GB",
+      "GD",
+      "GE",
+      "GF",
+      "GG",
+      "GH",
+      "GI",
+      "GL",
+      "GM",
+      "GN",
+      "GP",
+      "GQ",
+      "GR",
+      "GS",
+      "GT",
+      "GU",
+      "GW",
+      "GY",
+      "HK",
+      "HM",
+      "HN",
+      "HR",
+      "HT",
+      "HU",
+      "ID",
+      "IE",
+      "IL",
+      "IM",
+      "IN",
+      "IO",
+      "IQ",
+      "IR",
+      "IS",
+      "IT",
+      "JE",
+      "JM",
+      "JO",
+      "JP",
+      "KE",
+      "KG",
+      "KH",
+      "KI",
+      "KM",
+      "KN",
+      "KP",
+      "KR",
+      "KW",
+      "KY",
+      "KZ",
+      "LA",
+      "LB",
+      "LC",
+      "LI",
+      "LK",
+      "LR",
+      "LS",
+      "LT",
+      "LU",
+      "LV",
+      "LY",
+      "MA",
+      "MC",
+      "MD",
+      "ME",
+      "MF",
+      "MG",
+      "MH",
+      "MK",
+      "ML",
+      "MM",
+      "MN",
+      "MO",
+      "MP",
+      "MQ",
+      "MR",
+      "MS",
+      "MT",
+      "MU",
+      "MV",
+      "MW",
+      "MX",
+      "MY",
+      "MZ",
+      "NA",
+      "NC",
+      "NE",
+      "NF",
+      "NG",
+      "NI",
+      "NL",
+      "NO",
+      "NP",
+      "NR",
+      "NU",
+      "NZ",
+      "OM",
+      "PA",
+      "PE",
+      "PF",
+      "PG",
+      "PH",
+      "PK",
+      "PL",
+      "PM",
+      "PN",
+      "PR",
+      "PS",
+      "PT",
+      "PW",
+      "PY",
+      "QA",
+      "RE",
+      "RO",
+      "RS",
+      "RU",
+      "RW",
+      "SA",
+      "SB",
+      "SC",
+      "SD",
+      "SE",
+      "SG",
+      "SH",
+      "SI",
+      "SJ",
+      "SK",
+      "SL",
+      "SM",
+      "SN",
+      "SO",
+      "SR",
+      "SS",
+      "ST",
+      "SV",
+      "SX",
+      "SY",
+      "SZ",
+      "TC",
+      "TD",
+      "TF",
+      "TG",
+      "TH",
+      "TJ",
+      "TK",
+      "TL",
+      "TM",
+      "TN",
+      "TO",
+      "TR",
+      "TT",
+      "TV",
+      "TW",
+      "TZ",
+      "UA",
+      "UG",
+      "UM",
+      "US",
+      "UY",
+      "UZ",
+      "VA",
+      "VC",
+      "VE",
+      "VG",
+      "VI",
+      "VN",
+      "VU",
+      "WF",
+      "WS",
+      "XK",
+      "YE",
+      "YT",
+      "ZA",
+      "ZM",
+      "ZW",
+    ]
+
     WHITELISTED_TYPES = [
       "adgroup_id",
       "age_max",
       "age_min",
+      "age_range",
       "alternate_auto_targeting_option",
       "app_install_state",
       "audience_network_positions",
       "behaviors",
       "brand_safety_content_filter_levels",
       "brand_safety_content_severity_levels",
+      "cafe_ca_contraction_targeting_signal",
+      "cafe_ca_expansion_targeting_signal",
       "catalog_based_targeting",
       "cities",
       "city_keys",
@@ -205,6 +462,8 @@ module FacebookAds
       "instant_game",
       "itunes",
       "itunes_ipad",
+      "neon_android_store",
+      "none",
       "oculus_app_store",
       "oppo",
       "roku_channel_store",

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -51,9 +51,11 @@ module FacebookAds
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
+      "GET_PROMOTIONS",
       "GET_QUOTE",
       "GET_SHOWTIMES",
       "GET_STARTED",
+      "INQUIRE_NOW",
       "INSTALL_APP",
       "INSTALL_MOBILE_APP",
       "LEARN_MORE",
@@ -104,6 +106,7 @@ module FacebookAds
 
     field :ad_formats, { list: 'string' }
     field :additional_data, 'object'
+    field :app_product_page_id, 'string'
     field :asset_customization_rules, { list: 'object' }
     field :autotranslate, { list: 'string' }
     field :bodies, { list: 'AdAssetFeedSpecBody' }

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb

@@ -48,6 +48,7 @@ module FacebookAds
       "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
+      "SUBSCRIBERS",
       "THRUPLAY",
       "VALUE",
       "VISIT_INSTAGRAM_PROFILE",
@@ -59,7 +60,7 @@ module FacebookAds
     field :estimate_mau_lower_bound, 'int'
     field :estimate_mau_upper_bound, 'int'
     field :estimate_ready, 'bool'
-    field :targeting_optimization_types, 'hash'
+    field :targeting_optimization_types, { list: 'hash' }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb

@@ -27,7 +27,7 @@ module FacebookAds
 
   class AdCampaignDeliveryStatsUnsupportedReasons < AdObject
 
-    field :reason_data, 'hash'
+    field :reason_data, { list: 'hash' }
     field :reason_type, 'string'
     has_no_id
     has_no_get