facebookbusiness 0.6.0.1 → 0.7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 024c4db63b2adfad79667e6553f21a17742c826f990f2e40446121e9f22939cd
-  data.tar.gz: 66864433b2635e5c2617b649f573522c68233fa66cb6785ba5138dfed12c28d9
+  metadata.gz: 20ef851cac669750e7aba58e6120cbd85343bffed78446722ed6991910b30f08
+  data.tar.gz: 2ed325e1cd2b5422a94e5347e1bba6da3de332e0ab8b15b2f6f1619ff5077b23
 SHA512:
-  metadata.gz: 591f39f45845b9b00568aef451bdf766d51026bf61871ba08e897fb357106dd9922cede347ad61b818f6fe296e2eef22a70b6d236ecbb497c8bd22c5db56a40d
-  data.tar.gz: f4001c5d05f6ae63fdcdfe1b13707f7cecfa056e2476b92fb8dee0a735a5aae95fb3c954aac9e43d27bd55353b9a4ad9ba3eb749398bad28b682482bb2ec897e
+  metadata.gz: 71701986ff59c11781aa63283d700eb460b022bb2e050525ff81eebcc903eb1a0538b9ae497cc487e441f0f3b0e8f9b32486934d9a2286a7d9f68048ee5c76bd
+  data.tar.gz: d69460340c74263dd3226f35ee92294dd29c0852aa1a6ded399b042b35f861159fe76f848a442b27e112c7d6dbb2e99483ca8516cdf5f8e68917c9e65330e790

data/lib/facebook_ads/ad_objects/ad.rb

@@ -123,7 +123,6 @@ module FacebookAds
     field :engagement_audience, 'bool'
     field :failed_delivery_checks, { list: 'DeliveryCheck' }
     field :id, 'string'
-    field :is_autobid, 'bool'
     field :issues_info, { list: 'AdgroupIssuesInfo' }
     field :last_updated_by_app_id, 'string'
     field :name, 'string'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -118,6 +118,8 @@ module FacebookAds
       "FLIGHT",
       "HOME_LISTING",
       "HOTEL",
+      "LOCAL_SERVICE_BUSINESS",
+      "LOCATION_BASED_ITEM",
       "MEDIA_TITLE",
       "OFFLINE_PRODUCT",
       "PRODUCT",
@@ -277,6 +279,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 :instant_checkout_setting, { enum: -> { AdCreative::INSTANT_CHECKOUT_SETTING }}
         api.has_param :interactive_components_spec, 'hash'
         api.has_param :is_dco_internal, 'bool'
         api.has_param :link_og_id, 'string'
@@ -348,35 +351,6 @@ module FacebookAds
 
     has_edge :adreportschedules do |edge|
       edge.get
-      edge.post do |api|
-        api.has_param :actions_group_by, { list: { enum: %w{action_brand action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_category action_converted_brand_tag_id action_converted_category_tag_id action_converted_product_id action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type attribution_model_type interactive_component_sticker_id interactive_component_sticker_response }} }
-        api.has_param :breakdowns, { list: 'string' }
-        api.has_param :builtin_column_set, { enum: %w{ APP_ENGAGEMENT AUDIENCE_DIRECT BIDDING_AND_OPTIMIZATION CAROUSEL_ENGAGEMENT CROSS_DEVICE DELIVERY ENGAGEMENT HOUSEHOLD MESSAGING_ENGAGEMENT MESSENGER OFFLINE_CONVERSIONS PERFORMANCE PERFORMANCE_LEGACY TARGETING_AND_CREATIVE VALIDATION_VIEW VIDEO_ENGAGEMENT }}
-        api.has_param :creation_source, { enum: %w{adsExcelAddin adsManagerReporting newAdsManager }}
-        api.has_param :custom_column_set_id, 'string'
-        api.has_param :data_columns, { list: 'string' }
-        api.has_param :date_interval, 'object'
-        api.has_param :date_preset, { enum: %w{last_14d last_28d last_30d last_3d last_7d last_90d last_month last_quarter last_week_mon_sun last_week_sun_sat last_year lifetime this_month this_quarter this_week_mon_today this_week_sun_today this_year today yesterday }}
-        api.has_param :emails, { list: 'string' }
-        api.has_param :export_columns, 'object'
-        api.has_param :filters, { list: 'object' }
-        api.has_param :format_version, 'int'
-        api.has_param :insights_section, 'object'
-        api.has_param :level, { enum: %w{account ad adgroup campaign campaign_group politicalad }}
-        api.has_param :name, 'string'
-        api.has_param :normalized_filter, { list: 'object' }
-        api.has_param :schedule_frequency, { enum: %w{daily monthly weekly }}
-        api.has_param :sort, { list: 'object' }
-        api.has_param :sort_by, 'string'
-        api.has_param :sort_dir, 'string'
-        api.has_param :start_date, 'object'
-        api.has_param :status, { enum: %w{Active Deleted Paused }}
-        api.has_param :subscribers, { list: 'int' }
-        api.has_param :time_increment, 'string'
-        api.has_param :user_attribution_windows, { list: 'string' }
-        api.has_param :user_columns, { list: 'string' }
-        api.has_param :user_filter, { list: 'object' }
-      end
     end
 
     has_edge :adrules_history do |edge|
@@ -402,13 +376,10 @@ module FacebookAds
 
     has_edge :ads do |edge|
       edge.get 'Ad' do |api|
-        api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
         api.has_param :effective_status, { list: 'string' }
-        api.has_param :include_drafts, 'bool'
         api.has_param :time_range, 'object'
         api.has_param :updated_since, 'int'
-        api.has_param :use_employee_draft, 'bool'
       end
       edge.post 'Ad' do |api|
         api.has_param :adlabels, { list: 'object' }
@@ -435,7 +406,7 @@ module FacebookAds
     has_edge :ads_volume do |edge|
       edge.get 'AdAccountAdVolume' do |api|
         api.has_param :page_id, 'int'
-        api.has_param :show_ad_limit_by_actor, 'bool'
+        api.has_param :show_breakdown_by_actor, 'bool'
       end
     end
 
@@ -448,13 +419,10 @@ module FacebookAds
 
     has_edge :adsets do |edge|
       edge.get 'AdSet' do |api|
-        api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
         api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
-        api.has_param :include_drafts, 'bool'
         api.has_param :is_completed, 'bool'
         api.has_param :time_range, 'object'
-        api.has_param :use_employee_draft, 'bool'
       end
       edge.post 'AdSet' do |api|
         api.has_param :adlabels, { list: 'object' }
@@ -484,6 +452,7 @@ module FacebookAds
         api.has_param :lifetime_min_spend_target, 'int'
         api.has_param :lifetime_spend_cap, 'int'
         api.has_param :line_number, 'int'
+        api.has_param :multi_optimization_goal_weight, { enum: -> { AdSet::MULTI_OPTIMIZATION_GOAL_WEIGHT }}
         api.has_param :name, 'string'
         api.has_param :optimization_goal, { enum: -> { AdSet::OPTIMIZATION_GOAL }}
         api.has_param :optimization_sub_event, { enum: -> { AdSet::OPTIMIZATION_SUB_EVENT }}
@@ -684,18 +653,6 @@ module FacebookAds
       end
     end
 
-    has_edge :batchreplace do |edge|
-      edge.post do |api|
-        api.has_param :payload, { list: 'string' }
-      end
-    end
-
-    has_edge :batchupload do |edge|
-      edge.post do |api|
-        api.has_param :payload, { list: 'string' }
-      end
-    end
-
     has_edge :block_list_drafts do |edge|
       edge.post 'AdAccount' do |api|
         api.has_param :publisher_urls_file, 'file'
@@ -718,15 +675,12 @@ module FacebookAds
       edge.get 'Campaign' do |api|
         api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
         api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
-        api.has_param :include_drafts, 'bool'
         api.has_param :is_completed, 'bool'
         api.has_param :time_range, 'object'
-        api.has_param :use_employee_draft, 'bool'
       end
       edge.post 'Campaign' do |api|
         api.has_param :adlabels, { list: 'object' }
         api.has_param :bid_strategy, { enum: -> { Campaign::BID_STRATEGY }}
-        api.has_param :budget_rebalance_flag, 'bool'
         api.has_param :buying_type, 'string'
         api.has_param :daily_budget, 'int'
         api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
@@ -737,7 +691,7 @@ module FacebookAds
         api.has_param :pacing_type, { list: 'string' }
         api.has_param :promoted_object, 'object'
         api.has_param :source_campaign_id, 'string'
-        api.has_param :special_ad_category, { enum: -> { Campaign::SPECIAL_AD_CATEGORY }}
+        api.has_param :special_ad_categories, { list: { enum: -> { Campaign::SPECIAL_AD_CATEGORIES }} }
         api.has_param :spend_cap, 'int'
         api.has_param :status, { enum: -> { Campaign::STATUS }}
         api.has_param :topline_id, 'string'
@@ -755,6 +709,7 @@ module FacebookAds
     has_edge :content_delivery_report do |edge|
       edge.get 'ContentDeliveryReport' do |api|
         api.has_param :end_date, 'datetime'
+        api.has_param :page_id, 'int'
         api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
         api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
         api.has_param :start_date, 'datetime'

data/lib/facebook_ads/ad_objects/ad_account_activity.rb

@@ -27,9 +27,7 @@ module FacebookAds
 
   class AdAccountActivity < AdObject
 
-    field :billing_address_new, 'string'
-    field :billing_address_old, 'string'
-    field :created_by, 'string'
+    field :created_by, 'Profile'
     field :created_time, 'datetime'
     field :credit_new, 'object'
     field :credit_old, 'object'
@@ -44,8 +42,8 @@ module FacebookAds
     field :grace_period_time_new, 'int'
     field :grace_period_time_old, 'int'
     field :id, 'string'
-    field :manager_id_new, 'string'
-    field :manager_id_old, 'string'
+    field :manager_id_new, 'Profile'
+    field :manager_id_old, 'Profile'
     field :name_new, 'string'
     field :name_old, 'string'
     field :spend_cap_new, 'object'

data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb

@@ -47,7 +47,6 @@ module FacebookAds
     field :id, 'string'
     field :is_smb, 'bool'
     field :is_test, 'bool'
-    field :is_under_authorization, 'bool'
     field :legal_entity_name_in_local_language, 'string'
     field :oe_request_id, 'string'
     field :official_website_url, 'string'

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -51,6 +51,7 @@ module FacebookAds
       "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -132,7 +132,9 @@ module FacebookAds
       "id",
       "income",
       "industries",
+      "instagram_hashtags",
       "instagram_positions",
+      "instream_video_skippable_excluded",
       "instream_video_sponsorship_placements",
       "interest_defaults_source",
       "interested_in",
@@ -165,6 +167,7 @@ module FacebookAds
       "rtb_flag",
       "site_category",
       "targeting_optimization",
+      "targeting_relaxation_types",
       "timezones",
       "topic",
       "trending",
@@ -202,6 +205,7 @@ module FacebookAds
       "POST_ENGAGEMENT",
       "PRODUCT_CATALOG_SALES",
       "REACH",
+      "STORE_VISITS",
       "VIDEO_VIEWS",
     ]
 

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -82,15 +82,18 @@ module FacebookAds
       "update_ad_set_bidding",
       "update_ad_set_budget",
       "update_ad_set_duration",
+      "update_ad_set_min_spend_target",
       "update_ad_set_name",
       "update_ad_set_optimization_goal",
       "update_ad_set_run_status",
+      "update_ad_set_spend_cap",
       "update_ad_set_target_spec",
       "update_ad_targets_spec",
       "update_adgroup_stop_delivery",
       "update_audience",
       "update_campaign_ad_scheduling",
       "update_campaign_budget",
+      "update_campaign_budget_optimization_toggling_status",
       "update_campaign_delivery_type",
       "update_campaign_duration",
       "update_campaign_group_ad_scheduling",

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -44,6 +44,8 @@ module FacebookAds
       "FIND_A_GROUP",
       "FIND_YOUR_GROUPS",
       "FOLLOW_NEWS_STORYLINE",
+      "FOLLOW_PAGE",
+      "FOLLOW_USER",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -61,8 +63,11 @@ module FacebookAds
       "NO_BUTTON",
       "OPEN_LINK",
       "ORDER_NOW",
+      "PAY_TO_ACCESS",
       "PLAY_GAME",
+      "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
@@ -89,6 +94,7 @@ module FacebookAds
     field :autotranslate, { list: 'string' }
     field :bodies, { list: 'AdAssetFeedSpecBody' }
     field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
+    field :call_to_actions, { list: 'object' }
     field :captions, { list: 'AdAssetFeedSpecCaption' }
     field :carousels, { list: 'object' }
     field :descriptions, { list: 'AdAssetFeedSpecDescription' }

data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb

@@ -27,12 +27,14 @@ module FacebookAds
 
   class AdCampaignActivity < AdObject
     BID_STRATEGY_NEW = [
+      "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",
@@ -87,6 +89,7 @@ module FacebookAds
       "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
     ]
 
     OPTIMIZATION_GOAL_OLD = [
@@ -114,6 +117,7 @@ module FacebookAds
       "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
     ]
 
 
@@ -133,8 +137,8 @@ module FacebookAds
     field :bid_type_old, 'string'
     field :billing_event_new, { enum: -> { BILLING_EVENT_NEW }}
     field :billing_event_old, { enum: -> { BILLING_EVENT_OLD }}
-    field :brande_audience_id_new, 'string'
-    field :brande_audience_id_old, 'string'
+    field :brande_audience_id_new, 'BrandAudience'
+    field :brande_audience_id_old, 'BrandAudience'
     field :budget_limit_new, 'object'
     field :budget_limit_old, 'object'
     field :created_time, 'datetime'

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb

@@ -51,6 +51,7 @@ module FacebookAds
       "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
       "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -50,6 +50,8 @@ module FacebookAds
       "FIND_A_GROUP",
       "FIND_YOUR_GROUPS",
       "FOLLOW_NEWS_STORYLINE",
+      "FOLLOW_PAGE",
+      "FOLLOW_USER",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -67,8 +69,11 @@ module FacebookAds
       "NO_BUTTON",
       "OPEN_LINK",
       "ORDER_NOW",
+      "PAY_TO_ACCESS",
       "PLAY_GAME",
+      "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
@@ -134,6 +139,11 @@ module FacebookAds
       "STORY_OWNER",
     ]
 
+    INSTANT_CHECKOUT_SETTING = [
+      "off",
+      "on",
+    ]
+
     OPERATOR = [
       "ALL",
       "ANY",
@@ -197,12 +207,10 @@ module FacebookAds
     field :video_id, 'string'
     field :call_to_action, 'object'
     field :image_file, 'string'
+    field :instant_checkout_setting, { enum: -> { INSTANT_CHECKOUT_SETTING }}
     field :is_dco_internal, 'bool'
 
     has_edge :adlabels do |edge|
-      edge.delete do |api|
-        api.has_param :adlabels, { list: 'object' }
-      end
       edge.post 'AdCreative' do |api|
         api.has_param :adlabels, { list: 'object' }
       end

data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → ad_creative_ad_disclaimer.rb}

@@ -25,11 +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 CustomAudiencePrefillState < AdObject
+  class AdCreativeAdDisclaimer < AdObject
 
-    field :description, 'string'
-    field :num_added, 'int'
-    field :status, 'string'
+    field :text, 'string'
+    field :title, 'string'
+    field :url, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb

@@ -44,6 +44,8 @@ module FacebookAds
       "FIND_A_GROUP",
       "FIND_YOUR_GROUPS",
       "FOLLOW_NEWS_STORYLINE",
+      "FOLLOW_PAGE",
+      "FOLLOW_USER",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -61,8 +63,11 @@ module FacebookAds
       "NO_BUTTON",
       "OPEN_LINK",
       "ORDER_NOW",
+      "PAY_TO_ACCESS",
       "PLAY_GAME",
+      "PURCHASE_GIFT_CARDS",
       "RECORD_NOW",
+      "REQUEST_TIME",
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",

data/lib/facebook_ads/ad_objects/{request_history.rb → ad_creative_photo_data_media_elements.rb}

@@ -25,21 +25,12 @@ 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 RequestHistory < AdObject
-    HTTP_METHOD = [
-      "DELETE",
-      "GET",
-      "POST",
-    ]
+  class AdCreativePhotoDataMediaElements < AdObject
 
-
-    field :api_version, 'string'
-    field :created_time, 'datetime'
-    field :error_code, 'int'
-    field :graph_path, 'string'
-    field :http_method, { enum: -> { HTTP_METHOD }}
-    field :post_params, 'hash'
-    field :query_params, 'hash'
+    field :element_id, 'string'
+    field :element_type, 'string'
+    field :x, 'double'
+    field :y, 'double'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb

@@ -32,6 +32,7 @@ module FacebookAds
     field :branded_content_sponsor_page_id, 'string'
     field :call_to_action, 'AdCreativeLinkDataCallToAction'
     field :collection_thumbnails, { list: 'AdCreativeCollectionThumbnailInfo' }
+    field :customization_rules_spec, { list: 'AdCustomizationRuleSpec' }
     field :image_hash, 'string'
     field :image_url, 'string'
     field :link_description, 'string'