facebookbusiness 0.7.0.1 → 0.8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ef851cac669750e7aba58e6120cbd85343bffed78446722ed6991910b30f08
-  data.tar.gz: 2ed325e1cd2b5422a94e5347e1bba6da3de332e0ab8b15b2f6f1619ff5077b23
+  metadata.gz: 4a33ca32c8748ade89d079a80d94c8b4e6c02a547db4bff11c03e1a2a7979dbc
+  data.tar.gz: 6414909aacd097b547c3ed836eddff3ae622ef2f6d31a5822d35f4d27201101d
 SHA512:
-  metadata.gz: 71701986ff59c11781aa63283d700eb460b022bb2e050525ff81eebcc903eb1a0538b9ae497cc487e441f0f3b0e8f9b32486934d9a2286a7d9f68048ee5c76bd
-  data.tar.gz: d69460340c74263dd3226f35ee92294dd29c0852aa1a6ded399b042b35f861159fe76f848a442b27e112c7d6dbb2e99483ca8516cdf5f8e68917c9e65330e790
+  metadata.gz: 1d1164b46627d07f5cd9ad5e70815a4617e31fcd5eea8cf80d54f655557ec9ce976550779f63f305f8d148e60cf179610ebe07cc7d2ff214f6dbb85755ebaa01
+  data.tar.gz: ee85a21d581897a5eb06001f0d654242d7b019ffef05870800ca750dcc730c4d3b4b4c075f7eac3a63a00c6f6d87aba9ea2286d9b1dd99be4d7cfe0d16212803

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -77,6 +77,7 @@ module FacebookAds
       "THB",
       "TRY",
       "TWD",
+      "UAH",
       "USD",
       "UYU",
       "VND",
@@ -86,18 +87,12 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "ANALYZE",
-      "CREATIVE",
-      "DRAFT",
-      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 
     TASKS = [
       "ADVERTISE",
       "ANALYZE",
-      "CREATIVE",
-      "DRAFT",
-      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 
@@ -215,6 +210,7 @@ module FacebookAds
         api.has_param :after, 'string'
         api.has_param :business_id, 'string'
         api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
+        api.has_param :data_source, { enum: -> { AdActivity::DATA_SOURCE }}
         api.has_param :extra_oids, { list: 'string' }
         api.has_param :limit, 'int'
         api.has_param :oid, 'string'
@@ -227,6 +223,7 @@ module FacebookAds
     has_edge :ad_place_page_sets do |edge|
       edge.get 'AdPlacePageSet'
       edge.post 'AdPlacePageSet' do |api|
+        api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
         api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
         api.has_param :name, 'string'
         api.has_param :parent_page, 'string'
@@ -236,6 +233,7 @@ module FacebookAds
 
     has_edge :ad_place_page_sets_async do |edge|
       edge.post 'AdPlacePageSet' do |api|
+        api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
         api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
         api.has_param :name, 'string'
         api.has_param :parent_page, 'string'
@@ -243,15 +241,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ad_sets do |edge|
-      edge.delete do |api|
-        api.has_param :before_date, 'datetime'
-        api.has_param :delete_offset, 'int'
-        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
-        api.has_param :object_count, 'int'
-      end
-    end
-
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
     end
@@ -349,10 +338,6 @@ module FacebookAds
       end
     end
 
-    has_edge :adreportschedules do |edge|
-      edge.get
-    end
-
     has_edge :adrules_history do |edge|
       edge.get 'AdAccountAdRulesHistory' do |api|
         api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
@@ -406,6 +391,7 @@ module FacebookAds
     has_edge :ads_volume do |edge|
       edge.get 'AdAccountAdVolume' do |api|
         api.has_param :page_id, 'int'
+        api.has_param :recommendation_type, { enum: -> { AdAccountAdVolume::RECOMMENDATION_TYPE }}
         api.has_param :show_breakdown_by_actor, 'bool'
       end
     end
@@ -529,6 +515,7 @@ module FacebookAds
         api.has_param :composer_type, 'string'
         api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
         api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
+        api.has_param :creative_tools, 'string'
         api.has_param :description, 'string'
         api.has_param :embeddable, 'bool'
         api.has_param :end_offset, 'int'
@@ -582,6 +569,7 @@ module FacebookAds
         api.has_param :upload_session_id, 'string'
         api.has_param :upload_setting_properties, 'string'
         api.has_param :video_file_chunk, 'file'
+        api.has_param :video_id_original, 'string'
         api.has_param :video_start_time_ms, 'int'
         api.has_param :waterfall_id, 'string'
         api.accepts_files!
@@ -692,6 +680,7 @@ module FacebookAds
         api.has_param :promoted_object, 'object'
         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 }} }
         api.has_param :spend_cap, 'int'
         api.has_param :status, { enum: -> { Campaign::STATUS }}
         api.has_param :topline_id, 'string'
@@ -717,6 +706,14 @@ module FacebookAds
       end
     end
 
+    has_edge :create_and_apply_publisher_block_list do |edge|
+      edge.post do |api|
+        api.has_param :is_auto_blocking_on, 'bool'
+        api.has_param :name, 'string'
+        api.has_param :publisher_urls, { list: 'string' }
+      end
+    end
+
     has_edge :customaudiences do |edge|
       edge.get 'CustomAudience' do |api|
         api.has_param :business_id, 'string'

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -26,10 +26,33 @@ module FacebookAds
   # pull request for this class.
 
   class AdAccountAdVolume < AdObject
+    RECOMMENDATION_TYPE = [
+      "AGGREGATED_BID_LIMITED",
+      "AGGREGATED_BUDGET_LIMITED",
+      "AGGREGATED_COST_LIMITED",
+      "AUCTION_OVERLAP",
+      "CREATIVE_FATIGUE",
+      "FRAGMENTATION",
+      "LEARNING_LIMITED",
+      "TOP_ADSETS_WITH_ADS_UNDER_CAP",
+      "TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
+      "UNECONOMICAL_ADS_THROTTLING",
+      "ZERO_IMPRESSION",
+    ]
+
 
     field :actor_id, 'string'
+    field :actor_name, 'string'
+    field :ad_limit_scope_business, 'Business'
+    field :ad_limit_scope_business_manager_id, 'string'
+    field :ad_limit_set_by_page_admin, 'int'
     field :ads_running_or_in_review_count, 'int'
+    field :ads_running_or_in_review_count_subject_to_limit_set_by_page, 'int'
     field :current_account_ads_running_or_in_review_count, 'int'
+    field :future_limit_activation_date, 'string'
+    field :future_limit_on_ads_running_or_in_review, 'int'
+    field :limit_on_ads_running_or_in_review, 'int'
+    field :recommendations, { list: 'object' }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -45,6 +45,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_LEAD",
       "REACH",
       "REPLIES",
       "SOCIAL_IMPRESSIONS",

data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb

@@ -36,6 +36,7 @@ module FacebookAds
       "INSTANT_GAME",
       "ITUNES",
       "ITUNES_IPAD",
+      "OCULUS_APP_STORE",
       "ROKU_STORE",
       "WINDOWS_10_STORE",
       "WINDOWS_STORE",

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -59,6 +59,7 @@ module FacebookAds
       "CREDIT",
       "EMPLOYMENT",
       "HOUSING",
+      "ISSUES_ELECTIONS_POLITICS",
       "NONE",
     ]
 

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -82,6 +82,7 @@ module FacebookAds
       "update_ad_set_bidding",
       "update_ad_set_budget",
       "update_ad_set_duration",
+      "update_ad_set_learning_stage_status",
       "update_ad_set_min_spend_target",
       "update_ad_set_name",
       "update_ad_set_optimization_goal",
@@ -102,6 +103,7 @@ module FacebookAds
       "update_campaign_name",
       "update_campaign_run_status",
       "update_campaign_schedule",
+      "update_delivery_type_cross_level_shift",
     ]
 
     CATEGORY = [
@@ -118,6 +120,11 @@ module FacebookAds
       "TARGETING",
     ]
 
+    DATA_SOURCE = [
+      "CALYPSO",
+      "TAO",
+    ]
+
 
     field :actor_id, 'string'
     field :actor_name, 'string'

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -71,6 +71,7 @@ module FacebookAds
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
+      "SEND_A_GIFT",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",
@@ -102,6 +103,7 @@ module FacebookAds
     field :images, { list: 'AdAssetFeedSpecImage' }
     field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
     field :optimization_type, 'string'
+    field :posts, { list: 'object' }
     field :titles, { list: 'AdAssetFeedSpecTitle' }
     field :videos, { list: 'AdAssetFeedSpecVideo' }
     has_no_id

data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb

@@ -83,6 +83,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_LEAD",
       "REACH",
       "REPLIES",
       "SOCIAL_IMPRESSIONS",
@@ -111,6 +112,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_LEAD",
       "REACH",
       "REPLIES",
       "SOCIAL_IMPRESSIONS",
@@ -137,8 +139,6 @@ 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, '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

@@ -45,6 +45,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_LEAD",
       "REACH",
       "REPLIES",
       "SOCIAL_IMPRESSIONS",

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -77,6 +77,7 @@ module FacebookAds
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
+      "SEND_A_GIFT",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",

data/lib/facebook_ads/ad_objects/{atlas_url.rb → ad_creative_instagram_branded_content.rb}

@@ -25,9 +25,8 @@ 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 AtlasUrl < AdObject
+  class AdCreativeInstagramBrandedContent < AdObject
 
-    field :url, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AdCreativeInteractiveComponentsSpec < AdObject
 
+    field :child_attachments, { list: 'object' }
     field :components, { list: 'object' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb

@@ -71,6 +71,7 @@ module FacebookAds
       "SAY_THANKS",
       "SEE_MORE",
       "SELL_NOW",
+      "SEND_A_GIFT",
       "SHARE",
       "SHOP_NOW",
       "SIGN_UP",

data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb

@@ -47,6 +47,7 @@ module FacebookAds
       "GENDER",
       "INSTANT_ARTICLE_ID",
       "INSTANT_ARTICLE_PAGE_ID",
+      "IS_DEAL_BACKFILL",
       "PLACEMENT",
       "PLACEMENT_NAME",
       "PLATFORM",

data/lib/facebook_ads/ad_objects/ad_place_page_set.rb

@@ -26,6 +26,11 @@ module FacebookAds
   # pull request for this class.
 
   class AdPlacePageSet < AdObject
+    CATEGORY = [
+      "BOPUS",
+      "GENERAL",
+    ]
+
     LOCATION_TYPES = [
       "home",
       "recent",
@@ -44,6 +49,7 @@ module FacebookAds
     field :name, 'string'
     field :pages_count, 'int'
     field :parent_page, 'Page'
+    field :category, 'adaccountad_place_page_sets_category_enum_param'
     field :targeted_area_type, 'adaccountad_place_page_sets_targeted_area_type_enum_param'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -57,7 +57,6 @@ module FacebookAds
       "RIGHT_COLUMN_STANDARD",
       "SUGGESTED_VIDEO_DESKTOP",
       "SUGGESTED_VIDEO_MOBILE",
-      "WATCH_FEED_HOME",
       "WATCH_FEED_MOBILE",
     ]
 

data/lib/facebook_ads/ad_objects/ad_report_spec.rb

@@ -38,7 +38,6 @@ module FacebookAds
     field :id, 'string'
     field :insights_section, 'object'
     field :name, 'string'
-    field :report_schedule, 'object'
     field :report_schedule_id, 'string'
     field :sort_by, 'string'
     field :sort_dir, 'string'

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -81,6 +81,7 @@ module FacebookAds
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "QUALITY_LEAD",
       "REACH",
       "REPLIES",
       "SOCIAL_IMPRESSIONS",
@@ -163,6 +164,7 @@ module FacebookAds
       "CREDIT",
       "EMPLOYMENT",
       "HOUSING",
+      "ISSUES_ELECTIONS_POLITICS",
       "NONE",
     ]
 

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -30,6 +30,7 @@ module FacebookAds
       "CONTINUOUS_LIFT_CONFIG",
       "GEO_LIFT",
       "LIFT",
+      "PRIVATE_LIFT",
       "SPLIT_TEST",
     ]
 
@@ -69,6 +70,7 @@ module FacebookAds
         api.has_param :name, 'string'
         api.has_param :offline_conversion_data_sets, { list: 'object' }
         api.has_param :offsitepixels, { list: 'object' }
+        api.has_param :product_catalogs, { list: 'object' }
         api.has_param :product_sets, { list: 'object' }
         api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}
       end

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -77,6 +77,7 @@ module FacebookAds
       "HEURISTIC_CLUSTER_VIDEO",
       "HEURISTIC_PREVIEW",
       "HIGHLIGHT_CLIP_VIDEO",
+      "IG_STORIES_READER",
       "INSPIRATION_VIDEO",
       "INSTAGRAM_VIDEO_COPY",
       "INSTANT_APPLICATION_PREVIEW",
@@ -97,6 +98,7 @@ module FacebookAds
       "MOMENTS_VIDEO",
       "NEO_ASYNC_GAME_VIDEO",
       "NO_STORY",
+      "NO_STORY_WITH_ENTPOST",
       "OCULUS_CREATOR_PORTAL",
       "OCULUS_VENUES_BROADCAST",
       "OFFERS_VIDEO",
@@ -133,7 +135,9 @@ module FacebookAds
       "VIDEO_COMMENT",
       "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "VIDEO_SUPERRES",
+      "VU_GENERATED_VIDEO",
       "WOODHENGE",
+      "WORK_KNOWLEDGE_VIDEO",
       "YOUR_DAY",
     ]
 
@@ -165,7 +169,6 @@ module FacebookAds
 
     ORIGINAL_PROJECTION_TYPE = [
       "cubemap",
-      "equiangular_cubemap",
       "equirectangular",
       "half_equirectangular",
     ]
@@ -191,29 +194,6 @@ module FacebookAds
       "transfer",
     ]
 
-    VALIDATION_AD_PLACEMENTS = [
-      "AUDIENCE_NETWORK_INSTREAM_VIDEO",
-      "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
-      "AUDIENCE_NETWORK_REWARDED_VIDEO",
-      "DESKTOP_FEED_STANDARD",
-      "FACEBOOK_STORY_MOBILE",
-      "INSTAGRAM_STANDARD",
-      "INSTAGRAM_STORY",
-      "INSTANT_ARTICLE_STANDARD",
-      "INSTREAM_VIDEO_DESKTOP",
-      "INSTREAM_VIDEO_IMAGE",
-      "INSTREAM_VIDEO_MOBILE",
-      "MESSENGER_MOBILE_INBOX_MEDIA",
-      "MESSENGER_MOBILE_STORY_MEDIA",
-      "MOBILE_FEED_STANDARD",
-      "MOBILE_FULLWIDTH",
-      "MOBILE_INTERSTITIAL",
-      "MOBILE_MEDIUM_RECTANGLE",
-      "MOBILE_NATIVE",
-      "RIGHT_COLUMN_STANDARD",
-      "SUGGESTED_VIDEO_MOBILE",
-    ]
-
     TYPE = [
       "tagged",
       "uploaded",
@@ -284,6 +264,7 @@ module FacebookAds
     field :composer_source_surface, 'string'
     field :composer_type, 'string'
     field :container_type, { enum: -> { CONTAINER_TYPE }}
+    field :creative_tools, 'string'
     field :end_offset, 'int'
     field :fbuploader_video_file_chunk, 'string'
     field :file_size, 'int'
@@ -332,11 +313,9 @@ module FacebookAds
     field :upload_session_id, 'string'
     field :upload_setting_properties, 'string'
     field :video_file_chunk, 'string'
+    field :video_id_original, 'string'
     field :video_start_time_ms, 'int'
     field :waterfall_id, 'string'
-    field :ad_placements_validation_only, 'bool'
-    field :creative_folder_id, 'string'
-    field :validation_ad_placements, { list: { enum: -> { VALIDATION_AD_PLACEMENTS }} }
 
     has_edge :captions do |edge|
       edge.get
@@ -402,6 +381,12 @@ module FacebookAds
       end
     end
 
+    has_edge :reactions do |edge|
+      edge.get 'Profile' do |api|
+        api.has_param :type, { enum: -> { Profile::TYPE }}
+      end
+    end
+
     has_edge :sharedposts do |edge|
       edge.get 'Post'
     end