facebookbusiness 0.6.0.4 → 0.8.0.0

data/lib/facebook_ads/ad_objects/adgroup_activity.rb

@@ -69,8 +69,8 @@ module FacebookAds
     ]
 
 
-    field :ad_creative_id_new, 'string'
-    field :ad_creative_id_old, 'string'
+    field :ad_creative_id_new, 'AdCreative'
+    field :ad_creative_id_old, 'AdCreative'
     field :asset_feed_id_new, 'string'
     field :asset_feed_id_old, 'string'
     field :bid_amount_new, 'int'
@@ -105,8 +105,8 @@ module FacebookAds
     field :reason_old, 'string'
     field :run_status_new, 'string'
     field :run_status_old, 'string'
-    field :source_adgroup_id_new, 'string'
-    field :source_adgroup_id_old, 'string'
+    field :source_adgroup_id_new, 'Ad'
+    field :source_adgroup_id_old, 'Ad'
     field :start_time_new, 'datetime'
     field :start_time_old, 'datetime'
     field :stop_time_new, 'datetime'

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -29,12 +29,17 @@ 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'
     field :instagram, 'hash'

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

@@ -25,15 +25,28 @@ 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 :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

@@ -33,6 +33,7 @@ module FacebookAds
       "28d_view",
       "7d_click",
       "7d_view",
+      "dda",
       "default",
     ]
 
@@ -152,10 +153,17 @@ 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' }
+    field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
     field :clicks, 'string'
     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' }
@@ -200,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' }
@@ -208,6 +217,7 @@ module FacebookAds
     field :outbound_clicks_ctr, { list: 'AdsActionStats' }
     field :place_page_name, 'string'
     field :purchase_roas, { list: 'AdsActionStats' }
+    field :qualifying_question_qualify_answer_rate, 'string'
     field :quality_ranking, 'string'
     field :quality_score_ectr, 'string'
     field :quality_score_ecvr, 'string'

data/lib/facebook_ads/ad_objects/album.rb

@@ -78,6 +78,7 @@ module FacebookAds
     end
 
     has_edge :likes do |edge|
+      edge.get 'Profile'
       edge.post 'Album' do |api|
         api.has_param :feedback_source, 'string'
         api.has_param :nectar_module, 'string'
@@ -151,6 +152,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/application.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "IPAD",
       "IPHONE",
       "MOBILE_WEB",
+      "OCULUS",
       "SUPPLEMENTARY_IMAGES",
       "WEB",
       "WINDOWS",
@@ -229,6 +230,9 @@ module FacebookAds
         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'

data/lib/facebook_ads/ad_objects/atlas_campaign.rb

@@ -142,8 +142,8 @@ 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' }
       end

data/lib/facebook_ads/ad_objects/automotive_model.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class AutomotiveModel < AdObject
 
+    field :applinks, 'CatalogItemAppLinks'
     field :automotive_model_id, 'string'
     field :availability, 'string'
     field :body_style, '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",
     ]
 
@@ -214,13 +211,6 @@ module FacebookAds
       edge.get 'AdPlacement'
     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
-    end
-
     has_edge :block_list_drafts do |edge|
       edge.post 'Business' do |api|
         api.has_param :publisher_urls_file, 'file'
@@ -302,6 +292,10 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :commerce_merchant_settings do |edge|
+      edge.get 'CommerceMerchantSettings'
+    end
+
     has_edge :content_delivery_report do |edge|
       edge.get 'ContentDeliveryReport' do |api|
         api.has_param :end_date, 'datetime'
@@ -313,25 +307,6 @@ 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'
-        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'
-      end
-    end
-
     has_edge :customconversions do |edge|
       edge.post 'CustomConversion' do |api|
         api.has_param :advanced_rule, 'string'
@@ -358,16 +333,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'
@@ -375,6 +340,13 @@ module FacebookAds
       end
     end
 
+    has_edge :initiated_sharing_agreements do |edge|
+      edge.get 'BusinessAgreement' do |api|
+        api.has_param :receiving_business_id, 'string'
+        api.has_param :request_status, { enum: -> { BusinessAgreement::REQUEST_STATUS }}
+      end
+    end
+
     has_edge :instagram_accounts do |edge|
       edge.delete do |api|
         api.has_param :instagram_account, 'string'
@@ -458,7 +430,6 @@ module FacebookAds
       edge.get 'Page'
       edge.post 'Business' do |api|
         api.has_param :code, 'string'
-        api.has_param :ig_password, 'string'
         api.has_param :page_id, 'int'
       end
     end
@@ -470,10 +441,12 @@ module FacebookAds
     has_edge :owned_product_catalogs do |edge|
       edge.get 'ProductCatalog'
       edge.post 'ProductCatalog' do |api|
+        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 :store_catalog_settings, 'hash'
         api.has_param :vertical, { enum: -> { ProductCatalog::VERTICAL }}
       end
@@ -505,10 +478,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'
@@ -517,6 +486,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 }}
@@ -535,6 +505,13 @@ module FacebookAds
       end
     end
 
+    has_edge :received_sharing_agreements do |edge|
+      edge.get 'BusinessAgreement' do |api|
+        api.has_param :request_status, { enum: -> { BusinessAgreement::REQUEST_STATUS }}
+        api.has_param :requesting_business_id, 'string'
+      end
+    end
+
     has_edge :system_users do |edge|
       edge.get 'SystemUser'
       edge.post 'SystemUser' do |api|
@@ -561,83 +538,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

data/lib/facebook_ads/ad_objects/{business_creative_folder_sharing_agreement.rb → business_agreement.rb}

@@ -25,7 +25,7 @@ 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 BusinessCreativeFolderSharingAgreement < AdObject
+  class BusinessAgreement < AdObject
     REQUEST_STATUS = [
       "APPROVE",
       "DECLINE",
@@ -35,11 +35,8 @@ module FacebookAds
     ]
 
 
-    field :folder_id, 'string'
     field :id, 'string'
-    field :requesting_business, 'Business'
-    field :status, 'string'
-    has_no_post
+    field :request_status, 'string'
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/business_asset_group.rb

@@ -29,9 +29,6 @@ module FacebookAds
     ADACCOUNT_TASKS = [
       "ADVERTISE",
       "ANALYZE",
-      "CREATIVE",
-      "DRAFT",
-      "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
 

data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb

@@ -41,6 +41,7 @@ module FacebookAds
     field :requesting_business, 'Business'
     field :status, 'string'
     has_no_post
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/business_role_request.rb

@@ -29,9 +29,15 @@ module FacebookAds
     ROLE = [
       "ADMIN",
       "ADS_RIGHTS_REVIEWER",
+      "DEVELOPER",
       "EMPLOYEE",
       "FINANCE_ANALYST",
       "FINANCE_EDITOR",
+      "PARTNER_CENTER_ADMIN",
+      "PARTNER_CENTER_ANALYST",
+      "PARTNER_CENTER_EDUCATION",
+      "PARTNER_CENTER_MARKETING",
+      "PARTNER_CENTER_OPERATIONS",
     ]