facebookbusiness 0.14.0.0 → 0.15.0.2

data/lib/facebook_ads/ad_objects/instagram_insights_result.rb

@@ -26,6 +26,13 @@ module FacebookAds
   # pull request for this class.
 
   class InstagramInsightsResult < AdObject
+    BREAKDOWN = [
+      "action_type",
+      "follow_type",
+      "story_navigation_action_type",
+      "surface_type",
+    ]
+
     METRIC = [
       "carousel_album_engagement",
       "carousel_album_impressions",
@@ -35,12 +42,13 @@ module FacebookAds
       "comments",
       "engagement",
       "exits",
-      "follows_from_impressions",
+      "follows",
       "impressions",
       "likes",
       "navigation",
       "plays",
-      "profile_views_from_impressions",
+      "profile_activity",
+      "profile_visits",
       "reach",
       "replies",
       "saved",
@@ -48,7 +56,6 @@ module FacebookAds
       "taps_back",
       "taps_forward",
       "total_interactions",
-      "total_media_attributed_actions",
       "video_views",
     ]
 
@@ -57,15 +64,32 @@ module FacebookAds
       "days_28",
       "lifetime",
       "month",
+      "total_over_range",
       "week",
     ]
 
+    METRIC_TYPE = [
+      "default",
+      "time_series",
+      "total_value",
+    ]
+
+    TIMEFRAME = [
+      "last_14_days",
+      "last_30_days",
+      "last_90_days",
+      "prev_month",
+      "this_month",
+      "this_week",
+    ]
+
 
     field :description, 'string'
     field :id, 'string'
     field :name, 'string'
     field :period, 'string'
     field :title, 'string'
+    field :total_value, 'object'
     field :values, { list: 'InstagramInsightsValue' }
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/instagram_user.rb

@@ -35,6 +35,7 @@ module FacebookAds
     field :is_published, 'bool'
     field :media_count, 'int'
     field :mini_shop_storefront, 'Shop'
+    field :owner_business, 'Business'
     field :profile_pic, 'string'
     field :username, 'string'
     has_no_post

data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb

@@ -43,6 +43,7 @@ module FacebookAds
       "days_28",
       "lifetime",
       "month",
+      "total_over_range",
       "week",
     ]
 

data/lib/facebook_ads/ad_objects/jobs_job.rb

@@ -35,6 +35,11 @@ module FacebookAds
       "PARTIAL_FETCH",
     ]
 
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
 
     field :address, 'object'
     field :applinks, 'CatalogItemAppLinks'
@@ -60,6 +65,7 @@ module FacebookAds
     field :sanitized_images, { list: 'string' }
     field :unit_price, 'object'
     field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/leadgen_form.rb

@@ -38,6 +38,7 @@ module FacebookAds
       "CS_CZ",
       "DA_DK",
       "DE_DE",
+      "EL_GR",
       "EN_GB",
       "EN_US",
       "ES_ES",
@@ -72,6 +73,7 @@ module FacebookAds
     field :block_display_for_non_targeted_viewer, 'bool'
     field :context_card, 'object'
     field :created_time, 'datetime'
+    field :creator, 'User'
     field :expired_leads_count, 'int'
     field :follow_up_action_text, 'string'
     field :follow_up_action_url, 'string'

data/lib/facebook_ads/ad_objects/local_service_business.rb

@@ -55,6 +55,11 @@ module FacebookAds
       "PARTIAL_FETCH",
     ]
 
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
 
     field :address, 'object'
     field :applinks, 'CatalogItemAppLinks'
@@ -92,6 +97,7 @@ module FacebookAds
     field :unit_price, 'object'
     field :url, 'string'
     field :vendor_id, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/media_title.rb

@@ -0,0 +1,85 @@
+# 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 MediaTitle < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+    CONTENT_CATEGORY = [
+      "MOVIE",
+      "MUSIC",
+      "TV_SHOW",
+    ]
+
+
+    field :applinks, 'CatalogItemAppLinks'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :content_category, 'string'
+    field :currency, 'string'
+    field :description, 'string'
+    field :fb_page_alias, 'string'
+    field :fb_page_id, 'Page'
+    field :genres, { list: 'string' }
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :images, { list: 'string' }
+    field :kg_fb_id, 'string'
+    field :media_title_id, 'string'
+    field :price, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :title, 'string'
+    field :title_display_name, 'string'
+    field :unit_price, 'object'
+    field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
+    field :wiki_data_item, 'string'
+
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -44,6 +44,7 @@ module FacebookAds
     field :business, 'Business'
     field :config, 'string'
     field :creation_time, 'datetime'
+    field :creator, 'User'
     field :description, 'string'
     field :duplicate_entries, 'int'
     field :enable_auto_assign_to_accounts, 'bool'
@@ -59,6 +60,7 @@ module FacebookAds
     field :match_rate_approx, 'int'
     field :matched_entries, 'int'
     field :name, 'string'
+    field :owner_business, 'Business'
     field :usage, 'OfflineConversionDataSetUsage'
     field :valid_entries, 'int'
     field :auto_assign_to_new_accounts_only, 'bool'

data/lib/facebook_ads/ad_objects/page.rb

@@ -124,6 +124,7 @@ module FacebookAds
       "PROFILE_PLUS_FACEBOOK_ACCESS",
       "PROFILE_PLUS_FULL_CONTROL",
       "PROFILE_PLUS_MANAGE",
+      "PROFILE_PLUS_MANAGE_LEADS",
       "PROFILE_PLUS_MESSAGING",
       "PROFILE_PLUS_MODERATE",
       "PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
@@ -151,6 +152,7 @@ module FacebookAds
       "PROFILE_PLUS_FACEBOOK_ACCESS",
       "PROFILE_PLUS_FULL_CONTROL",
       "PROFILE_PLUS_MANAGE",
+      "PROFILE_PLUS_MANAGE_LEADS",
       "PROFILE_PLUS_MESSAGING",
       "PROFILE_PLUS_MODERATE",
       "PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
@@ -276,7 +278,6 @@ module FacebookAds
     PLATFORM = [
       "INSTAGRAM",
       "MESSENGER",
-      "WHATSAPP",
     ]
 
     MODEL = [
@@ -333,6 +334,7 @@ module FacebookAds
       "hours",
       "inbox_labels",
       "invoice_access_invoice_change",
+      "invoice_access_invoice_draft_change",
       "invoice_access_onboarding_status_active",
       "leadgen",
       "leadgen_fat",
@@ -487,6 +489,7 @@ module FacebookAds
     field :new_like_count, 'int'
     field :offer_eligible, 'bool'
     field :overall_star_rating, 'double'
+    field :owner_business, 'Business'
     field :page_token, 'string'
     field :parent_page, 'Page'
     field :parking, 'PageParking'
@@ -570,6 +573,10 @@ module FacebookAds
       edge.get 'Album'
     end
 
+    has_edge :ar_experience do |edge|
+      edge.get
+    end
+
     has_edge :assigned_users do |edge|
       edge.delete do |api|
         api.has_param :user, 'int'
@@ -721,10 +728,6 @@ module FacebookAds
       end
     end
 
-    has_edge :copyright_whitelisted_partners do |edge|
-      edge.get 'Profile'
-    end
-
     has_edge :crosspost_whitelisted_pages do |edge|
       edge.get 'Page'
     end
@@ -767,6 +770,10 @@ module FacebookAds
       end
     end
 
+    has_edge :fantasy_games do |edge|
+      edge.get
+    end
+
     has_edge :feed do |edge|
       edge.get 'PagePost' do |api|
         api.has_param :include_hidden, 'bool'
@@ -922,6 +929,7 @@ module FacebookAds
 
     has_edge :insights do |edge|
       edge.get 'InsightsResult' do |api|
+        api.has_param :breakdown, { list: 'object' }
         api.has_param :date_preset, { enum: -> { InsightsResult::DATE_PRESET }}
         api.has_param :metric, { list: 'object' }
         api.has_param :period, { enum: -> { InsightsResult::PERIOD }}
@@ -1023,7 +1031,6 @@ module FacebookAds
         api.has_param :is_audio_only, 'bool'
         api.has_param :is_spherical, 'bool'
         api.has_param :original_fov, 'int'
-        api.has_param :planned_start_time, 'int'
         api.has_param :privacy, 'string'
         api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
         api.has_param :published, 'bool'
@@ -1084,6 +1091,7 @@ module FacebookAds
     has_edge :message_attachments do |edge|
       edge.post do |api|
         api.has_param :message, 'object'
+        api.has_param :platform, { enum: %w{INSTAGRAM MESSENGER }}
       end
     end
 
@@ -1097,6 +1105,7 @@ module FacebookAds
         api.has_param :recipient, 'object'
         api.has_param :sender_action, { enum: -> { Page::SENDER_ACTION }}
         api.has_param :tag, 'object'
+        api.has_param :thread_control, 'object'
       end
     end
 
@@ -1137,6 +1146,10 @@ module FacebookAds
       end
     end
 
+    has_edge :notification_message_tokens do |edge|
+      edge.get 'UserPageOneTimeOptInTokenSettings'
+    end
+
     has_edge :notification_messages_dev_support do |edge|
       edge.post 'Page' do |api|
         api.has_param :developer_action, { enum: -> { Page::DEVELOPER_ACTION }}
@@ -1364,20 +1377,9 @@ module FacebookAds
     end
 
     has_edge :tabs do |edge|
-      edge.delete do |api|
-        api.has_param :tab, 'string'
-      end
       edge.get 'Tab' do |api|
         api.has_param :tab, { list: 'string' }
       end
-      edge.post 'Page' do |api|
-        api.has_param :app_id, 'int'
-        api.has_param :custom_image_url, 'string'
-        api.has_param :custom_name, 'string'
-        api.has_param :is_non_connection_landing_tab, 'bool'
-        api.has_param :position, 'int'
-        api.has_param :tab, 'string'
-      end
     end
 
     has_edge :tagged do |edge|
@@ -1444,6 +1446,20 @@ module FacebookAds
       edge.get 'VideoList'
     end
 
+    has_edge :video_reels do |edge|
+      edge.get 'AdVideo'
+      edge.post 'AdVideo' do |api|
+        api.has_param :description, 'string'
+        api.has_param :feed_targeting, 'object'
+        api.has_param :scheduled_publish_time, 'datetime'
+        api.has_param :targeting, 'object'
+        api.has_param :title, 'string'
+        api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
+        api.has_param :video_id, 'object'
+        api.has_param :video_state, { enum: -> { AdVideo::VIDEO_STATE }}
+      end
+    end
+
     has_edge :videos do |edge|
       edge.get 'AdVideo' do |api|
         api.has_param :type, { enum: -> { AdVideo::TYPE }}

data/lib/facebook_ads/ad_objects/page_upcoming_change.rb

@@ -33,6 +33,7 @@ module FacebookAds
     field :page, 'Page'
     field :proposal, 'PageChangeProposal'
     field :timer_status, 'string'
+    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb

@@ -28,6 +28,7 @@ module FacebookAds
   class PrivateLiftStudyInstance < AdObject
     OPERATION = [
       "AGGREGATE",
+      "CANCEL",
       "COMPUTE",
       "ID_MATCH",
       "NEXT",
@@ -39,7 +40,10 @@ module FacebookAds
     field :created_time, 'datetime'
     field :feature_list, { list: 'string' }
     field :id, 'string'
+    field :issuer_certificate, 'string'
     field :latest_status_update_time, 'datetime'
+    field :run_id, 'string'
+    field :server_hostnames, { list: 'string' }
     field :server_ips, { list: 'string' }
     field :status, 'string'
     field :tier, 'string'

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -95,16 +95,20 @@ module FacebookAds
     ]
 
 
+    field :ad_account_to_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
+    field :agency_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
     field :business, 'Business'
+    field :catalog_store, 'StoreCatalogSettings'
     field :commerce_merchant_settings, 'CommerceMerchantSettings'
+    field :creator_user, 'User'
     field :da_display_settings, 'ProductCatalogImageSettings'
     field :default_image_url, 'string'
     field :fallback_image_url, { list: 'string' }
     field :feed_count, 'int'
     field :id, 'string'
     field :is_catalog_segment, 'bool'
-    field :latest_feed_upload_session, 'ProductFeedUpload'
     field :name, 'string'
+    field :owner_business, 'Business'
     field :product_count, 'int'
     field :store_catalog_settings, 'StoreCatalogSettings'
     field :vertical, 'string'
@@ -162,9 +166,9 @@ module FacebookAds
       end
     end
 
-    has_edge :catalog_website_settings do |edge|
-      edge.post do |api|
-        api.has_param :is_allowed_to_crawl, 'bool'
+    has_edge :catalog_store do |edge|
+      edge.post 'StoreCatalogSettings' do |api|
+        api.has_param :page, 'int'
       end
     end
 
@@ -186,6 +190,10 @@ module FacebookAds
       end
     end
 
+    has_edge :collaborative_ads_event_stats do |edge|
+      edge.get 'CatalogSegmentAllMatchCountLaser'
+    end
+
     has_edge :collaborative_ads_lsb_image_bank do |edge|
       edge.get
     end
@@ -326,9 +334,13 @@ module FacebookAds
     end
 
     has_edge :media_titles do |edge|
-      edge.post do |api|
+      edge.get 'MediaTitle' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+      edge.post 'MediaTitle' do |api|
         api.has_param :applinks, 'object'
-        api.has_param :content_category, { enum: %w{MOVIE MUSIC TV_SHOW }}
+        api.has_param :content_category, { enum: -> { MediaTitle::CONTENT_CATEGORY }}
         api.has_param :currency, 'string'
         api.has_param :description, 'string'
         api.has_param :fb_page_id, 'string'

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -57,7 +57,6 @@ module FacebookAds
     ]
 
     FEED_TYPE = [
-      "AUTO",
       "AUTOMOTIVE_MODEL",
       "DESTINATION",
       "FLIGHT",
@@ -65,7 +64,6 @@ module FacebookAds
       "HOTEL",
       "HOTEL_ROOM",
       "LOCAL_INVENTORY",
-      "MARKET",
       "MEDIA_TITLE",
       "OFFER",
       "PRODUCTS",
@@ -104,6 +102,7 @@ module FacebookAds
     ]
 
     OVERRIDE_TYPE = [
+      "BATCH_API_LANGUAGE_OR_COUNTRY",
       "CATALOG_SEGMENT_CUSTOMIZE_DEFAULT",
       "COUNTRY",
       "LANGUAGE",
@@ -173,6 +172,13 @@ module FacebookAds
       end
     end
 
+    has_edge :media_titles do |edge|
+      edge.get 'MediaTitle' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
     has_edge :products do |edge|
       edge.get 'ProductItem' do |api|
         api.has_param :bulk_pagination, 'bool'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -317,6 +317,12 @@ module FacebookAds
       "DUPLICATE_TITLE_AND_DESCRIPTION",
       "GENERIC_INVALID_FIELD",
       "HIDDEN_UNTIL_PRODUCT_LAUNCH",
+      "IMAGE_FETCH_FAILED",
+      "IMAGE_FETCH_FAILED_BAD_GATEWAY",
+      "IMAGE_FETCH_FAILED_FILE_SIZE_EXCEEDED",
+      "IMAGE_FETCH_FAILED_FORBIDDEN",
+      "IMAGE_FETCH_FAILED_LINK_BROKEN",
+      "IMAGE_FETCH_FAILED_TIMED_OUT",
       "IMAGE_RESOLUTION_LOW",
       "INACTIVE_SHOPIFY_PRODUCT",
       "INVALID_COMMERCE_TAX_CATEGORY",
@@ -342,9 +348,12 @@ module FacebookAds
       "MISSING_SHIPPING_PROFILE",
       "MISSING_SIZE",
       "MISSING_TAX_CATEGORY",
+      "NEGATIVE_COMMUNITY_FEEDBACK",
       "NOT_ENOUGH_IMAGES",
       "PART_OF_PRODUCT_LAUNCH",
       "PRODUCT_EXPIRED",
+      "PRODUCT_ITEM_HIDDEN_FROM_ALL_SHOPS",
+      "PRODUCT_ITEM_NOT_INCLUDED_IN_ANY_SHOP",
       "PRODUCT_ITEM_NOT_VISIBLE",
       "PRODUCT_NOT_APPROVED",
       "PRODUCT_NOT_DOMINANT_CURRENCY",
@@ -690,6 +699,7 @@ module FacebookAds
     field :origin_country, 'string'
     field :parent_product_id, 'string'
     field :pattern, 'string'
+    field :post_conversion_signal_based_enforcement_appeal_eligibility, 'bool'
     field :price, 'string'
     field :product_catalog, 'ProductCatalog'
     field :product_feed, 'ProductFeed'

data/lib/facebook_ads/ad_objects/product_item_ar_data.rb

@@ -36,6 +36,7 @@ module FacebookAds
       "MARKETPLACE",
       "MARKETPLACE_ADS_DEPRECATED",
       "MARKETPLACE_SHOPS",
+      "MINI_SHOPS",
       "OFFLINE_CONVERSIONS",
       "SHOPS",
       "UNIVERSAL_CHECKOUT",

data/lib/facebook_ads/ad_objects/product_set.rb

@@ -75,6 +75,13 @@ module FacebookAds
       end
     end
 
+    has_edge :media_titles do |edge|
+      edge.get 'MediaTitle' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
     has_edge :products do |edge|
       edge.get 'ProductItem' do |api|
         api.has_param :bulk_pagination, 'bool'

data/lib/facebook_ads/ad_objects/saved_audience.rb

@@ -36,6 +36,7 @@ module FacebookAds
     field :id, 'string'
     field :name, 'string'
     field :operation_status, 'CustomAudienceStatus'
+    field :owner_business, 'Business'
     field :page_deletion_marked_delete_time, 'int'
     field :permission_for_actions, 'AudiencePermissionForActions'
     field :run_status, 'string'

data/lib/facebook_ads/ad_objects/shop.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :fb_sales_channel, 'object'
     field :id, 'string'
     field :ig_sales_channel, 'object'
+    field :workspace, 'object'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/{copyright_audio_asset.rb → shop_order.rb}

@@ -25,13 +25,10 @@ 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 CopyrightAudioAsset < AdObject
+  class ShopOrder < AdObject
 
-    field :copyright, 'AudioCopyright'
     field :creation_time, 'datetime'
     field :id, 'string'
-    field :title, 'string'
-    field :update_time, 'datetime'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/store_catalog_settings.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :id, 'string'
     field :page, 'Page'
+    has_no_post
 
   end
 end

data/lib/facebook_ads/ad_objects/system_user.rb

@@ -67,7 +67,9 @@ module FacebookAds
     end
 
     has_edge :assigned_pages do |edge|
-      edge.get 'Page'
+      edge.get 'Page' do |api|
+        api.has_param :pages, { list: 'int' }
+      end
     end
 
     has_edge :assigned_product_catalogs do |edge|

data/lib/facebook_ads/ad_objects/targeting.rb

@@ -118,6 +118,7 @@ module FacebookAds
     field :relationship_statuses, { list: 'int' }
     field :site_category, { list: 'string' }
     field :targeting_optimization, 'string'
+    field :targeting_relaxation_types, 'TargetingRelaxation'
     field :user_adclusters, { list: 'IdName' }
     field :user_device, { list: 'string' }
     field :user_event, { list: 'int' }

data/lib/facebook_ads/ad_objects/targeting_relaxation.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class TargetingRelaxation < AdObject
 
+    field :custom_audience, 'int'
     field :lookalike, 'int'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/unified_thread.rb

@@ -29,11 +29,11 @@ module FacebookAds
     PLATFORM = [
       "INSTAGRAM",
       "MESSENGER",
-      "WHATSAPP",
     ]
 
 
     field :can_reply, 'bool'
+    field :folder, 'string'
     field :former_participants, 'object'
     field :id, 'string'
     field :is_subscribed, 'bool'