facebookbusiness 0.3.2.0 → 0.3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b18d705ed30b07dddc8b7d1d1717f68d6143b8700b82173fc61d347b8bffea5
-  data.tar.gz: 7978b2dbe464f82713372f4f74ee494744803a68f5101d0f4707edb1fa69be8a
+  metadata.gz: d6466d1ab146a0a0b152f8ec7713e80eb39e20d0fc70731bc2d18b8bde03a1a6
+  data.tar.gz: def0dcf441b491d10b51e9b79b142e8dab852886af8c37256df26451778f0577
 SHA512:
-  metadata.gz: 88cbf9eac3de2eee0c82fb1e75b9b795f9a4f8ff7d39daeaac2f866db825a962503ce97f5df9918e98546f6914b6d10496705d634e42e98114579db39b787da7
-  data.tar.gz: d9bbc4cde4d0125d29fb8b7dfc681f3f60007e84d86859bc0cf89cc79bcae4e837dd89a1cd6e1ea33b49f42e793b7db07a3a9300a9ce20fb5ce42fc62f17786b
+  metadata.gz: d164528e3906a48adbb04213080ee18bd32c6bde78a487a0f50900ed3b65ac3f092edec64f1ae7c3788674219599976670bec92543130798a7cf79c0f9f3a964
+  data.tar.gz: 52fd288c2c8003850f973c9d94ad530c9a2a4fb45902cc92ff3f572670daa6f2a197cb9cbe8dc3db142d9438a042355eadb7673f789b4076e1f105647b394cd9

data/lib/facebook_ads/ad_objects/ad.rb

@@ -148,11 +148,17 @@ module FacebookAds
     has_edge :adlabels do |edge|
       edge.delete do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
       end
       edge.post 'Ad' do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
+      end
+    end
+
+    has_edge :adrules_governed do |edge|
+      edge.get 'AdRule' do |api|
+        api.has_param :pass_evaluation, 'bool'
       end
     end
 

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -99,6 +99,7 @@ module FacebookAds
     CLAIM_OBJECTIVE = [
       "AUTOMOTIVE_MODEL",
       "HOME_LISTING",
+      "MEDIA_TITLE",
       "PRODUCT",
       "TRAVEL",
       "VEHICLE",
@@ -214,16 +215,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ad_place_page_sets do |edge|
-      edge.get 'AdPlacePageSet'
-      edge.post 'AdPlacePageSet' do |api|
-        api.has_param :name, 'string'
-        api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
-        api.has_param :parent_page, 'string'
-        api.has_param :targeted_area_type, { enum: -> { AdPlacePageSet::TARGETED_AREA_TYPE }}
-      end
-    end
-
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
     end
@@ -389,7 +380,7 @@ module FacebookAds
         api.has_param :date_interval, 'object'
         api.has_param :format_version, 'int'
         api.has_param :creation_source, { enum: %w{adsManagerReporting newAdsManager adsExcelAddin }}
-        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type }} }
+        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type action_converted_product_id }} }
         api.has_param :custom_column_set_id, 'string'
         api.has_param :data_columns, { list: 'string' }
         api.has_param :emails, { list: 'string' }
@@ -456,6 +447,7 @@ module FacebookAds
         api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
+        api.has_param :delete_offset, 'int'
       end
       edge.get 'Ad' do |api|
         api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
@@ -499,6 +491,7 @@ module FacebookAds
         api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
+        api.has_param :delete_offset, 'int'
       end
       edge.get 'AdSet' do |api|
         api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
@@ -766,6 +759,12 @@ module FacebookAds
 
     has_edge :brand_audiences do |edge|
       edge.get 'BrandAudience'
+      edge.post 'BrandAudience' do |api|
+        api.has_param :name, 'string'
+        api.has_param :targeting, 'object'
+        api.has_param :target_size, 'int'
+        api.has_param :description, 'string'
+      end
     end
 
     has_edge :broadtargetingcategories do |edge|
@@ -791,6 +790,7 @@ module FacebookAds
         api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
+        api.has_param :delete_offset, 'int'
       end
       edge.get 'Campaign' do |api|
         api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
@@ -970,6 +970,10 @@ module FacebookAds
       end
     end
 
+    has_edge :impacting_ad_studies do |edge|
+      edge.get 'AdStudy'
+    end
+
     has_edge :insights do |edge|
       edge.get 'AdsInsights' do |api|
         api.has_param :default_summary, 'bool'
@@ -1017,6 +1021,10 @@ module FacebookAds
       end
     end
 
+    has_edge :instagram_accounts do |edge|
+      edge.get 'InstagramUser'
+    end
+
     has_edge :leadgen_forms do |edge|
       edge.get 'LeadgenForm' do |api|
         api.has_param :query, 'string'
@@ -1061,6 +1069,10 @@ module FacebookAds
       edge.get 'OfflineConversionDataSet'
     end
 
+    has_edge :offsitepixels do |edge|
+      edge.get 'OffsitePixel'
+    end
+
     has_edge :partner_integrations do |edge|
       edge.get 'PartnerIntegrationLinked'
       edge.post 'PartnerIntegrationLinked' do |api|
@@ -1136,6 +1148,10 @@ module FacebookAds
       end
     end
 
+    has_edge :promote_pages do |edge|
+      edge.get 'Page'
+    end
+
     has_edge :publisher_block_lists do |edge|
       edge.get 'PublisherBlockList'
       edge.post 'PublisherBlockList' do |api|
@@ -1220,7 +1236,7 @@ module FacebookAds
       edge.post do |api|
         api.has_param :time_ranges, 'object'
         api.has_param :data_columns, { list: 'string' }
-        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type }} }
+        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type action_converted_product_id }} }
         api.has_param :filters, { list: 'object' }
         api.has_param :sort_by, 'string'
         api.has_param :sort_dir, 'string'
@@ -1265,6 +1281,28 @@ module FacebookAds
       end
     end
 
+    has_edge :targetingbrowse do |edge|
+      edge.get 'AdAccountTargetingUnified' do |api|
+        api.has_param :include_nodes, 'bool'
+        api.has_param :excluded_category, 'string'
+        api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
+        api.has_param :is_exclusion, 'bool'
+        api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
+      end
+    end
+
+    has_edge :targetingsearch do |edge|
+      edge.get 'AdAccountTargetingUnified' do |api|
+        api.has_param :q, 'string'
+        api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
+        api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
+        api.has_param :is_exclusion, 'bool'
+        api.has_param :session_id, 'int'
+        api.has_param :targeting_list, { list: 'object' }
+        api.has_param :countries, { list: 'string' }
+      end
+    end
+
     has_edge :targetingsentencelines do |edge|
       edge.get 'TargetingSentenceLine' do |api|
         api.has_param :targeting_spec, 'Targeting'
@@ -1274,6 +1312,28 @@ module FacebookAds
       end
     end
 
+    has_edge :targetingsuggestions do |edge|
+      edge.get 'AdAccountTargetingUnified' do |api|
+        api.has_param :targeting_list, { list: 'object' }
+        api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
+        api.has_param :objects, 'object'
+        api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
+        api.has_param :mode, { enum: -> { AdAccountTargetingUnified::MODE }}
+        api.has_param :session_id, 'int'
+        api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
+        api.has_param :countries, { list: 'string' }
+      end
+    end
+
+    has_edge :targetingvalidation do |edge|
+      edge.get 'AdAccountTargetingUnified' do |api|
+        api.has_param :targeting_list, { list: 'object' }
+        api.has_param :id_list, { list: 'int' }
+        api.has_param :name_list, { list: 'string' }
+        api.has_param :is_exclusion, 'bool'
+      end
+    end
+
     has_edge :timezoneoffsets do |edge|
       edge.get 'TimezoneOffset' do |api|
         api.has_param :start_year, 'int'

data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb

@@ -51,6 +51,7 @@ module FacebookAds
     field :schedule_spec, 'AdRuleScheduleSpec'
     field :timestamp, 'datetime'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_contextual_targeting.rb

@@ -35,6 +35,7 @@ module FacebookAds
     field :parent, 'string'
     field :path, { list: 'string' }
     field :type, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_custom_audience_limits.rb

@@ -33,6 +33,7 @@ module FacebookAds
     field :next_audience_update_available_time, 'string'
     field :rate_limit_reset_time, 'string'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_default_destination.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :destination_id, 'string'
     field :destination_url, 'string'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb

@@ -72,6 +72,7 @@ module FacebookAds
     field :default_objective_for_user, { enum: -> { DEFAULT_OBJECTIVE_FOR_USER }}
     field :objective_for_level, { enum: -> { OBJECTIVE_FOR_LEVEL }}
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -59,6 +59,7 @@ module FacebookAds
     field :estimate_mau, 'int'
     field :estimate_ready, 'bool'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb

@@ -50,6 +50,7 @@ module FacebookAds
     field :unique_id, 'string'
     field :url, 'string'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_max_bid.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :max_bid, 'int'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_placement_usage.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :adset_id, 'string'
     field :placements, 'object'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_promotable_objects.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :promotable_page_ids, { list: 'string' }
     field :promotable_urls, { list: 'string' }
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_recommended_camapaign_budget.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :lifetime, 'string'
     field :objective, 'string'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_roas.rb

@@ -57,6 +57,7 @@ module FacebookAds
     field :yield_7d, 'double'
     field :yield_90d, 'double'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -0,0 +1,305 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdAccountTargetingUnified < AdObject
+    LIMIT_TYPE = [
+      "adgroup_id",
+      "genders",
+      "age_min",
+      "age_max",
+      "country_groups",
+      "countries",
+      "country",
+      "cities",
+      "radius",
+      "regions",
+      "zips",
+      "interests",
+      "location_cluster_ids",
+      "keywords",
+      "education_schools",
+      "education_majors",
+      "work_positions",
+      "work_employers",
+      "relationship_statuses",
+      "interested_in",
+      "locales",
+      "user_adclusters",
+      "excluded_user_adclusters",
+      "conjunctive_user_adclusters",
+      "custom_audiences",
+      "excluded_custom_audiences",
+      "college_years",
+      "education_statuses",
+      "connections",
+      "excluded_connections",
+      "friends_of_connections",
+      "user_event",
+      "dynamic_audience_ids",
+      "excluded_dynamic_audience_ids",
+      "rtb_flag",
+      "site_category",
+      "geo_locations",
+      "excluded_geo_locations",
+      "timezones",
+      "place_page_set_ids",
+      "page_types",
+      "publisher_platforms",
+      "effective_publisher_platforms",
+      "facebook_positions",
+      "effective_facebook_positions",
+      "instagram_positions",
+      "effective_instagram_positions",
+      "messenger_positions",
+      "effective_messenger_positions",
+      "device_platforms",
+      "effective_device_platforms",
+      "audience_network_positions",
+      "effective_audience_network_positions",
+      "whatsapp_positions",
+      "effective_whatsapp_positions",
+      "excluded_publisher_categories",
+      "excluded_publisher_list_ids",
+      "publisher_visibility_categories",
+      "user_device",
+      "mobile_device_model",
+      "excluded_user_device",
+      "excluded_mobile_device_model",
+      "user_os",
+      "wireless_carrier",
+      "family_statuses",
+      "industries",
+      "life_events",
+      "political_views",
+      "politics",
+      "behaviors",
+      "income",
+      "net_worth",
+      "home_type",
+      "home_ownership",
+      "home_value",
+      "ethnic_affinity",
+      "generation",
+      "household_composition",
+      "moms",
+      "office_type",
+      "targeting_optimization",
+      "direct_install_devices",
+      "engagement_specs",
+      "excluded_engagement_specs",
+      "product_audience_specs",
+      "excluded_product_audience_specs",
+      "exclusions",
+      "flexible_spec",
+      "exclude_reached_since",
+      "exclude_previous_days",
+      "app_install_state",
+      "fb_deal_id",
+      "interest_defaults_source",
+      "alternate_auto_targeting_option",
+      "contextual_targeting_categories",
+      "topic",
+      "format",
+      "trending",
+      "gatekeepers",
+      "follow_profiles",
+      "follow_profiles_negative",
+      "location_categories",
+      "user_page_threads",
+      "user_page_threads_excluded",
+      "is_whatsapp_destination_ad",
+      "marketplace_product_categories",
+      "instream_video_sponsorship_placements",
+      "prospecting_audience",
+      "brand_safety_content_severity_levels",
+    ]
+
+    WHITELISTED_TYPES = [
+      "adgroup_id",
+      "genders",
+      "age_min",
+      "age_max",
+      "country_groups",
+      "countries",
+      "country",
+      "cities",
+      "radius",
+      "regions",
+      "zips",
+      "interests",
+      "location_cluster_ids",
+      "keywords",
+      "education_schools",
+      "education_majors",
+      "work_positions",
+      "work_employers",
+      "relationship_statuses",
+      "interested_in",
+      "locales",
+      "user_adclusters",
+      "excluded_user_adclusters",
+      "conjunctive_user_adclusters",
+      "custom_audiences",
+      "excluded_custom_audiences",
+      "college_years",
+      "education_statuses",
+      "connections",
+      "excluded_connections",
+      "friends_of_connections",
+      "user_event",
+      "dynamic_audience_ids",
+      "excluded_dynamic_audience_ids",
+      "rtb_flag",
+      "site_category",
+      "geo_locations",
+      "excluded_geo_locations",
+      "timezones",
+      "place_page_set_ids",
+      "page_types",
+      "publisher_platforms",
+      "effective_publisher_platforms",
+      "facebook_positions",
+      "effective_facebook_positions",
+      "instagram_positions",
+      "effective_instagram_positions",
+      "messenger_positions",
+      "effective_messenger_positions",
+      "device_platforms",
+      "effective_device_platforms",
+      "audience_network_positions",
+      "effective_audience_network_positions",
+      "whatsapp_positions",
+      "effective_whatsapp_positions",
+      "excluded_publisher_categories",
+      "excluded_publisher_list_ids",
+      "publisher_visibility_categories",
+      "user_device",
+      "mobile_device_model",
+      "excluded_user_device",
+      "excluded_mobile_device_model",
+      "user_os",
+      "wireless_carrier",
+      "family_statuses",
+      "industries",
+      "life_events",
+      "political_views",
+      "politics",
+      "behaviors",
+      "income",
+      "net_worth",
+      "home_type",
+      "home_ownership",
+      "home_value",
+      "ethnic_affinity",
+      "generation",
+      "household_composition",
+      "moms",
+      "office_type",
+      "targeting_optimization",
+      "direct_install_devices",
+      "engagement_specs",
+      "excluded_engagement_specs",
+      "product_audience_specs",
+      "excluded_product_audience_specs",
+      "exclusions",
+      "flexible_spec",
+      "exclude_reached_since",
+      "exclude_previous_days",
+      "app_install_state",
+      "fb_deal_id",
+      "interest_defaults_source",
+      "alternate_auto_targeting_option",
+      "contextual_targeting_categories",
+      "topic",
+      "format",
+      "trending",
+      "gatekeepers",
+      "follow_profiles",
+      "follow_profiles_negative",
+      "location_categories",
+      "user_page_threads",
+      "user_page_threads_excluded",
+      "is_whatsapp_destination_ad",
+      "marketplace_product_categories",
+      "instream_video_sponsorship_placements",
+      "prospecting_audience",
+      "brand_safety_content_severity_levels",
+    ]
+
+    MODE = [
+      "best_performing",
+      "recently_used",
+      "related",
+      "suggestions",
+    ]
+
+    OBJECTIVE = [
+      "APP_INSTALLS",
+      "BRAND_AWARENESS",
+      "CONVERSIONS",
+      "EVENT_RESPONSES",
+      "LEAD_GENERATION",
+      "LINK_CLICKS",
+      "LOCAL_AWARENESS",
+      "MESSAGES",
+      "OFFER_CLAIMS",
+      "PAGE_LIKES",
+      "POST_ENGAGEMENT",
+      "PRODUCT_CATALOG_SALES",
+      "REACH",
+      "VIDEO_VIEWS",
+    ]
+
+
+    field :audience_size, 'int'
+    field :conversion_lift, 'double'
+    field :description, 'string'
+    field :id, 'string'
+    field :img, 'string'
+    field :info, 'string'
+    field :info_title, 'string'
+    field :is_recommendation, 'bool'
+    field :key, 'string'
+    field :link, 'string'
+    field :name, 'string'
+    field :parent, 'string'
+    field :partner, 'string'
+    field :path, { list: 'string' }
+    field :performance_rating, 'int'
+    field :raw_name, 'string'
+    field :recommendation_model, 'string'
+    field :search_interest_id, 'string'
+    field :source, 'string'
+    field :spend, 'double'
+    field :type, 'string'
+    field :valid, 'bool'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end