facebookbusiness 0.7.0.1 → 0.8.0.3

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -29,12 +29,16 @@ module FacebookAds
 
     field :account_admin, 'hash'
     field :ad, 'hash'
+    field :ads_conversion_experiences, 'hash'
     field :b2c, 'hash'
+    field :b2c_commerce_unified, 'hash'
     field :bsg, 'hash'
     field :city_community, 'hash'
+    field :commerce, 'hash'
     field :daily_deals, 'hash'
     field :daily_deals_legacy, 'hash'
     field :dpa, 'hash'
+    field :dri_copyright, 'hash'
     field :dri_counterfeit, 'hash'
     field :facebook, 'hash'
     field :facebook_pages_live_shopping, 'hash'

data/lib/facebook_ads/ad_objects/{ads_interest.rb → adoptable_pet.rb}

@@ -25,15 +25,29 @@ 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 AdsInterest < AdObject
+  class AdoptablePet < AdObject
 
-    field :audience_size, 'int'
+    field :address, 'object'
+    field :adoptable_pet_id, 'string'
+    field :adoption_application_form_url, 'string'
+    field :age_bucket, 'string'
+    field :animal_type, 'string'
+    field :applinks, 'CatalogItemAppLinks'
+    field :availability, 'string'
+    field :breed, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :currency, 'string'
     field :description, 'string'
-    field :disambiguation_category, 'string'
+    field :gender, 'string'
     field :id, 'string'
+    field :images, { list: 'string' }
     field :name, 'string'
-    field :path, { list: 'string' }
-    field :topic, 'string'
+    field :price, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :shelter_name, 'string'
+    field :shelter_page_id, 'Page'
+    field :size, 'string'
+    field :url, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -153,6 +153,7 @@ module FacebookAds
     field :campaign_name, 'string'
     field :canvas_avg_view_percent, 'string'
     field :canvas_avg_view_time, 'string'
+    field :catalog_segment_actions, { list: 'AdsActionStats' }
     field :catalog_segment_value, { list: 'AdsActionStats' }
     field :catalog_segment_value_mobile_purchase_roas, { list: 'AdsActionStats' }
     field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
@@ -161,6 +162,8 @@ module FacebookAds
     field :conversion_rate_ranking, 'string'
     field :conversion_values, { list: 'AdsActionStats' }
     field :conversions, { list: 'AdsActionStats' }
+    field :converted_product_quantity, { list: 'AdsActionStats' }
+    field :converted_product_value, { list: 'AdsActionStats' }
     field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
     field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
     field :cost_per_action_type, { list: 'AdsActionStats' }
@@ -205,6 +208,7 @@ module FacebookAds
     field :instant_experience_clicks_to_open, 'string'
     field :instant_experience_clicks_to_start, 'string'
     field :instant_experience_outbound_clicks, 'string'
+    field :interactive_component_tap, { list: 'AdsActionStats' }
     field :labels, 'string'
     field :location, 'string'
     field :mobile_app_purchase_roas, { list: 'AdsActionStats' }

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

@@ -35,6 +35,7 @@ module FacebookAds
       "IPAD",
       "IPHONE",
       "MOBILE_WEB",
+      "OCULUS",
       "SUPPLEMENTARY_IMAGES",
       "WEB",
       "WINDOWS",
@@ -226,15 +227,20 @@ 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'
+        api.has_param :data_processing_options, { list: 'string' }
+        api.has_param :data_processing_options_country, 'int'
+        api.has_param :data_processing_options_state, 'int'
         api.has_param :device_token, 'string'
         api.has_param :event, { enum: %w{CUSTOM_APP_EVENTS DEFERRED_APP_LINK MOBILE_APP_INSTALL }}
         api.has_param :extinfo, 'object'
         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'
@@ -284,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
@@ -385,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
 
@@ -451,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'
@@ -474,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

@@ -142,10 +142,10 @@ module FacebookAds
 
     has_edge :metrics_breakdown do |edge|
       edge.get do |api|
-        api.has_param :dimensions, { list: { enum: %w{DEVICE_TYPE SOURCE_CHANNEL }} }
-        api.has_param :granularity, { enum: %w{DAY HOUR MONTH WEEK YEAR }}
+        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

@@ -60,9 +60,6 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "ANALYZE",
-      "CREATIVE",
-      "DRAFT",
-      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 
@@ -81,6 +78,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -88,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",
@@ -120,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
@@ -210,15 +210,16 @@ module FacebookAds
       edge.get 'Business'
     end
 
-    has_edge :an_placements do |edge|
-      edge.get 'AdPlacement'
+    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 :attempted_sharing_agreements do |edge|
-      edge.get 'BusinessCreativeFolderSharingAgreement' do |api|
-        api.has_param :request_status, { enum: -> { BusinessCreativeFolderSharingAgreement::REQUEST_STATUS }}
-        api.has_param :requesting_business_id, 'string'
-      end
+    has_edge :an_placements do |edge|
+      edge.get 'AdPlacement'
     end
 
     has_edge :block_list_drafts do |edge|
@@ -295,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'
@@ -302,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
@@ -317,22 +342,11 @@ module FacebookAds
       end
     end
 
-    has_edge :creative_asset_tags do |edge|
-      edge.get 'CreativeAssetTag'
-    end
-
-    has_edge :creative_folders do |edge|
-      edge.get 'BusinessCreativeFolder'
-      edge.post 'BusinessCreativeFolder' do |api|
-        api.has_param :description, 'string'
+    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 :parent_folder_id, 'string'
-      end
-    end
-
-    has_edge :creatives do |edge|
-      edge.get 'BusinessCreative' do |api|
-        api.has_param :creative_folder_id, 'string'
+        api.has_param :publisher_urls, { list: 'string' }
       end
     end
 
@@ -362,16 +376,6 @@ module FacebookAds
       end
     end
 
-    has_edge :images do |edge|
-      edge.post 'BusinessImage' do |api|
-        api.has_param :ad_placements_validation_only, 'bool'
-        api.has_param :bytes, 'object'
-        api.has_param :creative_folder_id, 'string'
-        api.has_param :name, 'string'
-        api.has_param :validation_ad_placements, { list: { enum: -> { BusinessImage::VALIDATION_AD_PLACEMENTS }} }
-      end
-    end
-
     has_edge :initiated_audience_sharing_requests do |edge|
       edge.get 'BusinessAssetSharingAgreement' do |api|
         api.has_param :recipient_id, 'string'
@@ -398,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'
@@ -446,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'
@@ -480,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
@@ -517,10 +527,6 @@ module FacebookAds
       edge.get 'BusinessPageRequest'
     end
 
-    has_edge :pending_shared_creative_folders do |edge|
-      edge.get 'BusinessCreativeFolder'
-    end
-
     has_edge :pending_users do |edge|
       edge.get 'BusinessRoleRequest' do |api|
         api.has_param :email, 'string'
@@ -529,6 +535,7 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
+        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
@@ -580,83 +587,5 @@ module FacebookAds
       end
     end
 
-    has_edge :videos do |edge|
-      edge.post 'AdVideo' do |api|
-        api.has_param :ad_placements_validation_only, 'bool'
-        api.has_param :adaptive_type, 'string'
-        api.has_param :animated_effect_id, 'int'
-        api.has_param :application_id, 'string'
-        api.has_param :asked_fun_fact_prompt_id, 'int'
-        api.has_param :attribution_app_id, 'string'
-        api.has_param :audio_story_wave_animation_handle, 'string'
-        api.has_param :chunk_session_id, 'string'
-        api.has_param :composer_entry_picker, 'string'
-        api.has_param :composer_entry_point, 'string'
-        api.has_param :composer_entry_time, 'int'
-        api.has_param :composer_session_events_log, 'string'
-        api.has_param :composer_session_id, 'string'
-        api.has_param :composer_source_surface, 'string'
-        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_folder_id, 'string'
-        api.has_param :description, 'string'
-        api.has_param :embeddable, 'bool'
-        api.has_param :end_offset, 'int'
-        api.has_param :fbuploader_video_file_chunk, 'string'
-        api.has_param :file_size, 'int'
-        api.has_param :file_url, 'string'
-        api.has_param :fisheye_video_cropped, 'bool'
-        api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
-        api.has_param :fov, 'int'
-        api.has_param :front_z_rotation, 'double'
-        api.has_param :fun_fact_prompt_id, 'int'
-        api.has_param :fun_fact_toastee_id, 'int'
-        api.has_param :guide, { list: { list: 'int' } }
-        api.has_param :guide_enabled, 'bool'
-        api.has_param :has_nickname, 'bool'
-        api.has_param :holiday_card, 'string'
-        api.has_param :initial_heading, 'int'
-        api.has_param :initial_pitch, 'int'
-        api.has_param :instant_game_entry_point_data, 'string'
-        api.has_param :is_boost_intended, 'bool'
-        api.has_param :is_group_linking_post, 'bool'
-        api.has_param :is_voice_clip, 'bool'
-        api.has_param :location_source_id, 'string'
-        api.has_param :offer_like_post_id, 'int'
-        api.has_param :og_action_type_id, 'string'
-        api.has_param :og_icon_id, 'string'
-        api.has_param :og_object_id, 'string'
-        api.has_param :og_phrase, 'string'
-        api.has_param :og_suggestion_mechanism, 'string'
-        api.has_param :original_fov, 'int'
-        api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
-        api.has_param :publish_event_id, 'int'
-        api.has_param :react_mode_metadata, 'string'
-        api.has_param :referenced_sticker_id, 'string'
-        api.has_param :replace_video_id, 'string'
-        api.has_param :sales_promo_id, 'int'
-        api.has_param :slideshow_spec, 'hash'
-        api.has_param :source, 'string'
-        api.has_param :spherical, 'bool'
-        api.has_param :start_offset, 'int'
-        api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
-        api.has_param :text_format_metadata, 'string'
-        api.has_param :throwback_camera_roll_media, 'string'
-        api.has_param :thumb, 'file'
-        api.has_param :time_since_original_post, 'int'
-        api.has_param :title, 'string'
-        api.has_param :transcode_setting_properties, 'string'
-        api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
-        api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
-        api.has_param :upload_session_id, 'string'
-        api.has_param :upload_setting_properties, 'string'
-        api.has_param :validation_ad_placements, { list: { enum: -> { AdVideo::VALIDATION_AD_PLACEMENTS }} }
-        api.has_param :video_file_chunk, 'string'
-        api.has_param :video_start_time_ms, 'int'
-        api.has_param :waterfall_id, 'string'
-      end
-    end
-
   end
 end