facebookbusiness 0.5.0.4 → 0.5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f3364c15486538d87f8ff31c8fc6ab3d8d76f88e7346e67f70b54467ad870b
-  data.tar.gz: 3044a1c8aeda9827dc9d8e5f01b6d5f86e627de1b77c04b807681710ea599ef9
+  metadata.gz: fcda16932827aa975182f17dee963e67a4c54e21aeab3206f23eabc26d813ff5
+  data.tar.gz: b3f91578aec03e5d930e675565cf702ab84404f77de7837cfbf11df628768fe4
 SHA512:
-  metadata.gz: 9a0a9d0869a1025476e970fc6be613b6afdbe6367204350187c6b2113e3a5bdd15091504ff804c5174128d45814794c7262325662a26457d018097f447543d83
-  data.tar.gz: 5f1510cde5f6118f2a0dab4cd34e8897691b5394d01c39c33eebc54d551a213ab8b51807412eb3cb14fee08afd806bb4bffd68193f5fcea5b2dad66006776ed3
+  metadata.gz: ace1378cf0beb8d368abcf5b796f570172f9b153e7c1b32858127c67ca20d91fa26fce7a6e76823c18d937edb9fa0e7fa6a22fc6c66e3e55d9007d34bd644426
+  data.tar.gz: eb1bea9475b4d2bd572e2823dc07f0a954dd45e7dddfa735275fe62d29e3d65abe3f25ac54675e9c6933ade68969104b7b16a7aeffa7381481b94cb3e336ab62

data/lib/facebook_ads/ad_objects/ad.rb

@@ -229,6 +229,11 @@ module FacebookAds
 
     has_edge :leads do |edge|
       edge.get 'Lead'
+      edge.post 'Lead' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :session_id, 'string'
+        api.has_param :start_time, 'datetime'
+      end
     end
 
     has_edge :previews do |edge|
@@ -254,6 +259,7 @@ module FacebookAds
     end
 
     has_edge :trackingtag do |edge|
+      edge.delete
       edge.post do |api|
         api.has_param :add_template_param, 'bool'
         api.has_param :url, 'string'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -241,6 +241,22 @@ module FacebookAds
       end
     end
 
+    has_edge :ad_saved_locations do |edge|
+      edge.get 'AdSavedLocation' do |api|
+        api.has_param :fields, { list: 'string' }
+      end
+      edge.post 'AdSavedLocation' do |api|
+        api.has_param :cities, { list: 'object' }
+        api.has_param :countries, { list: 'string' }
+        api.has_param :country_groups, { list: 'string' }
+        api.has_param :custom_locations, { list: 'object' }
+        api.has_param :geo_markets, { list: 'object' }
+        api.has_param :name, 'string'
+        api.has_param :regions, { list: 'object' }
+        api.has_param :zips, { list: 'object' }
+      end
+    end
+
     has_edge :ad_sets do |edge|
       edge.delete do |api|
         api.has_param :before_date, 'datetime'
@@ -302,6 +318,13 @@ module FacebookAds
       end
     end
 
+    has_edge :adcreatives_from_mockups do |edge|
+      edge.post 'AdCreative' do |api|
+        api.has_param :mockup_id, 'string'
+        api.has_param :page_id, 'string'
+      end
+    end
+
     has_edge :adcreativesbylabels do |edge|
       edge.get 'AdCreative' do |api|
         api.has_param :ad_label_ids, { list: 'string' }
@@ -346,6 +369,10 @@ module FacebookAds
       end
     end
 
+    has_edge :adreportruns do |edge|
+      edge.get 'AdReportRun'
+    end
+
     has_edge :adreportschedules do |edge|
       edge.get
       edge.post do |api|
@@ -717,6 +744,10 @@ module FacebookAds
       end
     end
 
+    has_edge :businesssettinglogs do |edge|
+      edge.get 'BusinessSettingLogsData'
+    end
+
     has_edge :campaigns do |edge|
       edge.delete do |api|
         api.has_param :before_date, 'datetime'
@@ -823,7 +854,6 @@ module FacebookAds
         api.has_param :rule_aggregation, 'string'
         api.has_param :seed_audience, 'int'
         api.has_param :source, 'string'
-        api.has_param :study_spec, 'hash'
         api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
         api.has_param :tags, { list: 'string' }
         api.has_param :video_group_ids, { list: 'string' }
@@ -970,16 +1000,54 @@ module FacebookAds
       end
     end
 
+    has_edge :mockups do |edge|
+      edge.post do |api|
+        api.has_param :mockup_access_token, 'string'
+        api.has_param :page_id, 'string'
+        api.has_param :source_mockup_id, 'string'
+      end
+    end
+
     has_edge :offline_conversion_data_sets do |edge|
       edge.get 'OfflineConversionDataSet'
     end
 
+    has_edge :offsitepixels do |edge|
+      edge.get 'OffsitePixel'
+    end
+
     has_edge :onbehalf_requests do |edge|
       edge.get 'BusinessOwnedObjectOnBehalfOfRequest' do |api|
         api.has_param :status, { enum: -> { BusinessOwnedObjectOnBehalfOfRequest::STATUS }}
       end
     end
 
+    has_edge :partner_integrations do |edge|
+      edge.get 'PartnerIntegrationLinked'
+      edge.post 'PartnerIntegrationLinked' do |api|
+        api.has_param :external_id, 'string'
+        api.has_param :gtm_account_id, 'string'
+        api.has_param :gtm_container_id, 'string'
+        api.has_param :name, 'string'
+        api.has_param :page_id, 'string'
+        api.has_param :partner, { enum: -> { PartnerIntegrationLinked::PARTNER }}
+      end
+    end
+
+    has_edge :partnercategories do |edge|
+      edge.get 'PartnerCategory' do |api|
+        api.has_param :hide_pc, 'bool'
+        api.has_param :is_exclusion, 'bool'
+        api.has_param :limit, 'int'
+        api.has_param :private_or_public, { enum: -> { PartnerCategory::PRIVATE_OR_PUBLIC }}
+        api.has_param :targeting_type, 'string'
+      end
+    end
+
+    has_edge :partners do |edge|
+      edge.get 'AdsDataPartner'
+    end
+
     has_edge :product_audiences do |edge|
       edge.post 'CustomAudience' do |api|
         api.has_param :allowed_domains, { list: 'string' }
@@ -1075,6 +1143,22 @@ module FacebookAds
       end
     end
 
+    has_edge :referral do |edge|
+      edge.get 'Referral'
+      edge.post 'Referral' do |api|
+        api.has_param :invite_limit, 'int'
+        api.has_param :messenger_cta, 'string'
+        api.has_param :messenger_promotion_text, 'string'
+        api.has_param :namespace, 'int'
+        api.has_param :need_promo_code, 'bool'
+        api.has_param :offer_origin, 'string'
+        api.has_param :promotion_text, 'string'
+        api.has_param :receiver_benefits_text, 'string'
+        api.has_param :referral_link_uri, 'string'
+        api.has_param :sender_benefits_text, 'string'
+      end
+    end
+
     has_edge :roas do |edge|
       edge.get 'AdAccountRoas' do |api|
         api.has_param :fields, { list: 'string' }
@@ -1168,6 +1252,12 @@ module FacebookAds
       end
     end
 
+    has_edge :timezoneoffsets do |edge|
+      edge.get 'TimezoneOffset' do |api|
+        api.has_param :start_year, 'int'
+      end
+    end
+
     has_edge :tracking do |edge|
       edge.delete do |api|
         api.has_param :tracking_specs, 'object'

data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb

@@ -29,10 +29,7 @@ module FacebookAds
 
     field :actor_id, 'string'
     field :ads_running_or_in_review_count, 'int'
-    field :has_hit_total_live_ads_limit, 'bool'
-    field :live_ads_quota_left, 'int'
-    field :total_live_ads_in_current_account, 'int'
-    field :total_live_ads_limit, 'int'
+    field :current_account_ads_running_or_in_review_count, 'int'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb

@@ -26,6 +26,152 @@ module FacebookAds
   # pull request for this class.
 
   class AdAccountCreationRequest < AdObject
+    SUBVERTICAL = [
+      "ACCOUNTING_AND_TAXES_AND_LEGAL",
+      "AGRICULTURE_AND_FARMING",
+      "AIR",
+      "AIR_FREIGHT_OR_PACKAGE",
+      "APPAREL_AND_ACCESSORIES",
+      "ARTS",
+      "AUCTIONS",
+      "AUTOMOTIVE_MANUFACTURER",
+      "AUTO_AGENCY",
+      "AUTO_RENTAL",
+      "B2B",
+      "B2B_MANUFACTURING",
+      "BEAUTY_AND_PERSONAL_CARE",
+      "BEER_AND_WINE_AND_LIQUOR",
+      "BOOKSTORES",
+      "BUSINESS_SUPPORT_SERVICES",
+      "BUS_AND_TAXI_AND_AUTO_RETAL",
+      "CABLE_AND_SATELLITE",
+      "CAREER",
+      "COMPUTING_AND_PERIPHERALS",
+      "CONSOLE_DEVELOPER",
+      "CONSOLE_DEVICE",
+      "CONSTRUCTION_AND_MINING",
+      "CONSULTING",
+      "CONSUMER_ELECTRONICS",
+      "CONSUMER_TECH",
+      "CREDIT_AND_FINANCING_AND_MORTAGES",
+      "CRUISES_AND_MARINE",
+      "CVB_CONVENTION_AND_VISITORS_BUREAU",
+      "DAILYDEALS",
+      "DATING",
+      "DEALERSHIP",
+      "DEPARTMENT_STORE",
+      "DESKTOP_SOFTWARE",
+      "DIGITAL_ADVERTISING_AND_MARKETING_OR_UNTAGGED_AGENCIES",
+      "ECATALOG",
+      "ECOMMERCE_AGRICULTURE_AND_FARMING",
+      "EDUCATION_RESOURCES",
+      "ED_TECH",
+      "ELEARNING_AND_MASSIVE_ONLINE_OPEN_COURSES",
+      "ENGINEERING_AND_DESIGN",
+      "EVENTS",
+      "FAMILY_AND_HEALTH",
+      "FITNESS",
+      "FOOD",
+      "FOOTWEAR",
+      "FOR_PROFIT_COLLEGES_AND_UNIVERSITIES",
+      "GAMBLING",
+      "GOVERNMENT",
+      "GROCERY_AND_DRUG_AND_CONVENIENCE",
+      "HIGHWAYS",
+      "HOME_AND_OFFICE",
+      "HOME_IMPROVEMENT",
+      "HOME_SERVICE",
+      "HOTEL_AND_ACCOMODATION",
+      "HOUSEHOLD_GOODS",
+      "INDUSTRIAL_AND_FARM_VEHICLE",
+      "INSURANCE",
+      "INVESTMENT_BANK_AND_BROKERAGE",
+      "MEDIA",
+      "MOBILE_AND_SOCIAL",
+      "MOBILE_APPS",
+      "MOTORCYCLES",
+      "MOVIES",
+      "MUSEUMS_AND_PARKS_AND_LIBRARIES",
+      "MUSIC_AND_RADIO",
+      "NON_PROFIT",
+      "NOT_FOR_PROFIT_COLLEGES_AND_UNIVERSITIES",
+      "OFFICE",
+      "OIL_AND_GAS_AND_CONSUMABLE_FUEL",
+      "ONLINE_OR_SOFTWARE",
+      "OTHER_WIRELINE_SERVICES",
+      "PARTS_AND_SERVICE",
+      "PET",
+      "PET_RETAIL",
+      "PHARMACEUTICAL_OR_HEALTH",
+      "PHOTOGRAPHY_AND_FILMING_SERVICES",
+      "POLITICAL",
+      "PR",
+      "PUBLISHING_INTERNET",
+      "RAILROADS",
+      "REAL_ESTATE",
+      "REAL_MONEY_OR_SKILLED_GAMING",
+      "RECREATIONAL",
+      "RELIGIOUS",
+      "RESTAURANT",
+      "RETAIL_AND_CREDIT_UNION_AND_COMMERCIAL_BANK",
+      "SCHOOL_AND_EARLY_CHILDREN_EDCATION",
+      "SEASONAL_POLITICAL_SPENDERS",
+      "SMB_AGENTS_AND_PROMOTERS",
+      "SMB_ARTISTS_AND_PERFORMERS",
+      "SMB_CANVAS",
+      "SMB_CATALOG",
+      "SMB_CONSUMER_MOBILE_DEVICE",
+      "SMB_CROSS_PLATFORM",
+      "SMB_ELECTRONICS_AND_APPLIANCES",
+      "SMB_ENERGY",
+      "SMB_GAME_AND_TOY",
+      "SMB_INFORMATION",
+      "SMB_NAVIGATION_AND_MEASUREMENT",
+      "SMB_OPERATIONS_AND_OTHER",
+      "SMB_OTHER",
+      "SMB_PERSONAL_CARE",
+      "SMB_RELIGIOUS",
+      "SMB_RENTALS",
+      "SMB_REPAIR_AND_MAINTENANCE",
+      "SOFTWARE",
+      "SPORTING",
+      "SPORTS",
+      "STREAMING",
+      "TELEVISION",
+      "TOBACCO",
+      "TOY_AND_HOBBY",
+      "TRADE_SCHOOL",
+      "TRANSPORTATION_EQUIPMENT",
+      "TRAVAL_AGENCY",
+      "TRUCK_AND_MOVING",
+      "UTILITIES_AND_ENERGY_EQUIPMENT_AND_SERVICES",
+      "WATER_AND_SOFT_DRINK_AND_BAVERAGE",
+      "WIRELESS_SERVICES",
+    ]
+
+    VERTICAL = [
+      "ADVERTISING_AND_MARKETING",
+      "AUTOMOTIVE",
+      "AUTO_AGENCY",
+      "CONSUMER_PACKAGED_GOODS",
+      "CPG_AND_BEVERAGE",
+      "ECOMMERCE",
+      "EDUCATION",
+      "ENERGY_AND_UTILITIES",
+      "ENTERTAINMENT_AND_MEDIA",
+      "FINANCIAL_SERVICES",
+      "GAMING",
+      "GOVERMENT_AND_POLITICS",
+      "MOTORCYCLES",
+      "ORGANIZATIONS_AND_ASSOCIATIONS",
+      "OTHER",
+      "PROFESSIONAL_SERVICES",
+      "RETAIL",
+      "TECHNOLOGY",
+      "TELECOM",
+      "TRAVEL",
+    ]
+
 
     field :ad_accounts_currency, 'string'
     field :ad_accounts_info, { list: 'object' }
@@ -61,6 +207,9 @@ module FacebookAds
     field :subvertical, 'string'
     field :time_created, 'datetime'
     field :vertical, 'string'
+    field :advertiser_business_id, 'string'
+    field :business_registration, 'file'
+    field :promotable_page_urls, { list: 'string' }
     has_no_post
     has_no_delete
 
@@ -68,5 +217,28 @@ module FacebookAds
       edge.get 'AdAccount'
     end
 
+    has_edge :vietnam do |edge|
+      edge.post 'AdAccountCreationRequest' do |api|
+        api.has_param :ad_accounts_info, { list: 'object' }
+        api.has_param :additional_comment, 'string'
+        api.has_param :address_in_english, 'object'
+        api.has_param :address_in_local_language, 'string'
+        api.has_param :advertiser_business_id, 'string'
+        api.has_param :business_registration, 'file'
+        api.has_param :business_registration_id, 'string'
+        api.has_param :contact, 'object'
+        api.has_param :english_legal_entity_name, 'string'
+        api.has_param :legal_entity_name_in_local_language, 'string'
+        api.has_param :official_website_url, 'string'
+        api.has_param :planning_agency_business_id, 'string'
+        api.has_param :promotable_app_ids, { list: 'string' }
+        api.has_param :promotable_page_ids, { list: 'int' }
+        api.has_param :promotable_page_urls, { list: 'string' }
+        api.has_param :promotable_urls, { list: 'string' }
+        api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
+        api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -74,6 +74,7 @@ module FacebookAds
       "brand_safety_content_severity_levels",
       "catalog_based_targeting",
       "cities",
+      "city_keys",
       "college_years",
       "conjunctive_user_adclusters",
       "connections",
@@ -158,6 +159,7 @@ module FacebookAds
       "prospecting_audience",
       "publisher_platforms",
       "radius",
+      "region_keys",
       "regions",
       "relationship_statuses",
       "rtb_flag",

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -198,6 +198,8 @@ module FacebookAds
     field :call_to_action, 'object'
     field :image_file, 'string'
     field :is_dco_internal, 'bool'
+    field :mockup_id, 'string'
+    field :page_id, 'string'
 
     has_edge :adlabels do |edge|
       edge.delete do |api|

data/lib/facebook_ads/ad_objects/ad_saved_location.rb

@@ -0,0 +1,42 @@
+# 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 AdSavedLocation < AdObject
+
+    field :cities, { list: 'TargetingGeoLocationCity' }
+    field :countries, { list: 'string' }
+    field :country_groups, { list: 'string' }
+    field :custom_locations, { list: 'TargetingGeoLocationCustomLocation' }
+    field :geo_markets, { list: 'TargetingGeoLocationMarket' }
+    field :id, 'string'
+    field :location_sentences, { list: 'string' }
+    field :name, 'string'
+    field :regions, { list: 'TargetingGeoLocationRegion' }
+    field :zips, { list: 'TargetingGeoLocationZip' }
+
+  end
+end