facebookbusiness 0.3.3.4 → 0.4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47f1ea66dbf133a355ec03cf486014ac76ecbd867866e26f220d3756fc7bfd7
-  data.tar.gz: b9136a0fc33ed013528bcd6c563806c0d3e4c103753de51f212bfdddb71835be
+  metadata.gz: c75ea8c8968175262c2b1ec90009ba0cc3f9a29cd3950275246901ca564e64fb
+  data.tar.gz: 344fb8361a22ddd79a9c3262ff0f55c0166fee5219260a801c5adce5f4837fff
 SHA512:
-  metadata.gz: e6f929bcc03a9b08a3108d29353db2dac5f26332527e8fe4cffa0014e6d87db35d13869443b02bafdacf2d6b3902865fea18ad108e40da29a1db28ab430d0975
-  data.tar.gz: 951a90cfa8f60544d2f2259812f202f740d7c55589e857125b33b45ade93995fd8a08b73439fd019f9f9a0199b3249e0e8f65672e6ae13a293a1350e6dbc547a
+  metadata.gz: b33c804fdd9051e64d9ac5c59bbd99f1c1cce46b235ed81ea0bf3d1b40067c899048612fdc8d0939bae5ed4e1776137e844cbda25986535432288c8abb54dfeb
+  data.tar.gz: 59f54746efe0353f011a75cee81cd402c89525a09c3b36f07104a2916727787404fb3939b26348042f693c2ac999533d1d6a3277a97bd5bfcebb1ecd1e30b02b

data/lib/facebook_ads/ad_objects/ad.rb

@@ -48,6 +48,7 @@ module FacebookAds
       "CAMPAIGN_PAUSED",
       "DELETED",
       "DISAPPROVED",
+      "IN_PROCESS",
       "PAUSED",
       "PENDING_BILLING_INFO",
       "PENDING_REVIEW",
@@ -244,7 +245,6 @@ module FacebookAds
         api.has_param :dynamic_customization, 'object'
         api.has_param :end_date, 'datetime'
         api.has_param :height, 'int'
-        api.has_param :interactive, 'bool'
         api.has_param :locale, 'string'
         api.has_param :place_page_id, 'int'
         api.has_param :post, 'object'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -87,6 +87,7 @@ module FacebookAds
       "ADVERTISE",
       "ANALYZE",
       "CREATIVE",
+      "DRAFT",
       "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
@@ -95,6 +96,7 @@ module FacebookAds
       "ADVERTISE",
       "ANALYZE",
       "CREATIVE",
+      "DRAFT",
       "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
@@ -229,6 +231,15 @@ module FacebookAds
       end
     end
 
+    has_edge :ad_place_page_sets_async do |edge|
+      edge.post 'AdPlacePageSet' do |api|
+        api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
+        api.has_param :name, 'string'
+        api.has_param :parent_page, 'string'
+        api.has_param :targeted_area_type, { enum: -> { AdPlacePageSet::TARGETED_AREA_TYPE }}
+      end
+    end
+
     has_edge :ad_sets do |edge|
       edge.delete do |api|
         api.has_param :before_date, 'datetime'
@@ -391,7 +402,7 @@ module FacebookAds
     has_edge :adreportschedules do |edge|
       edge.get
       edge.post do |api|
-        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_converted_product_id action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type interactive_component_sticker_id interactive_component_sticker_response }} }
+        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 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 }}
@@ -421,32 +432,6 @@ module FacebookAds
       end
     end
 
-    has_edge :adreportspecs do |edge|
-      edge.post 'AdReportSpec' do |api|
-        api.has_param :actions_group_by, { list: { enum: -> { AdReportSpec::ACTIONS_GROUP_BY }} }
-        api.has_param :business_id, 'string'
-        api.has_param :bypass_async, 'bool'
-        api.has_param :creation_source, { enum: -> { AdReportSpec::CREATION_SOURCE }}
-        api.has_param :data_columns, { list: 'string' }
-        api.has_param :date_preset, { enum: -> { AdReportSpec::DATE_PRESET }}
-        api.has_param :export_columns, 'object'
-        api.has_param :filters, { list: 'object' }
-        api.has_param :format, { enum: -> { AdReportSpec::FORMAT }}
-        api.has_param :format_version, 'int'
-        api.has_param :insights_section, 'object'
-        api.has_param :limit, 'int'
-        api.has_param :name, 'string'
-        api.has_param :report_run_id, 'string'
-        api.has_param :report_schedule_id, 'string'
-        api.has_param :sort_by, 'string'
-        api.has_param :sort_dir, 'string'
-        api.has_param :time_increment, 'string'
-        api.has_param :time_interval, 'object'
-        api.has_param :time_ranges, { list: 'string' }
-        api.has_param :user_report, 'bool'
-      end
-    end
-
     has_edge :adrules_history do |edge|
       edge.get 'AdAccountAdRulesHistory' do |api|
         api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
@@ -648,6 +633,10 @@ module FacebookAds
       end
     end
 
+    has_edge :affectedadsets do |edge|
+      edge.get 'AdSet'
+    end
+
     has_edge :agencies do |edge|
       edge.delete do |api|
         api.has_param :business, 'string'
@@ -727,6 +716,10 @@ module FacebookAds
       end
     end
 
+    has_edge :brand_audiences do |edge|
+      edge.get 'BrandAudience'
+    end
+
     has_edge :broadtargetingcategories do |edge|
       edge.get 'BroadTargetingCategories' do |api|
         api.has_param :custom_categories_only, 'bool'
@@ -880,6 +873,13 @@ module FacebookAds
       end
     end
 
+    has_edge :emailimport do |edge|
+      edge.post do |api|
+        api.has_param :name, 'string'
+        api.has_param :third_party_data, 'string'
+      end
+    end
+
     has_edge :generatepreviews do |edge|
       edge.get 'AdPreview' do |api|
         api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
@@ -889,7 +889,6 @@ module FacebookAds
         api.has_param :dynamic_customization, 'object'
         api.has_param :end_date, 'datetime'
         api.has_param :height, 'int'
-        api.has_param :interactive, 'bool'
         api.has_param :locale, 'string'
         api.has_param :place_page_id, 'int'
         api.has_param :post, 'object'

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -56,8 +56,8 @@ module FacebookAds
     ]
 
     REGULATED_CATEGORIES = [
+      "CREDIT",
       "EMPLOYMENT",
-      "FINANCING",
       "HOUSING",
       "NONE",
     ]

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -86,7 +86,6 @@ module FacebookAds
     field :ad_formats, { list: 'string' }
     field :additional_data, 'object'
     field :asset_customization_rules, { list: 'object' }
-    field :autotranslate, { list: 'string' }
     field :bodies, { list: 'AdAssetFeedSpecBody' }
     field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
     field :captions, { list: 'AdAssetFeedSpecCaption' }

data/lib/facebook_ads/ad_objects/ad_async_request.rb

@@ -36,6 +36,8 @@ module FacebookAds
       "IN_PROGRESS",
       "PENDING_DEPENDENCY",
       "SUCCESS",
+      "USER_CANCELED",
+      "USER_CANCELED_DEPENDENCY",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :error_code, 'int'
     field :error_message, 'string'
     field :error_summary, 'string'
+    field :error_type, 'string'
     field :level, 'string'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -105,6 +105,8 @@ module FacebookAds
     STATUS = [
       "ACTIVE",
       "DELETED",
+      "IN_PROCESS",
+      "WITH_ISSUES",
     ]
 
     AUTHORIZATION_CATEGORY = [
@@ -210,7 +212,6 @@ module FacebookAds
         api.has_param :dynamic_customization, 'object'
         api.has_param :end_date, 'datetime'
         api.has_param :height, 'int'
-        api.has_param :interactive, 'bool'
         api.has_param :locale, 'string'
         api.has_param :place_page_id, 'int'
         api.has_param :post, 'object'

data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb

@@ -44,7 +44,6 @@ module FacebookAds
     field :attachment_style, { enum: -> { ATTACHMENT_STYLE }}
     field :branded_content_shared_to_sponsor_status, 'string'
     field :branded_content_sponsor_page_id, 'string'
-    field :branded_content_sponsor_relationship, 'string'
     field :call_to_action, 'AdCreativeLinkDataCallToAction'
     field :caption, 'string'
     field :child_attachments, { list: 'AdCreativeLinkDataChildAttachment' }

data/lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb

@@ -36,7 +36,6 @@ module FacebookAds
     field :name, 'string'
     field :picture, 'string'
     field :place_data, 'AdCreativePlaceData'
-    field :referral_id, 'string'
     field :static_card, 'bool'
     field :video_id, 'string'
     has_no_id

data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb

@@ -29,7 +29,6 @@ module FacebookAds
 
     field :branded_content_shared_to_sponsor_status, 'string'
     field :branded_content_sponsor_page_id, 'string'
-    field :branded_content_sponsor_relationship, 'string'
     field :caption, 'string'
     field :image_hash, 'string'
     field :page_welcome_message, 'string'

data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb

@@ -30,7 +30,6 @@ module FacebookAds
     field :additional_image_index, 'int'
     field :branded_content_shared_to_sponsor_status, 'string'
     field :branded_content_sponsor_page_id, 'string'
-    field :branded_content_sponsor_relationship, 'string'
     field :call_to_action, 'AdCreativeLinkDataCallToAction'
     field :collection_thumbnails, { list: 'AdCreativeCollectionThumbnailInfo' }
     field :image_hash, 'string'

data/lib/facebook_ads/ad_objects/ad_place_page_set.rb

@@ -44,7 +44,7 @@ module FacebookAds
     field :name, 'string'
     field :pages_count, 'int'
     field :parent_page, 'Page'
-    field :targeted_area_type, { enum: -> { TARGETED_AREA_TYPE }}
+    field :targeted_area_type, 'adaccountad_place_page_sets_targeted_area_type_enum_param'
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/ad_place_page_set_metadata.rb

@@ -28,6 +28,7 @@ module FacebookAds
   class AdPlacePageSetMetadata < AdObject
 
     field :audience, 'object'
+    field :custom, 'object'
     field :extra_data, 'string'
     field :fixed_radius, 'object'
     has_no_id

data/lib/facebook_ads/ad_objects/ad_report_spec.rb

@@ -27,10 +27,14 @@ module FacebookAds
 
   class AdReportSpec < AdObject
     ACTIONS_GROUP_BY = [
+      "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",
@@ -97,12 +101,6 @@ module FacebookAds
     field :time_increment, 'string'
     field :time_interval, 'object'
     field :time_ranges, { list: 'object' }
-    field :business_id, 'string'
-    field :bypass_async, 'bool'
-    field :format, { enum: -> { FORMAT }}
-    field :limit, 'int'
-    field :report_run_id, 'string'
-    field :user_report, 'bool'
 
   end
 end

data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb

@@ -29,6 +29,7 @@ module FacebookAds
     EXECUTION_TYPE = [
       "CHANGE_BID",
       "CHANGE_BUDGET",
+      "CHANGE_CAMPAIGN_BUDGET",
       "NOTIFICATION",
       "PAUSE",
       "PING_ENDPOINT",

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -56,7 +56,9 @@ module FacebookAds
       "ACTIVE",
       "ARCHIVED",
       "DELETED",
+      "IN_PROCESS",
       "PAUSED",
+      "WITH_ISSUES",
     ]
 
     OPTIMIZATION_GOAL = [
@@ -97,6 +99,7 @@ module FacebookAds
     DESTINATION_TYPE = [
       "APP",
       "APPLINKS_AUTOMATIC",
+      "FACEBOOK",
       "MESSENGER",
       "UNDEFINED",
       "WEBSITE",
@@ -165,7 +168,6 @@ module FacebookAds
     field :adset_schedule, { list: 'DayPart' }
     field :asset_feed_id, 'string'
     field :attribution_spec, { list: 'AttributionSpec' }
-    field :best_creative, 'AdDynamicCreative'
     field :bid_adjustments, 'AdBidAdjustments'
     field :bid_amount, 'int'
     field :bid_constraints, 'AdCampaignBidConstraint'
@@ -261,6 +263,12 @@ module FacebookAds
       end
     end
 
+    has_edge :asyncadrequests do |edge|
+      edge.get 'AdAsyncRequest' do |api|
+        api.has_param :statuses, { list: { enum: -> { AdAsyncRequest::STATUSES }} }
+      end
+    end
+
     has_edge :copies do |edge|
       edge.get 'AdSet' do |api|
         api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -32,11 +32,6 @@ module FacebookAds
       "SPLIT_TEST",
     ]
 
-    AUDIENCE_TYPE = [
-      "MOST_RESPONSIVE",
-      "NOT_MOST_RESPONSIVE",
-    ]
-
 
     field :business, 'Business'
     field :canceled_time, 'datetime'
@@ -63,16 +58,6 @@ module FacebookAds
       edge.get 'AdStudyCell'
     end
 
-    has_edge :customaudiences do |edge|
-      edge.post 'AdStudy' do |api|
-        api.has_param :account_id, 'string'
-        api.has_param :audience_name, 'string'
-        api.has_param :audience_type, { enum: -> { AdStudy::AUDIENCE_TYPE }}
-        api.has_param :cell_id, 'string'
-        api.has_param :objective_id, 'string'
-      end
-    end
-
     has_edge :health_check_errors do |edge|
       edge.get 'AdsTalHealthCheckError'
     end

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -39,7 +39,6 @@ module FacebookAds
     ]
 
 
-    field :custom_attributes, { list: 'string' }
     field :id, 'string'
     field :is_primary, 'bool'
     field :last_updated_results, 'string'

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -42,7 +42,6 @@ module FacebookAds
       "CANDIDATE_VIDEOS",
       "CANVAS",
       "CFC_VIDEO",
-      "CIVIC_PROPOSAL_COVER_VIDEO",
       "CONTAINED_POST_ATTACHMENT",
       "CONTAINED_POST_AUDIO_BROADCAST",
       "CONTAINED_POST_BROADCAST",
@@ -112,6 +111,7 @@ module FacebookAds
       "SLIDESHOW_ANIMOTO",
       "SLIDESHOW_SHAKR",
       "SOTTO_CONTENT",
+      "STORIES_VIDEO",
       "STORYLINE",
       "STORYLINE_WITH_EXTERNAL_MUSIC",
       "STORY_ARCHIVE_VIDEO",
@@ -120,6 +120,7 @@ module FacebookAds
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
       "VIDEO_COMMENT",
+      "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "WOODHENGE",
       "YOUR_DAY",
     ]
@@ -167,6 +168,7 @@ module FacebookAds
       "INLINE_CREATED",
       "PUBLISHED",
       "SCHEDULED",
+      "SCHEDULED_RECURRING",
     ]
 
     UPLOAD_PHASE = [
@@ -203,6 +205,8 @@ module FacebookAds
     field :backdated_time_granularity, 'string'
     field :content_category, 'string'
     field :content_tags, { list: 'string' }
+    field :copyright, 'VideoCopyright'
+    field :copyright_monitoring_status, 'string'
     field :created_time, 'datetime'
     field :custom_labels, { list: 'string' }
     field :description, 'string'
@@ -218,9 +222,11 @@ module FacebookAds
     field :is_crossposting_eligible, 'bool'
     field :is_episode, 'bool'
     field :is_instagram_eligible, 'bool'
+    field :is_reference_only, 'bool'
     field :length, 'double'
     field :live_audience_count, 'int'
     field :live_status, 'string'
+    field :music_video_copyright, 'MusicVideoCopyright'
     field :permalink_url, 'string'
     field :picture, 'string'
     field :place, 'Place'
@@ -387,6 +393,10 @@ module FacebookAds
       edge.get 'Post'
     end
 
+    has_edge :sponsor_tags do |edge|
+      edge.get 'Page'
+    end
+
     has_edge :summarizations do |edge|
       edge.post 'AdVideo' do |api|
         api.has_param :summarization_type, 'string'
@@ -395,6 +405,7 @@ module FacebookAds
     end
 
     has_edge :tags do |edge|
+      edge.get 'TaggableSubject'
       edge.post 'AdVideo' do |api|
         api.has_param :tag_uid, 'int'
         api.has_param :uid, 'int'

data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :error_code, 'int'
     field :error_message, 'string'
     field :error_summary, 'string'
+    field :error_type, 'string'
     field :level, 'string'
     has_no_id
     has_no_get