facebookbusiness 0.15.0.2 → 0.16.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682be241264d4bfdfe536f57817964f9bf01077e446b85d1240c224036cfc5d4
-  data.tar.gz: 87bfe3812712820d50f68f399210bf11d9056a9ee0cabb96b0eae84da3b7728f
+  metadata.gz: 1d23f8de09b10d1d1d6fabaca98ca983c793c1ce7438e28bc107419b34375e0a
+  data.tar.gz: 76c47ff4a628b9cfa860b58d1ba51ad0b841638bc96423ef4e0189af9724214f
 SHA512:
-  metadata.gz: ecef88b246cd6eea373b1cdd272a7602a88bc22d133c561c11d628679523ff8e5317b3a26ef4f2b201626085417b7b1f2c00175da3306b7f6fab8ea7f1dfb938
-  data.tar.gz: '091c53d78cae3c71dc806bb87ccbc34cd50769b908a41547ebbfb18e92474fd4f7a97d5b03ee6ba4a136334ca95b82f14d037e5fc3f57aac81d7d98b9b177251'
+  metadata.gz: 275d9b8328e3bfc83c568ea4e884bbda3458caa41d9a771c2524892ec3368fae9f85ce2e1ed140a23492d4f2821a71ddacf0ae5d192ede171377cd2792c9b59f
+  data.tar.gz: d96b110ec30f7cd72119aadc97699aaa6a3eafa6372d8ec8b402656ff692d38f5a7bfe04679837e745fe29765daec665df55eda1577c82e1d6afeea6adc9a855

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -137,6 +137,11 @@ module FacebookAds
       "WEBSITE",
     ]
 
+    ACTION_SOURCE = [
+      "PHYSICAL_STORE",
+      "WEBSITE",
+    ]
+
 
     field :account_id, 'string'
     field :account_status, 'int'
@@ -671,6 +676,12 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
     has_edge :campaigns do |edge|
       edge.delete do |api|
         api.has_param :before_date, 'datetime'

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -48,10 +48,12 @@ module FacebookAds
       "FRAGMENTATION",
       "LEARNING_LIMITED",
       "LOW_OUTCOME",
+      "MMT_CAROUSEL_TO_VIDEO",
       "MULTI_TEXT",
       "MUSIC",
       "PREDICTIVE_CREATIVE_LIMITED",
       "REVERT",
+      "SEMANTIC_BASED_AUDIENCE_EXPANSION",
       "SIGNALS_GROWTH_CAPI",
       "SYD_TEST_MODE",
       "TOP_ADSETS_WITH_ADS_UNDER_CAP",

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -194,6 +194,7 @@ module FacebookAds
     field :billing_event, { enum: -> { BILLING_EVENT }}
     field :budget_remaining, 'string'
     field :campaign, 'Campaign'
+    field :campaign_attribution, 'string'
     field :campaign_id, 'string'
     field :configured_status, { enum: -> { CONFIGURED_STATUS }}
     field :created_time, 'datetime'

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -32,6 +32,7 @@ module FacebookAds
       "ADS_AI_GENERATED",
       "AD_BREAK_PREVIEW",
       "AD_DERIVATIVE",
+      "AD_LIBRARY_WATERMARK",
       "AGE_UP",
       "ALBUM_MULTIMEDIA_POST",
       "ALOHA_CALL_VIDEO",
@@ -113,6 +114,7 @@ module FacebookAds
       "LEGACY_CONTAINED_POST_BROADCAST",
       "LIVE_AUDIO_ROOM_BROADCAST",
       "LIVE_CLIP_PREVIEW",
+      "LIVE_CLIP_WORKCHAT",
       "LIVE_CREATIVE_KIT_VIDEO",
       "LIVE_PHOTO",
       "LOOK_NOW_DEPRECATED",

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -69,21 +69,47 @@ module FacebookAds
     field :automatic_matching_fields, { list: 'string' }
     field :can_proxy, 'bool'
     field :code, 'string'
+    field :config, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
     field :data_use_setting, 'string'
+    field :description, 'string'
+    field :duplicate_entries, 'int'
+    field :enable_auto_assign_to_accounts, 'bool'
     field :enable_automatic_matching, 'bool'
+    field :event_stats, 'string'
+    field :event_time_max, 'int'
+    field :event_time_min, 'int'
     field :first_party_cookie_status, 'string'
     field :id, 'string'
+    field :is_consolidated_container, 'bool'
     field :is_created_by_business, 'bool'
     field :is_crm, 'bool'
+    field :is_mta_use, 'bool'
+    field :is_restricted_use, 'bool'
     field :is_unavailable, 'bool'
     field :last_fired_time, 'datetime'
+    field :last_upload_app, 'string'
+    field :last_upload_app_changed_time, 'int'
+    field :match_rate_approx, 'int'
+    field :matched_entries, 'int'
     field :name, 'string'
     field :owner_ad_account, 'AdAccount'
     field :owner_business, 'Business'
+    field :usage, 'OfflineConversionDataSetUsage'
+    field :valid_entries, 'int'
     has_no_delete
 
+    has_edge :adaccounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
+    has_edge :agencies do |edge|
+      edge.get 'Business'
+    end
+
     has_edge :assigned_users do |edge|
       edge.get 'AssignedUser' do |api|
         api.has_param :business, 'string'
@@ -119,6 +145,16 @@ module FacebookAds
       edge.post
     end
 
+    has_edge :offline_event_uploads do |edge|
+      edge.get 'OfflineConversionDataSetUpload' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :order, { enum: -> { OfflineConversionDataSetUpload::ORDER }}
+        api.has_param :sort_by, { enum: -> { OfflineConversionDataSetUpload::SORT_BY }}
+        api.has_param :start_time, 'datetime'
+        api.has_param :upload_tag, 'string'
+      end
+    end
+
     has_edge :shadowtraffichelper do |edge|
       edge.post
     end

data/lib/facebook_ads/ad_objects/business.rb

@@ -120,6 +120,211 @@ module FacebookAds
       "VIEW_MONETIZATION_INSIGHTS",
     ]
 
+    SUBVERTICAL_V2 = [
+      "ACCOUNTING_AND_TAX",
+      "ACTIVITIES_AND_LEISURE",
+      "AIR",
+      "APPAREL_AND_ACCESSORIES",
+      "ARTS_AND_HERITAGE_AND_EDUCATION",
+      "AR_OR_VR_GAMING",
+      "AUDIO_STREAMING",
+      "AUTO",
+      "AUTO_INSURANCE",
+      "AUTO_RENTAL",
+      "BABY",
+      "BALLOT_INITIATIVE_OR_REFERENDUM",
+      "BEAUTY",
+      "BEAUTY_AND_FASHION",
+      "BEER_AND_WINE_AND_LIQUOR_AND_MALT_BEVERAGES",
+      "BOOKSTORES",
+      "BROADCAST_TELEVISION",
+      "BUSINESS_CONSULTANTS",
+      "BUYING_AGENCY",
+      "CABLE_AND_SATELLITE",
+      "CABLE_TELEVISION",
+      "CALL_CENTER_AND_MESSAGING_SERVICES",
+      "CANDIDATE_OR_POLITICIAN",
+      "CAREER",
+      "CAREER_AND_TECH",
+      "CASUAL_DINING",
+      "CHRONIC_CONDITIONS_AND_MEDICAL_CAUSES",
+      "CIVIC_INFLUENCERS",
+      "CLINICAL_TRIALS",
+      "COFFEE",
+      "COMPUTER_AND_SOFTWARE_AND_HARDWARE",
+      "CONSOLE_AND_CROSS_PLATFORM_GAMING",
+      "CONSULTING",
+      "CONSUMER_ELECTRONICS",
+      "COUNSELING_AND_PSYCHOTHERAPY",
+      "CREATIVE_AGENCY",
+      "CREDIT_AND_FINANCING_AND_MORTAGES",
+      "CRUISES_AND_MARINE",
+      "CULTURE_AND_LIFESTYLE",
+      "DATA_ANALYTICS_AND_DATA_MANAGEMENT",
+      "DATING_AND_TECHNOLOGY_APPS",
+      "DEPARTMENT_STORE",
+      "DESKTOP_SOFTWARE",
+      "DIETING_AND_FITNESS_PROGRAMS",
+      "DIGITAL_NATIVE_EDUCATION_OR_TRAINING",
+      "DRINKING_PLACES",
+      "EDUCATION_RESOURCES",
+      "ED_TECH",
+      "ELEARNING_AND_MASSIVE_ONLINE_OPEN_COURSES",
+      "ELECTION_COMMISSION",
+      "ELECTRONICS_AND_APPLIANCES",
+      "ENGINEERING_AND_DESIGN",
+      "ENVIRONMENT_AND_ANIMAL_WELFARE",
+      "ESPORTS",
+      "EVENTS",
+      "FARMING_AND_RANCHING",
+      "FILE_STORAGE_AND_CLOUD_AND_DATA_SERVICES",
+      "FINANCE",
+      "FIN_TECH",
+      "FISHING_AND_HUNTING_AND_FORESTRY_AND_LOGGING",
+      "FITNESS",
+      "FOOD",
+      "FOOTWEAR",
+      "FOR_PROFIT_COLLEGES_AND_UNIVERSITIES",
+      "FULL_SERVICE_AGENCY",
+      "GOVERNMENT_CONTROLLED_ENTITY",
+      "GOVERNMENT_DEPARTMENT_OR_AGENCY",
+      "GOVERNMENT_OFFICIAL",
+      "GOVERNMENT_OWNED_MEDIA",
+      "GROCERY_AND_DRUG_AND_CONVENIENCE",
+      "HEAD_OF_STATE",
+      "HEALTH_INSURANCE",
+      "HEALTH_SYSTEMS_AND_PRACTITIONERS",
+      "HEALTH_TECH",
+      "HOME_AND_FURNITURE_AND_OFFICE",
+      "HOME_IMPROVEMENT",
+      "HOME_INSURANCE",
+      "HOME_TECH",
+      "HOTEL_AND_ACCOMODATION",
+      "HOUSEHOLD_GOODS_DURABLE",
+      "HOUSEHOLD_GOODS_NON_DURABLE",
+      "HR_AND_FINANCIAL_MANAGEMENT",
+      "HUMANITARIAN_OR_DISASTER_RELIEF",
+      "INDEPENDENT_EXPENDITURE_GROUP",
+      "INSURANCE_TECH",
+      "INTERNATIONAL_ORGANIZATON",
+      "INVESTMENT_BANK_AND_BROKERAGE",
+      "ISSUE_ADVOCACY",
+      "LEGAL",
+      "LIFE_INSURANCE",
+      "LOGISTICS_AND_TRANSPORTATION_AND_FLEET_MANAGEMENT",
+      "MANUFACTURING",
+      "MEDICAL_DEVICES_AND_SUPPLIES_AND_EQUIPMENT",
+      "MEDSPA_AND_ELECTIVE_SURGERIES_AND_ALTERNATIVE_MEDICINE",
+      "MINING_AND_QUARRYING",
+      "MOBILE_GAMING",
+      "MOVIES",
+      "MUSEUMS_AND_PARKS_AND_LIBRARIES",
+      "MUSIC",
+      "NETWORK_SECURITY_PRODUCTS",
+      "NEWS_AND_CURRENT_EVENTS",
+      "NON_PRESCRIPTION",
+      "NOT_FOR_PROFIT_COLLEGES_AND_UNIVERSITIES",
+      "OFFICE",
+      "OFFICE_OR_BUSINESS_SUPPLIES",
+      "OIL_AND_GAS_AND_CONSUMABLE_FUEL",
+      "ONLINE_ONLY_PUBLICATIONS",
+      "PACKAGE_OR_FREIGHT_DELIVERY",
+      "PARTY_INDEPENDENT_EXPENDITURE_GROUP_US",
+      "PAYMENT_PROCESSING_AND_GATEWAY_SOLUTIONS",
+      "PC_GAMING",
+      "PEOPLE",
+      "PERSONAL_CARE",
+      "PET",
+      "PHOTOGRAPHY_AND_FILMING_SERVICES",
+      "PIZZA",
+      "PLANNING_AGENCY",
+      "POLITICAL_PARTY_OR_COMMITTEE",
+      "PRESCRIPTION",
+      "PROFESSIONAL_ASSOCIATIONS",
+      "PROPERTY_AND_CASUALTY",
+      "QUICK_SERVICE",
+      "RADIO",
+      "RAILROADS",
+      "REAL_ESTATE",
+      "REAL_MONEY_GAMING",
+      "RECREATIONAL",
+      "RELIGIOUS",
+      "RESELLER",
+      "RESIDENTIAL_AND_LONG_TERM_CARE_FACILITIES_AND_OUTPATIENT_CARE_CENTERS",
+      "RETAIL_AND_CREDIT_UNION_AND_COMMERCIAL_BANK",
+      "RIDE_SHARING_OR_TAXI_SERVICES",
+      "SAFETY_SERVICES",
+      "SCHOLARLY",
+      "SCHOOL_AND_EARLY_CHILDREN_EDCATION",
+      "SOCIAL_MEDIA",
+      "SOFTWARE_AS_A_SERVICE",
+      "SPORTING",
+      "SPORTING_AND_OUTDOOR",
+      "SPORTS",
+      "SUPERSTORES",
+      "T1_AUTOMOTIVE_MANUFACTURER",
+      "T1_MOTORCYCLE",
+      "T2_DEALER_ASSOCIATIONS",
+      "T3_AUTO_AGENCY",
+      "T3_AUTO_RESELLERS",
+      "T3_DEALER_GROUPS",
+      "T3_FRANCHISE_DEALER",
+      "T3_INDEPENDENT_DEALER",
+      "T3_PARTS_AND_SERVICES",
+      "T3_PORTALS",
+      "TELECOMMUNICATIONS_EQUIPMENT_AND_ACCESSORIES",
+      "TELEPHONE_SERVICE_PROVIDERS_AND_CARRIERS",
+      "TICKETING",
+      "TOBACCO",
+      "TOURISM_AND_TRAVEL_SERVICES",
+      "TOURISM_BOARD",
+      "TOY_AND_HOBBY",
+      "TRADE_SCHOOL",
+      "TRAVEL_AGENCIES_AND_GUIDES_AND_OTAS",
+      "UTILITIES_AND_ENERGY_EQUIPMENT_AND_SERVICES",
+      "VETERINARY_CLINICS_AND_SERVICES",
+      "VIDEO_STREAMING",
+      "VIRTUAL_SERVICES",
+      "VITAMINS_OR_WELLNESS",
+      "WAREHOUSING_AND_STORAGE",
+      "WATER_AND_SOFT_DRINK_AND_BAVERAGE",
+      "WEBSITE_DESIGNERS_OR_GRAPHIC_DESIGNERS",
+      "WHOLESALE",
+      "WIRELESS_SERVICES",
+    ]
+
+    VERTICAL_V2 = [
+      "ADVERTISING_AND_MARKETING",
+      "AGRICULTURE",
+      "AUTOMOTIVE",
+      "BANKING_AND_CREDIT_CARDS",
+      "BUSINESS_TO_BUSINESS",
+      "CONSUMER_PACKAGED_GOODS",
+      "ECOMMERCE",
+      "EDUCATION",
+      "ENERGY_AND_NATURAL_RESOURCES_AND_UTILITIES",
+      "ENTERTAINMENT_AND_MEDIA",
+      "GAMING",
+      "GOVERNMENT",
+      "HEALTHCARE_AND_PHARMACEUTICALS_AND_BIOTECH",
+      "INSURANCE",
+      "NON_PROFIT",
+      "ORGANIZATIONS_AND_ASSOCIATIONS",
+      "POLITICS",
+      "PROFESSIONAL_SERVICES",
+      "PUBLISHING",
+      "RESTAURANTS",
+      "RETAIL",
+      "TECHNOLOGY",
+      "TELECOM",
+      "TRAVEL",
+    ]
+
+    ACTION_SOURCE = [
+      "PHYSICAL_STORE",
+      "WEBSITE",
+    ]
+
 
     field :block_offline_analytics, 'bool'
     field :collaborative_ads_managed_partner_business_info, 'ManagedPartnerBusiness'
@@ -295,6 +500,10 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get
+    end
+
     has_edge :claim_custom_conversions do |edge|
       edge.post 'CustomConversion' do |api|
         api.has_param :custom_conversion_id, 'string'
@@ -661,6 +870,16 @@ module FacebookAds
       end
     end
 
+    has_edge :setup_managed_partner_adaccounts do |edge|
+      edge.post 'Business' do |api|
+        api.has_param :credit_line_id, 'string'
+        api.has_param :marketplace_business_id, 'string'
+        api.has_param :subvertical_v2, { enum: -> { Business::SUBVERTICAL_V2 }}
+        api.has_param :vendor_id, 'string'
+        api.has_param :vertical_v2, { enum: -> { Business::VERTICAL_V2 }}
+      end
+    end
+
     has_edge :system_users do |edge|
       edge.get 'SystemUser'
       edge.post 'SystemUser' do |api|

data/lib/facebook_ads/ad_objects/event.rb

@@ -106,6 +106,7 @@ module FacebookAds
     field :owner, 'object'
     field :parent_group, 'Group'
     field :place, 'Place'
+    field :registration_setting, 'object'
     field :scheduled_publish_time, 'string'
     field :start_time, 'string'
     field :ticket_setting, 'object'

data/lib/facebook_ads/ad_objects/group.rb

@@ -163,14 +163,6 @@ module FacebookAds
       edge.get 'Event'
     end
 
-    has_edge :featured_cards do |edge|
-      edge.get
-      edge.post do |api|
-        api.has_param :description, 'hash'
-        api.has_param :title, 'hash'
-      end
-    end
-
     has_edge :feed do |edge|
       edge.get 'Post' do |api|
         api.has_param :include_hidden, 'bool'

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -117,6 +117,10 @@ module FacebookAds
       end
     end
 
+    has_edge :notification_message_tokens do |edge|
+      edge.get 'UserPageOneTimeOptInTokenSettings'
+    end
+
     has_edge :product_appeal do |edge|
       edge.get do |api|
         api.has_param :product_id, 'string'

data/lib/facebook_ads/ad_objects/lead.rb

@@ -42,6 +42,7 @@ module FacebookAds
     field :is_organic, 'bool'
     field :partner_name, 'string'
     field :platform, 'string'
+    field :post, 'Link'
     field :retailer_item_id, 'string'
     field :vehicle, 'Vehicle'
     has_no_post

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -41,25 +41,35 @@ module FacebookAds
     ]
 
 
+    field :automatic_matching_fields, { list: 'string' }
     field :business, 'Business'
+    field :can_proxy, 'bool'
     field :config, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
+    field :data_use_setting, 'string'
     field :description, 'string'
     field :duplicate_entries, 'int'
     field :enable_auto_assign_to_accounts, 'bool'
+    field :enable_automatic_matching, 'bool'
     field :event_stats, 'string'
     field :event_time_max, 'int'
     field :event_time_min, 'int'
+    field :first_party_cookie_status, 'string'
     field :id, 'string'
+    field :is_consolidated_container, 'bool'
+    field :is_created_by_business, 'bool'
+    field :is_crm, 'bool'
     field :is_mta_use, 'bool'
     field :is_restricted_use, 'bool'
     field :is_unavailable, 'bool'
+    field :last_fired_time, 'datetime'
     field :last_upload_app, 'string'
     field :last_upload_app_changed_time, 'int'
     field :match_rate_approx, 'int'
     field :matched_entries, 'int'
     field :name, 'string'
+    field :owner_ad_account, 'AdAccount'
     field :owner_business, 'Business'
     field :usage, 'OfflineConversionDataSetUsage'
     field :valid_entries, 'int'
@@ -110,6 +120,23 @@ module FacebookAds
       end
     end
 
+    has_edge :server_events_permitted_business do |edge|
+      edge.get 'Business'
+    end
+
+    has_edge :shared_accounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :action_source, { enum: -> { AdAccount::ACTION_SOURCE }}
+        api.has_param :business, 'string'
+      end
+    end
+
+    has_edge :shared_agencies do |edge|
+      edge.get 'Business' do |api|
+        api.has_param :action_source, { enum: -> { Business::ACTION_SOURCE }}
+      end
+    end
+
     has_edge :stats do |edge|
       edge.get do |api|
         api.has_param :aggr_time, { enum: %w{event_time upload_time }}

data/lib/facebook_ads/ad_objects/page.rb

@@ -617,6 +617,12 @@ module FacebookAds
       end
     end
 
+    has_edge :businessprojects do |edge|
+      edge.get do |api|
+        api.has_param :business, 'string'
+      end
+    end
+
     has_edge :call_to_actions do |edge|
       edge.get 'PageCallToAction'
     end