facebookads 0.2.10.0 → 0.2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc110a24bb4669a6d4197887009fc6d9146943e
-  data.tar.gz: dad0fbba3c02b1735bd9cbb10fc4943041036793
+  metadata.gz: 0f5863fdb541ae250c21d0ab010b95253d656d79
+  data.tar.gz: 9b6914ef28784356a7945676e4c541c1faf6423d
 SHA512:
-  metadata.gz: 6be86bcfb67af98952a1a66565abfac62373172f453c021736b7e6a80161e47545b1e1a4cc4529817fa7c83b763263b342d6db9bcd0785faac57550a831e4708
-  data.tar.gz: e1b5b5e601eb7ddc2374d9131223304ed3a864cb73bb4a55666ba9b3eb977b8af69f33ade5502edb00f488abd2f30cc2dcea7563e14a9c77637041bdee9e25a1
+  metadata.gz: 0373a0e8a6740ee63dd8e0bcc476ddf9e47769d47d415af74fcbf64c2b606d4d94698303727e5a24ece7d9887db43761bfd3bfbaa065f846973f04a600f9c9a1
+  data.tar.gz: 9aeeef48a88bd7d1bb7b75a9e3834edbe90cf1d9049756f79daec3c4e87ca446b9ef5723333e64b93281ac70173fa595f3f9c50a366b1f1aee03e301524211a3

data/lib/facebook_ads.rb

@@ -58,7 +58,7 @@ module FacebookAds
   require 'facebook_ads/batch_api/batch'
   require 'facebook_ads/batch_api/batch_proxy'
 
-  # Autoload AdObjects Helpers
+  # Autoload Ab Objects Helpers
   Dir.glob(File.expand_path(File.join(__FILE__, '..', 'facebook_ads', 'ad_objects', 'helpers', '*.rb'))).each do |file|
     class_name = File.basename(file, '.rb').split('_').map(&:capitalize).join.to_sym
     autoload class_name, file

data/lib/facebook_ads/ad_object.rb

@@ -24,7 +24,7 @@ require 'facebook_ads/helpers/edge_helpers'
 
 module FacebookAds
   class AdObject
-    attr_reader :attributes, :fields, :last_api_response
+    attr_reader :attributes, :internal_fields, :last_api_response
     attr_accessor :deserializer
     attr_accessor :last_saved, :last_destroyed
 
@@ -45,7 +45,7 @@ module FacebookAds
       fields = fields.split(',') if fields.is_a?(String)
       session = args.shift
 
-      self.fields = fields + attributes.keys
+      self.internal_fields = fields + attributes.keys
       self.session = session
     end
 
@@ -90,15 +90,17 @@ module FacebookAds
     end
 
     def fields_as_string
-      @fields.to_a.join(',')
+      @internal_fields.to_a.join(',')
     end
 
-    def fields=(fields)
-      @fields = Set.new((fields.is_a?(String) ? fields.split(',') : fields.map(&:to_s)).map(&:to_sym))
+    # please do not use fields= or @fields as instance variable or setter.
+    # 'fields' is resevered keyword for field name in AdReportRun
+    def internal_fields=(fields)
+      @internal_fields = Set.new((fields.is_a?(String) ? fields.split(',') : fields.map(&:to_s)).map(&:to_sym))
     end
 
     def loaded?
-      (@fields - attributes.keys).empty?
+      (@internal_fields - attributes.keys).empty?
     end
 
     def load!

data/lib/facebook_ads/ad_objects/ad.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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
@@ -200,6 +200,7 @@ module FacebookAds
     has_edge :previews do |edge|
       edge.get 'AdPreview' do |api|
         api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
+        api.has_param :dynamic_creative_spec, 'object'
         api.has_param :end_date, 'datetime'
         api.has_param :height, 'int'
         api.has_param :locale, 'string'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -19,27 +19,13 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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 AdAccount < AdObject
-    ACCESS_TYPE = [
-      "OWNER",
-      "AGENCY",
-    ]
-
-    PERMITTED_ROLES = [
-      "ADMIN",
-      "GENERAL_USER",
-      "REPORTS_ONLY",
-      "INSTAGRAM_ADVERTISER",
-      "INSTAGRAM_MANAGER",
-      "FB_EMPLOYEE_DSO_ADVERTISER",
-    ]
-
 
     field :account_id, 'string'
     field :account_status, 'int'
@@ -70,6 +56,7 @@ module FacebookAds
     field :id, 'string'
     field :io_number, 'string'
     field :is_attribution_spec_system_default, 'bool'
+    field :is_direct_deals_enabled, 'bool'
     field :is_notifications_enabled, 'bool'
     field :is_personal, 'int'
     field :is_prepay_account, 'bool'
@@ -79,6 +66,7 @@ module FacebookAds
     field :min_campaign_group_spend_cap, 'string'
     field :min_daily_budget, 'int'
     field :name, 'string'
+    field :next_bill_date, 'datetime'
     field :offsite_pixels_tos_accepted, 'bool'
     field :owner, 'string'
     field :partner, 'string'
@@ -118,6 +106,10 @@ module FacebookAds
       end
     end
 
+    has_edge :adasset_feeds do |edge|
+      edge.get
+    end
+
     has_edge :adcreatives do |edge|
       edge.get 'AdCreative'
       edge.post 'AdCreative' do |api|
@@ -125,6 +117,7 @@ module FacebookAds
         api.has_param :adlabels, { list: 'object' }
         api.has_param :applink_treatment, { enum: -> { AdCreative::APPLINK_TREATMENT }}
         api.has_param :body, 'string'
+        api.has_param :branded_content_sponsor_page_id, 'string'
         api.has_param :call_to_action, 'object'
         api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
         api.has_param :image_crops, 'hash'
@@ -144,6 +137,7 @@ module FacebookAds
         api.has_param :object_url, 'string'
         api.has_param :platform_customizations, 'object'
         api.has_param :product_set_id, 'string'
+        api.has_param :recommender_settings, 'hash'
         api.has_param :template_url, 'string'
         api.has_param :template_url_spec, 'object'
         api.has_param :thumbnail_url, 'string'
@@ -195,6 +189,23 @@ module FacebookAds
       edge.get
     end
 
+    has_edge :adrules_history do |edge|
+      edge.get 'AdAccountAdRulesHistory' do |api|
+        api.has_param :hide_no_changes, 'bool'
+      end
+    end
+
+    has_edge :adrules_library do |edge|
+      edge.post 'AdRule' do |api|
+        api.has_param :account_id, 'string'
+        api.has_param :evaluation_spec, 'object'
+        api.has_param :execution_spec, 'object'
+        api.has_param :name, 'string'
+        api.has_param :schedule_spec, 'object'
+        api.has_param :status, { enum: -> { AdRule::STATUS }}
+      end
+    end
+
     has_edge :ads do |edge|
       edge.get 'Ad' do |api|
         api.has_param :ad_draft_id, 'string'
@@ -248,6 +259,7 @@ module FacebookAds
         api.has_param :creative_sequence, { list: 'string' }
         api.has_param :daily_budget, 'int'
         api.has_param :daily_imps, 'int'
+        api.has_param :destination_type, { enum: -> { AdSet::DESTINATION_TYPE }}
         api.has_param :end_time, 'datetime'
         api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
         api.has_param :frequency_control_specs, { list: 'object' }
@@ -306,7 +318,7 @@ module FacebookAds
         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: %w{equirectangular cubemap }}
+        api.has_param :original_projection_type, { enum: %w{equirectangular cubemap equiangular_cubemap }}
         api.has_param :referenced_sticker_id, 'string'
         api.has_param :slideshow_spec, 'hash'
         api.has_param :start_offset, 'int'
@@ -382,6 +394,7 @@ module FacebookAds
         api.has_param :pixel_id, 'string'
       end
       edge.post 'CustomAudience' do |api|
+        api.has_param :allowed_domains, { list: 'string' }
         api.has_param :claim_objective, { enum: -> { CustomAudience::CLAIM_OBJECTIVE }}
         api.has_param :content_type, { enum: -> { CustomAudience::CONTENT_TYPE }}
         api.has_param :dataset_id, 'string'
@@ -430,6 +443,7 @@ module FacebookAds
       edge.get 'AdPreview' do |api|
         api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
         api.has_param :creative, 'AdCreative'
+        api.has_param :dynamic_creative_spec, 'object'
         api.has_param :end_date, 'datetime'
         api.has_param :height, 'int'
         api.has_param :locale, 'string'
@@ -505,7 +519,7 @@ module FacebookAds
     end
 
     has_edge :offline_conversion_data_sets do |edge|
-      edge.get
+      edge.get 'OfflineConversionDataSet'
     end
 
     has_edge :offsitepixels do |edge|

data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb

@@ -0,0 +1,45 @@
+# 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 AdAccountAdRulesHistory < AdObject
+
+    field :evaluation_spec, 'AdRuleEvaluationSpec'
+    field :exception_code, 'int'
+    field :exception_message, 'string'
+    field :execution_spec, 'AdRuleExecutionSpec'
+    field :is_manual, 'bool'
+    field :results, { list: 'AdRuleHistoryResult' }
+    field :rule_id, 'int'
+    field :schedule_spec, 'AdRuleScheduleSpec'
+    field :timestamp, 'datetime'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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
@@ -30,6 +30,7 @@ module FacebookAds
       "NONE",
       "APP_INSTALLS",
       "BRAND_AWARENESS",
+      "AD_RECALL_LIFT",
       "CLICKS",
       "ENGAGED_USERS",
       "EVENT_RESPONSES",

data/lib/facebook_ads/ad_objects/ad_account_roas.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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
@@ -123,6 +123,11 @@ module FacebookAds
       "format",
       "trending",
       "gatekeepers",
+      "follow_profiles",
+      "follow_profiles_negative",
+      "location_categories",
+      "user_page_threads",
+      "user_page_threads_excluded",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_account_user.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -19,7 +19,7 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  # This class is auto-genereated.
+  # 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
@@ -50,6 +50,7 @@ module FacebookAds
       "update_campaign_name",
       "update_campaign_run_status",
       "update_campaign_group_spend_cap",
+      "campaign_ended",
       "create_campaign",
       "create_campaign_legacy",
       "update_campaign_budget",

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -0,0 +1,90 @@
+# 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 AdAssetFeedSpec < AdObject
+    CALL_TO_ACTION_TYPES = [
+      "OPEN_LINK",
+      "LIKE_PAGE",
+      "SHOP_NOW",
+      "PLAY_GAME",
+      "INSTALL_APP",
+      "USE_APP",
+      "INSTALL_MOBILE_APP",
+      "USE_MOBILE_APP",
+      "BOOK_TRAVEL",
+      "LISTEN_MUSIC",
+      "LEARN_MORE",
+      "SIGN_UP",
+      "DOWNLOAD",
+      "WATCH_MORE",
+      "NO_BUTTON",
+      "CALL_NOW",
+      "APPLY_NOW",
+      "BUY_NOW",
+      "GET_OFFER",
+      "GET_OFFER_VIEW",
+      "GET_DIRECTIONS",
+      "MESSAGE_PAGE",
+      "MESSAGE_USER",
+      "SUBSCRIBE",
+      "SELL_NOW",
+      "DONATE_NOW",
+      "GET_QUOTE",
+      "CONTACT_US",
+      "START_ORDER",
+      "RECORD_NOW",
+      "VOTE_NOW",
+      "REGISTER_NOW",
+      "REQUEST_TIME",
+      "SEE_MENU",
+      "EMAIL_NOW",
+      "GET_SHOWTIMES",
+      "TRY_IT",
+      "LISTEN_NOW",
+      "OPEN_MOVIES",
+    ]
+
+
+    field :ad_formats, { list: 'string' }
+    field :bodies, { list: 'AdAssetFeedSpecBody' }
+    field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
+    field :captions, { list: 'AdAssetFeedSpecCaption' }
+    field :descriptions, { list: 'AdAssetFeedSpecDescription' }
+    field :groups, { list: 'AdAssetFeedSpecGroupRule' }
+    field :images, { list: 'AdAssetFeedSpecImage' }
+    field :link_urls, { list: 'AdAssetFeedSpecLinkURL' }
+    field :optimization_type, 'string'
+    field :target_rules, { list: 'AdAssetFeedSpecTargetRule' }
+    field :titles, { list: 'AdAssetFeedSpecTitle' }
+    field :videos, { list: 'AdAssetFeedSpecVideo' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_label.rb

@@ -0,0 +1,37 @@
+# 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 AdAssetFeedSpecAssetLabel < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end