facebookbusiness 0.8.0.0 → 0.8.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4de6bfc476d804de39cce9ae238d8d4d974c1019c255eb244130636474a569d0
-  data.tar.gz: 74f7adab3e79333ade1467585d83c98c564c2eb92a532d199049c42effc32553
+  metadata.gz: 1ec2c3003233735a142a752de0bb91e4119fa931d94c5c10c5a769a9c97110d6
+  data.tar.gz: 7e7094b3c29f41afbab98f3d5d7faf0bec900cae1642d1e39ee17cf19ba8e7d7
 SHA512:
-  metadata.gz: 310be0ab8c3fa0f1c0d3ce31e5b1734e306d1cd4daa92a78b80873106552216909d52d63c11a1899192c8b3df36a400cc42900563e2dce81dc6eb0b6c17636d7
-  data.tar.gz: 4b4bbdb344b3c66a2d31462139b3c18d63ba5be074d943456ebe461dd4a0b3e467ce5bbf3f17fe9b3a5034fec226640987e766b2f0f8c12c68a7ea4ffbdffcee
+  metadata.gz: dd97d6ee27e4dea44ab8db1c47a5949b9429e0d67ad51517a20729851050f03ee66f1b35ef80fc1729991dd2cb0cb347aaae28f764be36c0893e014918939db0
+  data.tar.gz: fb4e4a25f44130e2e61b5203ab248da4412c846e59912e736024eff096d8c57bae553423c5e2bccf15a0688d9a3503db1dedd0b2d43ad9ab08e9beb53ca8e4d9

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -391,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
@@ -705,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_asset_feed_spec.rb

@@ -103,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_creative_instagram_branded_content.rb

@@ -0,0 +1,36 @@
+# 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 AdCreativeInstagramBrandedContent < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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_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_study.rb

@@ -30,6 +30,7 @@ module FacebookAds
       "CONTINUOUS_LIFT_CONFIG",
       "GEO_LIFT",
       "LIFT",
+      "PRIVATE_LIFT",
       "SPLIT_TEST",
     ]
 

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -135,6 +135,7 @@ module FacebookAds
       "VIDEO_COMMENT",
       "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "VIDEO_SUPERRES",
+      "VU_GENERATED_VIDEO",
       "WOODHENGE",
       "WORK_KNOWLEDGE_VIDEO",
       "YOUR_DAY",
@@ -380,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

data/lib/facebook_ads/ad_objects/adoptable_pet.rb

@@ -35,6 +35,7 @@ module FacebookAds
     field :applinks, 'CatalogItemAppLinks'
     field :availability, 'string'
     field :breed, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
     field :description, 'string'
     field :gender, 'string'

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -32,7 +32,9 @@ module FacebookAds
     ]
 
     AUTOMATIC_MATCHING_FIELDS = [
+      "country",
       "ct",
+      "db",
       "em",
       "fn",
       "ge",
@@ -90,6 +92,7 @@ module FacebookAds
     has_edge :da_checks do |edge|
       edge.get 'DaCheck' do |api|
         api.has_param :checks, { list: 'string' }
+        api.has_param :connection_method, { enum: -> { DaCheck::CONNECTION_METHOD }}
       end
     end
 

data/lib/facebook_ads/ad_objects/application.rb

@@ -227,6 +227,7 @@ module FacebookAds
         api.has_param :bundle_id, 'string'
         api.has_param :bundle_short_version, 'string'
         api.has_param :bundle_version, 'string'
+        api.has_param :click_id, 'string'
         api.has_param :consider_views, 'bool'
         api.has_param :custom_events, { list: 'object' }
         api.has_param :custom_events_file, 'file'
@@ -239,6 +240,7 @@ module FacebookAds
         api.has_param :include_dwell_data, 'bool'
         api.has_param :include_video_data, 'bool'
         api.has_param :install_referrer, 'string'
+        api.has_param :install_timestamp, 'int'
         api.has_param :installer_package, 'string'
         api.has_param :limited_data_use, 'bool'
         api.has_param :migration_bundle, 'string'
@@ -288,6 +290,18 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :aggregate_revenue do |edge|
+      edge.post do |api|
+        api.has_param :ecpms, { list: 'string' }
+        api.has_param :query_ids, { list: 'string' }
+        api.has_param :request_id, 'string'
+      end
+    end
+
+    has_edge :android_dialog_configs do |edge|
+      edge.get
+    end
+
     has_edge :app_event_types do |edge|
       edge.get
     end
@@ -389,6 +403,7 @@ module FacebookAds
     has_edge :da_checks do |edge|
       edge.get 'DaCheck' do |api|
         api.has_param :checks, { list: 'string' }
+        api.has_param :connection_method, { enum: -> { DaCheck::CONNECTION_METHOD }}
       end
     end
 
@@ -455,6 +470,12 @@ module FacebookAds
       end
     end
 
+    has_edge :live_videos do |edge|
+      edge.get 'LiveVideo' do |api|
+        api.has_param :broadcast_status, { enum: -> { LiveVideo::BROADCAST_STATUS }}
+      end
+    end
+
     has_edge :mmp_auditing do |edge|
       edge.post do |api|
         api.has_param :advertiser_id, 'string'
@@ -478,6 +499,7 @@ module FacebookAds
       edge.get do |api|
         api.has_param :device_id, 'string'
         api.has_param :extinfo, 'object'
+        api.has_param :os_version, 'string'
         api.has_param :platform, { enum: %w{ANDROID IOS }}
         api.has_param :sdk_version, 'string'
       end

data/lib/facebook_ads/ad_objects/atlas_campaign.rb

@@ -145,7 +145,7 @@ module FacebookAds
         api.has_param :dimensions, { list: { enum: %w{AD_ID AD_SET_ID CAMPAIGN_ID DEVICE_TYPE SOURCE_CHANNEL }} }
         api.has_param :granularity, { enum: %w{DAY HOUR MONTH WEEK_SUNDAY YEAR }}
         api.has_param :metric_scope, 'hash'
-        api.has_param :order_by, { list: 'string' }
+        api.has_param :order_by, { list: 'hash' }
       end
     end
 

data/lib/facebook_ads/ad_objects/automotive_model.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :automotive_model_id, 'string'
     field :availability, 'string'
     field :body_style, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
     field :custom_label_0, 'string'
     field :description, 'string'

data/lib/facebook_ads/ad_objects/business.rb

@@ -78,6 +78,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -85,6 +86,7 @@ module FacebookAds
       "PROFILE_PLUS_ADVERTISE",
       "PROFILE_PLUS_ANALYZE",
       "PROFILE_PLUS_CREATE_CONTENT",
+      "PROFILE_PLUS_LIVE_STREAM_MODERATION",
       "PROFILE_PLUS_MANAGE",
       "PROFILE_PLUS_MESSAGING",
       "PROFILE_PLUS_MODERATE",
@@ -117,6 +119,7 @@ module FacebookAds
     has_edge :access_token do |edge|
       edge.post 'Business' do |api|
         api.has_param :app_id, 'string'
+        api.has_param :fbe_external_business_id, 'string'
         api.has_param :scope, { list: 'Permission' }
         api.has_param :system_user_name, 'string'
       end
@@ -207,6 +210,14 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :aggregate_revenue do |edge|
+      edge.post do |api|
+        api.has_param :ecpms, { list: 'string' }
+        api.has_param :query_ids, { list: 'string' }
+        api.has_param :request_id, 'string'
+      end
+    end
+
     has_edge :an_placements do |edge|
       edge.get 'AdPlacement'
     end
@@ -285,6 +296,10 @@ module FacebookAds
       edge.get 'ProductCatalog'
     end
 
+    has_edge :client_whatsapp_business_accounts do |edge|
+      edge.get 'WhatsAppBusinessAccount'
+    end
+
     has_edge :clients do |edge|
       edge.delete do |api|
         api.has_param :business, 'string'
@@ -292,6 +307,26 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :collaborative_ads_collaboration_requests do |edge|
+      edge.get 'CpasCollaborationRequest' do |api|
+        api.has_param :status, 'string'
+      end
+      edge.post 'CpasCollaborationRequest' do |api|
+        api.has_param :brands, { list: 'string' }
+        api.has_param :contact_email, 'string'
+        api.has_param :contact_first_name, 'string'
+        api.has_param :contact_last_name, 'string'
+        api.has_param :phone_number, 'string'
+        api.has_param :receiver_business, 'string'
+        api.has_param :requester_agency_or_brand, { enum: -> { CpasCollaborationRequest::REQUESTER_AGENCY_OR_BRAND }}
+        api.has_param :sender_client_business, 'string'
+      end
+    end
+
+    has_edge :collaborative_ads_suggested_partners do |edge|
+      edge.get 'CpasAdvertiserPartnershipRecommendation'
+    end
+
     has_edge :commerce_merchant_settings do |edge|
       edge.get 'CommerceMerchantSettings'
     end
@@ -307,6 +342,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 :customconversions do |edge|
       edge.post 'CustomConversion' do |api|
         api.has_param :advanced_rule, 'string'
@@ -359,6 +402,7 @@ module FacebookAds
         api.has_param :existing_client_business_id, 'string'
       end
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :existing_client_business_id, 'string'
         api.has_param :name, 'string'
         api.has_param :sales_rep_email, 'string'
@@ -407,9 +451,11 @@ module FacebookAds
         api.has_param :client_id, 'string'
       end
       edge.get 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :client_user_id, 'int'
       end
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :name, 'string'
         api.has_param :page_permitted_tasks, { list: { enum: -> { Business::PAGE_PERMITTED_TASKS }} }
         api.has_param :sales_rep_email, 'string'
@@ -441,12 +487,15 @@ module FacebookAds
     has_edge :owned_product_catalogs do |edge|
       edge.get 'ProductCatalog'
       edge.post 'ProductCatalog' do |api|
+        api.has_param :catalog_segment_filter, 'object'
+        api.has_param :catalog_segment_product_set_id, 'string'
         api.has_param :commerce_merchant_settings, 'object'
         api.has_param :da_display_settings, 'object'
         api.has_param :destination_catalog_settings, 'hash'
         api.has_param :flight_catalog_settings, 'hash'
         api.has_param :name, 'string'
         api.has_param :onsite_commerce_merchant, 'object'
+        api.has_param :parent_catalog_id, 'string'
         api.has_param :store_catalog_settings, 'hash'
         api.has_param :vertical, { enum: -> { ProductCatalog::VERTICAL }}
       end

data/lib/facebook_ads/ad_objects/business_asset_group.rb

@@ -47,6 +47,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -54,6 +55,7 @@ module FacebookAds
       "PROFILE_PLUS_ADVERTISE",
       "PROFILE_PLUS_ANALYZE",
       "PROFILE_PLUS_CREATE_CONTENT",
+      "PROFILE_PLUS_LIVE_STREAM_MODERATION",
       "PROFILE_PLUS_MANAGE",
       "PROFILE_PLUS_MESSAGING",
       "PROFILE_PLUS_MODERATE",

data/lib/facebook_ads/ad_objects/business_role_request.rb

@@ -33,6 +33,10 @@ module FacebookAds
       "EMPLOYEE",
       "FINANCE_ANALYST",
       "FINANCE_EDITOR",
+      "FINANCE_EDIT_TASK",
+      "FINANCE_VIEW_TASK",
+      "MODERATE_TASK",
+      "OPERATE_TASK",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/business_unit.rb

@@ -79,7 +79,7 @@ module FacebookAds
     has_edge :conversion_paths do |edge|
       edge.get do |api|
         api.has_param :click_lookback_window, 'int'
-        api.has_param :date_range, 'object'
+        api.has_param :date_range, 'hash'
         api.has_param :fb_conversion_event_id, 'int'
         api.has_param :limit, 'int'
         api.has_param :metric_context, 'hash'

data/lib/facebook_ads/ad_objects/business_user.rb

@@ -33,6 +33,10 @@ module FacebookAds
       "EMPLOYEE",
       "FINANCE_ANALYST",
       "FINANCE_EDITOR",
+      "FINANCE_EDIT_TASK",
+      "FINANCE_VIEW_TASK",
+      "MODERATE_TASK",
+      "OPERATE_TASK",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb

@@ -0,0 +1,88 @@
+# 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 CatalogSubVerticalList < AdObject
+
+    field :appliances, 'object'
+    field :baby_feeding, 'object'
+    field :baby_transport, 'object'
+    field :beauty, 'object'
+    field :bedding, 'object'
+    field :cameras, 'object'
+    field :cameras_and_photos, 'object'
+    field :cell_phones_and_smart_watches, 'object'
+    field :cleaning_supplies, 'object'
+    field :clo_offer, 'object'
+    field :clothing, 'object'
+    field :clothing_accessories, 'object'
+    field :clothing_group, 'object'
+    field :computer_components, 'object'
+    field :computers_and_tablets, 'object'
+    field :computers_laptops_and_tablets, 'object'
+    field :diapering_and_potty_training, 'object'
+    field :electronic_accessories_and_cables, 'object'
+    field :electronics_accessories, 'object'
+    field :furniture, 'object'
+    field :health, 'object'
+    field :home, 'object'
+    field :home_goods, 'object'
+    field :household_and_cleaning_supplies, 'object'
+    field :jewelry, 'object'
+    field :large_appliances, 'object'
+    field :loyalty_offer, 'object'
+    field :meetup_space, 'object'
+    field :nursery, 'object'
+    field :printers_and_scanners, 'object'
+    field :printers_scanners_and_fax_machines, 'object'
+    field :product_discount, 'object'
+    field :projectors, 'object'
+    field :shoes, 'object'
+    field :shoes_and_footwear, 'object'
+    field :software, 'object'
+    field :televisions_and_monitors, 'object'
+    field :test_child_sub_vertical, 'object'
+    field :test_grand_child_sub_vertical, 'object'
+    field :test_sub_vertical, 'object'
+    field :test_sub_vertical_alias, 'object'
+    field :test_sub_vertical_data_object, 'object'
+    field :third_party_electronics, 'object'
+    field :third_party_toys_and_games, 'object'
+    field :toys, 'object'
+    field :toys_and_games, 'object'
+    field :tvs_and_monitors, 'object'
+    field :vehicle_manufacturer, 'object'
+    field :video_game_consoles_and_video_games, 'object'
+    field :video_games_and_consoles, 'object'
+    field :video_projectors, 'object'
+    field :watches, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end